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

# NAME

**@MCCODE_PREFIX@plot** - Plotting the results of a @MCCODE_NAME@ simulation

# SYNOPSIS

**@MCCODE_PREFIX@plot** [-h] [-t] [--invcanvas] [simulation ...]

# DESCRIPTION

The front-end **@MCCODE_PREFIX@plot** is a program that produces plots of
all the monitors in a simulation, and it is thus useful to get a quick overview
of the simulation results. In the simplest case, the front-end is run simply by
typing `@MCCODE_PREFIX@plot`. This will plot any simulation data stored in the current
directory, which is where simulations store their results by default. If the
--dir or --file options have been used (see section 5.2), the name of the file
or directory should be passed to *@MCCODE_PREFIX@plot*, e.g. `@MCCODE_PREFIX@plot dir` or `@MCCODE_PREFIX@plot file`. It
is also possible to plot one single text (not binary) data file from a given
monitor, passing its name to `@MCCODE_PREFIX@plot`. The `-h` option will list valid options.

The default plotting backend is `@MCCODE_PREFIX@plot-pyqtgraph`, but there exists a number of additional plotters such as `@MCCODE_PREFIX@plot-matplotlib`, `@MCCODE_PREFIX@plot-html` (in a browser), `@MCCODE_PREFIX@plot-matlab` (using Matlab or Octave).

# OPTIONS

**simulation**
:   file or directory to plot

   options:
**-h, --help**
:   show this help message and exit

**-t, --test**
:   @MCCODE_PREFIX@code data loader test run

**--invcanvas**
:   invert canvas background from black to white

# FILES

/usr/share/@FLAVOR@/resources
/usr/share/@FLAVOR@/tools/Python/mccodelib/mccode_config.json
~/.@FLAVOR@/mccode_config.json
http://www.@FLAVOR@.org

# EXAMPLES

Run and plot the *Test_SX* example (Single crystal diffraction)
:   - `@MCCODE_PREFIX@run Test_SX.instr -d output_dir -n 1e7 TTH=13.4`
:   - `@MCCODE_PREFIX@plot output_dir`

# 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)
