CLI Reference¶

mccode-antlr installs eight command-line programs.

Instrument translation¶

Translate a McCode .instr file to C source code.

mcstas-antlr [OPTIONS] INSTR_FILE

mcxtrace-antlr [OPTIONS] INSTR_FILE

Run commands¶

Compile and run an instrument simulation.

mcrun-antlr [OPTIONS] INSTR_FILE [PARAM=VALUE(S) ...]

mxrun-antlr [OPTIONS] INSTR_FILE [PARAM=VALUE(S) ...]

Parameter syntax¶

Each instrument parameter is given as PARAM=VALUE(S) after the filename. The value determines whether this parameter is held constant or scanned:

1-D scan (default): all ranged parameters must have the same number of points and are stepped together in lock-step. Scalar parameters keep their fixed value at every step.

mcrun-antlr my.instr -n 1e6 a=1.0 b=10:20 c=100:10:200
#                              ^fixed  ^11pts   ^11pts — stepped together

N-D mesh scan (-m / --mesh): all ranged parameters are combined as a full Cartesian product. A scan with lengths [P, Q, R] runs P × Q × R simulations.

mcrun-antlr my.instr -n 1e6 -m E_i=1:2:5 angle=0:5:90
#                                 ^3pts      ^19pts → 57 simulations total

Compile-only commands¶

Compile a McCode instrument to a binary without running it.

mcc-antlr [OPTIONS] FILENAME

mxc-antlr [OPTIONS] FILENAME

Accepts .instr, .json, or pre-generated .c files.

Format command¶

mcfmt¶

Format .instr and .comp McCode DSL source files in canonical style.

mcfmt [OPTIONS] FILE [FILE ...]

The output mode flags (-i, --check, --diff) are mutually exclusive; the default (none given) prints formatted output to stdout.

Management command¶

mccode-antlr¶

Top-level management utility for caches, configuration, and data files.

mccode-antlr SUBCOMMAND [OPTIONS]

mccode-antlr cache¶

cache populate options:

cache register options:

cache ir-build options:

mccode-antlr config¶

mccode-antlr datafile¶

Run mccode-antlr SUBCOMMAND ACTION -h for the full option list of any individual action.

mccode-antlr convert¶

Convert between serialized instrument formats and generated Python assembler scripts.

mccode-antlr convert INPUT [-o OUTPUT] [--to {python,json,instr}] [--flavor {mcstas,mcxtrace}] [-I DIR ...]

mccode-antlr extract¶

Reconstitute a portable instrument into a directory: the .instr file (and any %include-d instruments, per the include hierarchy), every stashed/embedded local file, and the component (.comp) definitions it needs. Everything is written flat into one directory — no subfolders — so the result can be translated or compiled from inside that directory with no -I/--search-dir needed.

By default, only component definitions and dependency files not otherwise available from a remote registry are written (a component shipped with mcstas/mcxtrace, for example, is skipped since it's already fetchable by name elsewhere). Pass --include-remote for a fully self-contained bundle that also reconstructs those.

unzip-like selection is also available: pass one or more MEMBER glob patterns to extract only matching files (naming a remote-sourced file this way extracts it even without --include-remote, since asking for it by name is unambiguous), -x/--exclude to omit matches from whatever set would otherwise be written, and -l/--list to preview — without writing anything — exactly what a given invocation (same MEMBER/-x/--include-remote) would produce.

mccode-antlr extract INPUT [MEMBER ...] [-o OUTPUT_DIR] [--flavor {mcstas,mcxtrace}] [-I DIR ...] [--include-remote] [-x PATTERN ...] [-l]

Examples:

# See what a plain extract would produce, without writing anything
mccode-antlr extract my.instr --list

# Pull just one component definition out of a bundle
mccode-antlr extract my.instr Progress_bar.comp -o ./just-progress-bar

# Fully self-contained bundle, but skip the C source files
mccode-antlr extract my.instr --include-remote -x '*.c'