---
name: "mcplot-matplotlib"
section: "1"
platform: "linux"
package: "mcstas-mcplot-matplotlib"
version: "3.5+3.5.19+ds5-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/mcplot-matplotlib"
---

# mcplot-matplotlib(1)

Plotting the results of a mcstas simulation using Matplotlib

## NAME

**mcplot-matplotlib** - Plotting the results of a mcstas simulation using Matplotlib

## SYNOPSIS

**mcplot-matplotlib** \[-h\] \[-t\] \[–html\] \[–format FORMAT\] \[–output OUTPUT\] \[–log\] \[–backend BACKEND\] \[simulation ...\]

## DESCRIPTION

The front-end **mcplot-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 `mcplot-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 *mcplot-matplotlib*, e.g. `mcplot-matplotlib dir` or `mcplot-matplotlib file`. It is also possible to plot one single text (not binary) data file from a given monitor, passing its name to `mcplot-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 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/mcstas/resources /usr/share/mcstas/tools/Python/mccodelib/mccode\_config.json ~/.mcstas/mccode\_config.json http://www.mcstas.org

## EXAMPLES

- Run and plot the *Test\_SX* example (Single crystal diffraction)

  - •

  `mcrun Test_SX.instr -d output_dir -n 1e7 TTH=13.4`

- •

  `mcplot-matplotlib output_dir`

## AUTHORS

mcstas Team (mcstas.org)

## SEE ALSO

[mcstas(1)](/mcstas/1.md), [mcdoc(1)](/mcdoc/1.md), [mcplot(1)](/mcplot/1.md), [mcrun(1)](/mcrun/1.md), [mcgui(1)](/mcgui/1.md), [mcdisplay(1)](/mcdisplay/1.md)

## AUTHORS

MCSTAS neutron Ray Tracing Team.