Command line reference

Validate ESS instrument simulation projects, and run their instruments through McStas’ mctest in CI.

usage: mcstas-ess-instr-citool [-h] [--version]
                               [-a {generate,generatepy,modelcheck,runci,runcifast,checkbuild,list,check,json,pprint,repos,repos-json}]
                               [--outdir DIR] [--mpi N] [--lenient]
                               [--errtrace]
                               [project_dir]

Positional Arguments

project_dir

Path to a directory containing a “project” (not needed for the actions [‘repos’, ‘repos-json’]).

Named Arguments

--version

Show the version of the tool and exit.

-a, --action

Possible choices: generate, generatepy, modelcheck, runci, runcifast, checkbuild, list, check, json, pprint, repos, repos-json

Action: [‘generate’, ‘generatepy’, ‘modelcheck’, ‘runci’, ‘runcifast’, ‘checkbuild’, ‘list’, ‘check’, ‘json’, ‘pprint’, ‘repos’, ‘repos-json’] (default: “list”). The actions “repos” and “repos-json” list the instrument repositories at DMSC (as a table, or as JSON).

Default: 'list'

--outdir, -o

Select output directory (when relevant). Must be empty or non-existing). Default is to use a temporarily and autocleaned directory.

--mpi

Compile and run the instruments with MPI, using N processes (or “auto” for the number of available processors). Only for the actions runci, runcifast and checkbuild. Default is to not use MPI.

--lenient

Ignore (with a warning) unexpected files and directories in the project, e.g. temporary files in a working copy, instead of failing. Only for testing locally: not allowed in CI (when the CI environment variable is set).

Default: False

--errtrace

Show the full Python traceback for all errors. By default, errors caused by the project or the environment (e.g. a failed check) are shown as a message only.

Default: False