.\" Automatically generated by Pandoc 3.1.11.1
.\"
.TH "mxDISPLAY\-MATPLOTLIB" "1" "git" "" ""
.SH NAME
\f[B]mxdisplay\-matplotlib\f[R] \- mcxtrace Graphical display of
simulations using Matplotlib
.SH SYNOPSIS
\f[B]mxdisplay\-matplotlib\f[R] [\-h] INSTR name=value\&...
.SH DESCRIPTION
The \f[B]mxdisplay\-matplotlib\f[R] 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 xrays
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 xrays are getting
lost.
To use the \f[B]mxdisplay\-matplotlib\f[R] front\-end with a simulation,
run it as follows: \f[CR]mxdisplay\-matplotlib INSTR args...\f[R] where
INSTR is the name of either the instrument source \f[CR]INSTR.instr\f[R]
or the simulation program \f[CR]INSTR.out\f[R] generated with mcxtrace,
and \f[CR]args\f[R] are the normal command line arguments for the
simulation, as for \f[I]mxrun\f[R].
The \f[CR]\-h\f[R] option will list valid options.
.PP
The default plotting backend is \f[CR]mxdisplay\-pyqtgraph\f[R], but
there exists a number of additional plotters such as
\f[CR]mxdisplay\-matplotlib\f[R], \f[CR]mxdisplay\-webgl\-classic\f[R]
(using WebGL), \f[CR]mxdisplay\-webgl\f[R] (using WebGL and NodeJS),
\f[CR]mxdisplay\-matlab\f[R] (using Matlab or Octave).
This is the Matplotlib plotting tool.
.SH OPTIONS
.TP
\f[B]INSTR\f[R]
Displays the given McCode 3D model with its defaults/current parameters.
.TP
\f[B]name1=value1 \&...\f[R]
Displays the given McCode model with given parameters.
.TP
\f[B]\-n N, \[en]ncount N\f[R]
Number of particles to simulate
.SH FILES
/usr/share/mcxtrace/tools/Python
/usr/share/mcxtrace/tools/Python/mccodelib/mccode_config.json
\[ti]/.mcxtrace/mccode_config.json http://www.mcxtrace.org
.SH EXAMPLES
.TP
Display the \f[I]Test_SX\f[R] example (Single crystal diffraction)
.IP \[bu] 2
\f[CR]mxdisplay\-matplotlib Test_SX.instr \-n 1e2 TTH=13.4\f[R]
.SH AUTHORS
mcxtrace Team (mcxtrace.org)
.SH SEE ALSO
mcxtrace(1), mxdoc(1), mxplot(1), mxrun(1), mxgui(1), mxdisplay(1)
.SH AUTHORS
MCXTRACE xray Ray Tracing Team.