mxDISPLAY-MATPLOTLIB(1)

💖 mxDISPLAY-MATPLOTLIB 💖

okay bestie, welcome to the manual for mxDISPLAY-MATPLOTLIB — literally the cutest little way to see your mcxtrace simulation with your own two eyes. let's get into it 🦋

---

✨ NAME ✨

mxdisplay-matplotlib — the mcxtrace graphical display of simulations using Matplotlib. yes, that's the whole vibe. plotting but make it particle physics 💅

---

🌸 SYNOPSIS 🌸

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

short, sweet, and it WILL change your life. fr fr.

---

🎀 DESCRIPTION 🎀

so the mxdisplay-matplotlib front-end is a graphical debugging tool. what does that even mean? it means it serves you a schematic drawing of your instrument definition — showing you where the components are sitting and the paths that the simulated xrays take as they travel through the instrument. it's giving map-of-the-whole-vibe. 🗺️✨

which is extremely useful for debugging a simulation, bestie. like:

• spotting components that ended up in the wrong position (not the main character energy you wanted 😭)
• finding out where the xrays are getting lost (where are they going?? hello?? 💀)

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

mxdisplay-matplotlib 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. the -h option will list valid options, so if you're ever lost just ask for help, she'll tell you 🫶

the default plotting backend is mxdisplay-pyqtgraph, but there exists a number of additional plotters, like:

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

and this one is the Matplotlib plotting tool. so if matplotlib is your girl, you are in exactly the right place 💅✨

---

👑 OPTIONS 👑

• INSTR — displays the given McCode 3D model with its defaults/current parameters. just hand her the instrument and she'll do the rest 🎀
• name1=value1 ... — displays the given McCode model with given parameters. you get to be specific, periodt ✨
• -n N, --ncount N — number of particles to simulate 🔥

---

🦋 FILES 🦋

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

these are the places she's looking at, bestie. now you know 👀

---

⭐ EXAMPLES ⭐

display the Test_SX example (that's Single crystal diffraction, iykyk):

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

ate. no crumbs. 💅

---

🌈 AUTHORS 🌈

mcxtrace Team (mcxtrace.org)

---

💜 SEE ALSO 💜

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

go read those too, they're all iconic in their own way 🫶

---

🌟 AUTHORS (again, bc they deserve it) 🌟

MCXTRACE xray Ray Tracing Team.

---

ngl, that's the whole page. every flag, every file, every vibe. no gatekeeping here 💖

and that's a wrap, bestie 🎬 — this page came to you from git, and it's the mxDISPLAY-MATPLOTLIB(1) page, so you literally just read the whole thing. go plot something gorgeous 🌸✨💅