Command line interface

mcvine

The main command line interface (CLI) of the MCViNE package is the command “mcvine”. Execute:

$ mcvine

will list available subcommands.

Execute:

$ mcvine version

prints out the version of mcvine being used.

bash

If you are using bash, you can use the following command to add bash auto-complete support:

$ eval "$(_MCVINE_COMPLETE=source mcvine)"

You can also establish aliases to some long commands. For example:

$ eval `mcvine bash aliases arcs`

will create aliases for commands related to the ARCS spectrometer, which include a series of aliases starting with prefix “arcs”. For example, “arcs_beam” is an alias of “mcvine instruments arcs beam”.

instruments

Subcommands for neutron instruments. For example:

$ mcvine instruments arcs

provide commands for the ARCS spectrometer at SNS

Simulation Cache

Simulation results could be cached.

For example:

$ mcvine instruments arcs beam --E=100 --ncount=1e8 --keep-in-cache

will save the simulation results to a cache.

To reuse the cached results, add option “–use-cache”:

$ mcvine instruments arcs beam --E=100 --ncount=1e8 --use-cache

Components

Command

$ mcvine component

Subcommands related to simulation components.

Neutron storage

Command

$ mcvine neutronstorage

Subcmds manipulate neutron storage files.

phonon

Command:

$ mcvine phonon

Phonon-related functionalities.

Given phonon data in IDF format, it can

• extract band structure

• compute neutron scattering data slice

sample assembly

Command:

$ mcvine sampleassembly

sampleassembly related functionalities.

To syntax check a sample assembly use:

$ mcvine sampleassembly check /path/to/sampleassembly.xml

mcstas support

Command:

$ mcvine mcstas compilecomponent --filename=<path-to-component> --category=<component-category>

Compile a mcstas component.