Skip to content

mcrun variants table overview

Peter Willendrup edited this page Jan 18, 2018 · 7 revisions

Default "mcrun" executor indicated in bold below

Variant Type cmdline switches Environment vars
mcrun Python 3
-c, --force-compile
force rebuilding of instrument
-p FILE, --param=FILE
read instr parameters from file FILE
-N NP, --numpoints=NP
set number of scan points
-L, --list
use a fixed list of points for linear scanning
-M, --multi
run a multi-dimensional scan
--autoplot
open plotter on generated dataset
--embed
store copy of instrument file in output directory (enabled by default)
--mpi=NB_CPU
spread simulation over NB_CPU>0 machines using MPI (use auto as value to let mpirun decide for itself)
--machines=machines
defines path of MPI machinefile to use in parallel mode
--optimise-file=FILE
store scan results in FILE (defaults to: "mccode.dat")
--no-cflags
disable optimising compiler flags for faster compilation
--verbose
enable verbose output
--write-user-config
 generate a user config file
MCSTAS_OVERRIDE
- specify McStas lib location
MCSTAS_CC_OVERRIDE
- specify the C compiler
MCSTAS_CFLAGS_OVERRIDE
- specify the CFLAGS to use during compilation
MCSTAS_MPICC_OVERRIDE
- specify the mpi-enabled C compiler to use in --mpi mode .
mcrun.pl/mcrun-pl Perl 5
-c, --force-compile
force rebuilding of instrument
-p FILE, --param=FILE
read instr parameters from file FILE
-N NP, --numpoints=NP
set number of scan points
--optim=COMP
Add COMP to the list of monitors to maximize (optimization criteria, requires Math::Amoeba)
--optim-prec=PREC
Relative requested accuracy of criteria (1e-3)
--optim-file=FILE
Defines filename for storing optim results. (Defaults to "mcoptim_XXXX.dat")
--mpi(=NB_CPU)
spread simulation over NB_CPU machines using MPI (use auto as value to let mpirun decide for itself)
--machines=machines
defines path of MPI machinefile to use in parallel mode
--optimise-file=FILE
store scan results in FILE (defaults to: "mccode.dat")
--no-cflags
Does not use CFLAGS for faster compilation
--test(=INSTR)
Execute McStas selftest and generate report (for all/one/several instruments)
MCSTAS
- specify McStas lib location
MCSTAS_CC
- specify the C compiler
MCSTAS_CFLAGS
- specify the CFLAGS to use during compilation
MCSTAS_FORMAT
- specify the output format to use (McStas/NeXus).
var_OVERRIDE
versions of the above are also honoured.
Executors below this not yet in release

Instrument options - generic to all instruments, added to an mcrun cmdline:

  Instr options:
   -s SEED   --seed=SEED      Set random seed (must be != 0)
   -n COUNT  --ncount=COUNT   Set number of neutrons to simulate.
   -d DIR    --dir=DIR        Put all data files in directory DIR.
   -f FILE   --file=FILE      Put all data in a single file.
   -t        --trace          Enable trace of neutron through instrument.
   -g        --gravitation    Enable gravitation for all trajectories.
   -a        --data-only      Do not put any headers in the data files.
   --no-output-files          Do not write any data files.
   -h        --help           Show help message.
   -i        --info           Detailed instrument information.
   --format=FORMAT            Output data files using format FORMAT.
                              (format list obtained from .out -h)
You can’t perform that action at this time.