mxDISPLAY-WEBGL-CLASSIC(1)

📦
version 3.5+3.5.19 · 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute

💅 mxdisplay-webgl-classic — the classic WebGL browser plotter 💅

ok so bestie, this is the manual page for mxdisplay-webgl-classic(1) from the mcxtrace family, and no cap it's about graphically displaying your simulations with WebGL in a browser. let's get into it 🦋

✨ NAME ✨

mxdisplay-webgl-classic — mcxtrace Graphical display of simulations using WebGL (in a browser) 🌈

✨ SYNOPSIS ✨

mxdisplay-webgl-classic [-h] [–default] [–dirname DIRNAME] [–inspect
INSPECT] [–nobrowse] [–invcanvas] [–first FIRST] [–last LAST] [-n N]
INSTR [options ...]

✨ DESCRIPTION ✨

okay so the mxdisplay-webgl-classic front-end is a graphical debugging tool. it pulls up a schematic drawing of your instrument definition, showing where all the components are sitting and the paths your simulated xrays take as they vibe their way through the instrument. it's giving extremely useful for debugging — like when you need to spot a component that's in the completely wrong position, or figure out where your xrays are getting lost (rip to them 😭).

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

mxdisplay-webgl-classic 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, same as you'd pass to mxrun. the -h option will list valid options. 💖

this is the classic WebGL (browser) plotting tool.

✨ OPTIONS ✨

  • INSTR — displays the given mcxtrace 3D model with its defaults/current parameters. 👑
  • name1=value1 ... — displays the given mcxtrace model with given parameters.
  • -h, –help — show this help message and exit
  • –default — automatically use instrument defaults for simulation run
  • –dirname DIRNAME — output directory name override
  • –inspect INSPECT — display only particle rays reaching this component
  • –nobrowse — do not open a webbrowser viewer 🙈
  • –invcanvas — invert canvas background from black to white
  • –first FIRST — zoom range first component
  • –last LAST — zoom range last component
  • -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

✨ EXAMPLES ✨

display the Test_SX example (Single crystal diffraction) — iconic honestly 💅

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

✨ AUTHORS ✨

mcxtrace Team (mcxtrace.org) 🫶

✨ SEE ALSO ✨

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

✨ AUTHORS ✨

mcxtrace xray Ray Tracing Team. 💜

and that's the whole page bestie, you ate it fr fr 🎀

this edition dropped July 2024, and it lives under the manual name mxDISPLAY-WEBGL-CLASSIC(1) — go forth and debug your instrument, main character energy only 👑✨

📦 where this page comes from