From 4a380dc426a280f85d6c9526334373bf73264d4b Mon Sep 17 00:00:00 2001 From: Chris Brasnett Date: Fri, 8 May 2026 11:17:02 +0100 Subject: [PATCH] update README.md --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9c83eb9..b2d06d9 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,15 @@ You can also install the in-development version with:: ## Usage -To run the optimizer from the command line using the test settings and test data, you can run the following command `mcsas3-runner`. This stores the optimization result in a file named test.nxs. This can subsequently be histogrammed and plotted using the following commmand: +To run the optimizer from the command line using the test settings and test data, you can run the following command with the `mcsas3-runner` program from the root of this repository: + + mcsas3-runner \ + -f testdata/quickstartdemo1.csv \ + -F example_configurations/read_config_csv.yaml \ + -R example_configurations/run_config_spheres_auto.yaml \ + -r test.nxs + +This stores the optimization result in a file named `test.nxs`. This can subsequently be histogrammed and plotted using the following commmand: mcsas3-histogrammer -r test.nxs