% @MCCODE_PREFIX@DISPLAY(1)
% @FLAVOR_UPPER@ @MCCODE_PARTICLE@ Ray Tracing Team
% @MCCODE_DATE@

# NAME

**@MCCODE_PREFIX@display** - @MCCODE_NAME@ Graphical display of simulations

# SYNOPSIS

**@MCCODE_PREFIX@display** [-h] [--default] [--dirname DIRNAME] [--inspect INSPECT] [--invcanvas] [-n N] INSTR [options ...]

# DESCRIPTION

The **@MCCODE_PREFIX@display** 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 @MCCODE_PARTICLE@s 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 @MCCODE_PARTICLE@s are getting lost. To use the
**@MCCODE_PREFIX@display** front-end with a simulation, run it as follows: 
`@MCCODE_PREFIX@display INSTR args...` where INSTR is the name of either the instrument 
source `INSTR.instr` or the simulation program `INSTR.out` generated with
@MCCODE_NAME@, and `args` are the normal command line arguments for the simulation,
as for *@MCCODE_PREFIX@run*. The `-h` option will list valid options.

The default plotting backend is `@MCCODE_PREFIX@display-pyqtgraph`, but there exists a number of additional plotters such as `@MCCODE_PREFIX@display-matplotlib`, `@MCCODE_PREFIX@display-webgl-classic` (using WebGL), `@MCCODE_PREFIX@display-webgl` (using WebGL and NodeJS), `@MCCODE_PREFIX@display-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/@FLAVOR@/tools/Python
/usr/share/@FLAVOR@/tools/Python/mccodelib/mccode_config.json
~/.@FLAVOR@/mccode_config.json
http://www.@FLAVOR@.org

# EXAMPLES

Display the *Test_SX* example (Single crystal diffraction)
:   - `@MCCODE_PREFIX@display Test_SX.instr -d output_dir -n 1e2 TTH=13.4`

# AUTHORS

@MCCODE_NAME@ Team (@FLAVOR@.org)

# SEE ALSO

@FLAVOR@(1), @MCCODE_PREFIX@doc(1), @MCCODE_PREFIX@plot(1), @MCCODE_PREFIX@run(1), @MCCODE_PREFIX@gui(1), @MCCODE_PREFIX@display(1)
