mcDISPLAY-MATLAB(1)

💖 mcDISPLAY-MATLAB 💖

okay bestie, welcome to the mcdisplay-matlab page — this is the mcDISPLAY-MATLAB(1) manual and we're gonna get through it together, no cap ✨

---

✨ NAME ✨

mcdisplay-matlab — mcstas Graphical display of simulations using Matlab/Octave 🦋

---

🌸 SYNOPSIS 🌸

mcdisplay-matlab [-hom] [-png|-jpg|-fig|-eps|-pdf|-tif] [–inspect=COMP]
INSTR name=value...

---

💅 DESCRIPTION 💅

so the mcdisplay-matlab front-end is a graphical debugging tool. it's literally giving schematic drawing of the instrument definition — showing you where the components are positioned and the paths the simulated neutrons take through the instrument. which means it's super useful for debugging a simulation, like spotting components that ended up in the wrong position, or finding out where neutrons are getting lost. 🔥

to use the mcdisplay-matlab front-end with a simulation, 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 the normal command line arguments for the simulation, just like for mcrun. the -h option will list valid options. 👑

the default plotting backend is mxdisplay-pyqtgraph, but there's a whole squad of additional plotters out there, like mxdisplay-matplotlib, mxdisplay-webgl-classic (using WebGL), mxdisplay-webgl (using WebGL and NodeJS), and mxdisplay-matlab (using Matlab or Octave). this one right here is the Matlab/Octave plotting tool. 🌈

---

🎀 OPTIONS 🎀

• INSTR — displays the given mcstas 3D model with its defaults/current parameters 💖
• name1=value1 ... — displays the given mcstas model with given parameters ✨
• -n N, –ncount N — number of particles to simulate
• [-png|-jpg|-fig|-eps|-pdf|-tif] — same as above, and specifies an output file format to generate. possible save_as are -png -pdf -fig -tif -jpg -eps 🖼️
• –inspect=COMP — same as above, and only plot component names that match COMP, given as a single component word for partial match, such as Monitor; a component interval such as Monok:Sample; or 2:10 or 2:end 🔍
• -m — explicitely request to use Matlab
• -o — explicitely request to use Octave

---

🦋 FILES 🦋

• /usr/share/mcstas/tools/matlab
• /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-matlab Test_SX.instr -n 1e2 TTH=13.4

---

💜 AUTHORS 💜

mcstas Team (mcstas.org)

---

⭐ SEE ALSO ⭐

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

---

👑 AUTHORS 👑

MCSTAS neutron Ray Tracing Team.

---

okay that's the whole page bestie, you ate that 💅 and yeah — this version is from git, and it's dated the same as the footer said. slay, go debug something pretty. 🫶💖✨