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
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
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)
Executors below this not yet in release
Clone this wiki locally