mcDISPLAY(1)

💖 mcDISPLAY(1) — the manual page, bestie edition 💖

okay so bestie, welcome to mcDISPLAY, aka the mcstas Graphical display of simulations manual. pull up a chair, grab a boba, we're gonna debug some neutrons together 🧚✨

---

✨ SYNOPSIS ✨

mcdisplay [-h] [–default] [–dirname DIRNAME] [–inspect INSPECT]
[–invcanvas] [-n N] INSTR [options ...]

---

🌸 DESCRIPTION 🌸

so like. the mcdisplay front-end is a graphical debugging tool. it draws you a schematic of your instrument definition, showing where all the components are sitting and the paths your simulated neutrons take through the instrument. it's giving main character energy for debugging, fr fr — like, you can spot components that are in the totally wrong position, or figure out exactly where your neutrons are getting lost. no cap, it's iconic.

to use the mcdisplay front-end with a simulation, you run it like this:

mcdisplay 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 just the normal command line arguments for the simulation, exactly like for mcrun. the -h option will list valid options for you 💅

the default plotting backend is mcdisplay-pyqtgraph, but bestie there's a whole squad of additional plotters out there:

• mcdisplay-matplotlib
• mcdisplay-webgl-classic (using WebGL)
• mcdisplay-webgl (using WebGL and NodeJS)
• mcdisplay-matlab (using Matlab or Octave)

and this one? this is the PyQtGraph plotting tool. periodt.

---

💅 OPTIONS 💅

• -h, –help — show this help message and exit. classic, love her
• –default — automatically use instrument defaults for the simulation run. lowkey convenient
• –dirname DIRNAME — output directory name override
• –inspect INSPECT — display only particle rays reaching this component 👀
• –invcanvas — invert canvas background from black to white. for the light-mode girlies 🎀
• -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 Test_SX.instr -d output_dir -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.

---

okay bestie that's the whole page, we ate and left no crumbs 🫶 this one's shipped from the git source and it's literally just mcDISPLAY(1) — go forth and debug, you gorgeous genius 💖✨🌸