Man page - mcdisplay(1)

Packages contains this manual

Manual

mcDISPLAY

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
FILES
EXAMPLES
AUTHORS
SEE ALSO
AUTHORS

NAME

mcdisplay - mcstas Graphical display of simulations

SYNOPSIS

mcdisplay [-h] [–default] [–dirname DIRNAME] [–inspect INSPECT] [–invcanvas] [-n N] INSTR [options ...]

DESCRIPTION

The mcdisplay front-end is a graphical debugging tool. It presents a schematic drawing of the instrument definition, showing the position of the components and the paths of the simulated neutrons through the instrument. It is thus very useful for debugging a simulation, for example to spot components in the wrong position or to find out where neutrons are getting lost. To use the mcdisplay front-end with a simulation, run it as follows: mcdisplay INSTR args... where INSTR is the name of either the instrument source INSTR.instr or the simulation program INSTR.out generated with mcstas, and args are the normal command line arguments for the simulation, as for mcrun . The -h option will list valid options.

The default plotting backend is mcdisplay-pyqtgraph, but there exists a number of additional plotters such as mcdisplay-matplotlib, mcdisplay-webgl-classic (using WebGL), mcdisplay-webgl (using WebGL and NodeJS), mcdisplay-matlab (using Matlab or Octave). This is the PyQtGraph plotting tool.

OPTIONS

-h, –help

show this help message and exit

–default

automatically use instrument defaults for simulation run

–dirname DIRNAME

output directory name override

–inspect INSPECT

display only particle rays reaching this component

–invcanvas

invert canvas background from black to white

-n N, –ncount N

Number of particles to simulate

FILES

/usr/share/mcstas/tools/Python /usr/share/mcstas/tools/Python/mccodelib/mccode_config.json ~/.mcstas/mccode_config.json http://www.mcstas.org

EXAMPLES

Display the Test_SX example (Single crystal diffraction)

•

mcdisplay Test_SX.instr -d output_dir -n 1e2 TTH=13.4

AUTHORS

mcstas Team (mcstas.org)

SEE ALSO

mcstas(1), mcdoc(1), mcplot(1), mcrun(1), mcgui(1), mcdisplay(1)

AUTHORS

MCSTAS neutron Ray Tracing Team.