mxDISPLAY(1)

🌸 mxDISPLAY(1) — the manual page, but make it a group chat 🌸

okay bestie, sit down, hydrate, because we're about to talk about mxdisplay from the mxDISPLAY(1) manual — it's the mcxtrace graphical display of simulations and honestly? she's iconic. 💅

---

✨ NAME ✨

mxdisplay — mcxtrace Graphical display of simulations 🦋

---

🎀 SYNOPSIS 🎀

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

that's it, that's the whole vibe check. 👑

---

💖 DESCRIPTION 💖

so the mxdisplay front-end is a graphical debugging tool. no cap. what it does is it shows you a schematic drawing of the instrument definition — like, it puts the position of the components on screen and draws the paths of the simulated xrays going through the instrument. 🦋✨

which means it is so useful for debugging a simulation, fr fr. like, you can spot components that are in the wrong position (embarrassing, we've all been there 🙈) or find out where your xrays are getting lost (where did they go bestie 😭).

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

mxdisplay INSTR args...

where INSTR is the name of either the instrument source INSTR.instr or the simulation program INSTR.out generated with mcxtrace, and args are the normal command line arguments for the simulation, as for mxrun. and if you're lost, the -h option will list valid options. 🫶

---

🌈 the plotters situation 🌈

the default plotting backend is mxdisplay-pyqtgraph, but there exists a number of additional plotters, bestie, so you have options:

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

and this page? this page is the PyQtGraph plotting tool. ⭐

---

💅 OPTIONS 💅

• -h, –help — show this help message and exit. classic, beloved, never change.
• –default — automatically use instrument defaults for simulation run. let the instrument decide, main character energy ✨
• –dirname DIRNAME — output directory name override. name it whatever you want, it's giving customization 🎀
• –inspect INSPECT — display only particle rays reaching this component. just the ones that made it, so picky, so valid 💅
• –invcanvas — invert canvas background from black to white. light mode girlies rise 🫶
• -n N, –ncount N — Number of particles to simulate. how many babies are we throwing at this thing 🌸

---

🗂️ FILES 🗂️

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

---

🔥 EXAMPLES 🔥

Display the Test_SX example (Single crystal diffraction) 💜

• mxdisplay Test_SX.instr -d output_dir -n 1e2 TTH=13.4

go off, TTH=13.4, we love a parameter with a specific value, periodt. ✨

---

👑 AUTHORS 👑

mcxtrace Team (mcxtrace.org) 🦋

---

🌸 SEE ALSO 🌸

mcxtrace(1), mxdoc(1), mxplot(1), mxrun(1), mxgui(1), mxdisplay(1)

(not me putting mxdisplay(1) in its own SEE ALSO like yes girl, self-reference, we stan 💅)

---

💖 AUTHORS (again, because she said it twice and honestly, fair) 💖

MCXTRACE xray Ray Tracing Team. 🎀

---

and that's the whole page bestie!! this was the git version of the mxDISPLAY(1) manual, no date on the footer so we're just gonna say it's the current git vibe, slay, bye 🦋💖✨