1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
% @MCCODE_PREFIX@PLOT-MATPLOTLIB(1)
% @FLAVOR_UPPER@ @MCCODE_PARTICLE@ Ray Tracing Team
% @MCCODE_DATE@
# NAME
**@MCCODE_PREFIX@plot-matplotlib** - Plotting the results of a @MCCODE_NAME@ simulation using Matplotlib
# SYNOPSIS
**@MCCODE_PREFIX@plot-matplotlib** [-h] [-t] [--html] [--format FORMAT] [--output OUTPUT] [--log] [--backend BACKEND] [simulation ...]
# DESCRIPTION
The front-end **@MCCODE_PREFIX@plot-matplotlib** 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-matplotlib`. 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, the name of the file or directory
should be passed to *@MCCODE_PREFIX@plot-matplotlib*, e.g. `@MCCODE_PREFIX@plot-matplotlib dir` or
`@MCCODE_PREFIX@plot-matplotlib 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-matplotlib`.
The `-h` option will list valid options.
This is the Matplotlib plotting tool.
# OPTIONS
**simulation**
: file or directory to plot
**-h, --help**
: show this help message and exit
**-t, --test**
: @MCCODE_PREFIX@code data loader test run
**--html**
: save plot to html using mpld3 (linux only)
**--format FORMAT**
: save plot to pdf/png/eps/svg... without bringing up window
**--output OUTPUT**
: save plot to given file without bringing up window. Extension
(e.g. pdf/png/eps/svg) can be specified in the file name or `--format`
**--log**
: initiate plot(s) with log of signal
**--backend BACKEND**
: use non-default backend for matplotlib plot
# 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-matplotlib 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)
|
