mcDISPLAY-MATPLOTLIB(1)

💖 mcDISPLAY-MATPLOTLIB 💖

okay bestie, welcome to the mcDISPLAY-MATPLOTLIB(1) page — that's section 1 of the manual, and yes it's giving main character energy 🎀

---

✨ NAME ✨

mcdisplay-matplotlib — mcstas Graphical display of simulations using Matplotlib 🌸

---

🌈 SYNOPSIS 🌈

mcdisplay-matplotlib [-h] INSTR name=value...

---

💅 DESCRIPTION 💅

So the mcdisplay-matplotlib front-end is a graphical debugging tool. No cap. It shows you a schematic drawing of your instrument definition — like, where all the components are sitting and the paths the simulated neutrons take as they zoom through the instrument 🦋

Which means it's literally perfect for debugging a simulation. Spotting a component in the totally wrong position? Found. Trying to figure out where your neutrons are getting lost? Also found 🙈

To use the mcdisplay-matplotlib front-end with a simulation, run it like this:

mcdisplay-matplotlib INSTR args...

where INSTR is the name of either:

• the instrument source INSTR.instr, or
• the simulation program INSTR.out generated with mcstas

and args are the normal command line arguments for the simulation, exactly like for mcrun. The -h option will list valid options 👑

Now, the default plotting backend is mxdisplay-pyqtgraph, but there exists a number of additional plotters such as mxdisplay-matplotlib, mxdisplay-webgl-classic (using WebGL), mxdisplay-webgl (using WebGL and NodeJS), and mxdisplay-matlab (using Matlab or Octave). And this one right here? This is the Matplotlib plotting tool 💜

---

⭐ OPTIONS ⭐

• INSTR — Displays the given McCode 3D model with its defaults/current parameters ✨
• name1=value1 ... — Displays the given McCode model with given parameters 🎀
• -n N, –ncount N — Number of particles to simulate 🔥

---

🍓 FILES 🍓

• /usr/share/mcstas/tools/Python
• /usr/share/mcstas/tools/Python/mccodelib/mccode_config.json
• ~/.mcstas/mccode_config.json
• http://www.mcstas.org

---

🧚 EXAMPLES 🧚

Display the Test_SX example (Single crystal diffraction) 👑

• mcdisplay-matplotlib Test_SX.instr -n 1e2 TTH=13.4

---

👑 AUTHORS 👑

mcstas Team (mcstas.org) 💖

---

🌸 SEE ALSO 🌸

mcstas(1), mcdoc(1), mcplot(1), mcrun(1), mcgui(1), mcdisplay(1)

---

💜 AUTHORS 💜

MCSTAS neutron Ray Tracing Team.

---

and that's the whole page, bestie, you ate that 🫶

signing off from version git of mcDISPLAY-MATPLOTLIB(1) — catch you in the next man page, mwah 💅✨