mcDISPLAY-WEBGL-CLASSIC(1)

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

✨ mcdisplay-webgl-classic — the manual page, but make it cute ✨

okay bestie, welcome to mcDISPLAY-WEBGL-CLASSIC(1), aka the glow-up of your instrument debugging era 💅

💖 NAME 💖

mcdisplay-webgl-classic — mcstas graphical display of simulations using WebGL (in a browser). yes it's giving "watch your neutrons live their best life in a browser window" 🌈

🦋 SYNOPSIS 🦋

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

🌸 DESCRIPTION 🌸

so mcdisplay-webgl-classic is a graphical debugging tool, and she is that girl. she draws you a schematic of your instrument definition — every component and where it's sitting — and then she traces the paths of the simulated neutrons as they vibe their way through the whole thing. absolutely iconic for debugging a simulation. like, is a component in the wrong position? is a neutron getting lost somewhere and you have no idea where? this is the tool that tells you. no cap.

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

mcdisplay-webgl-classic 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, as for mcrun. and if you ever forget all this (we've all been there 🫶), the -h option will list valid options.

this is the classic WebGL (browser) plotting tool. the OG. the blueprint. 💅

🎀 OPTIONS 🎀

  • INSTR — displays the given mcstas 3D model with its defaults/current parameters. just hand her the instrument and she goes 🦋
  • name1=value1 ... — displays the given mcstas model with given parameters. name-value pairs, bestie, that's the whole vibe.
  • -h, –help — show this help message and exit. your emergency exit, your safe word, your "wait what were the flags again" moment 💀
  • –default — automatically use instrument defaults for simulation run. no overrides, no fuss, just defaults being defaults ✨
  • –dirname DIRNAME — output directory name override. you pick where the output goes, main character energy 👑
  • –inspect INSPECT — display only particle rays reaching this component. obsessed. this is how you zoom in on exactly one component and see who's actually making it there 😭
  • –nobrowse — do not open a webbrowser viewer. she'll keep it to herself, no browser popup jumpscare 🙈
  • –invcanvas — invert canvas background from black to white. dark mode girlies and light mode girlies, both served 🌈
  • –first FIRST — zoom range first component. set the start of your zoom window, bestie 🔍
  • –last LAST — zoom range last component. and this is where the zoom window ends. first + last = the range, iykyk ✨
  • -n N, –ncount N — number of particles to simulate. how many neutrons are we sending on this journey today, fr fr ⭐

🧚 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). she's a classic for a reason 🍓

  • mcdisplay-webgl-classic Test_SX.instr -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 💖 (yes, again, they said it twice and we respect it)

mcstas neutron Ray Tracing Team.

and that's the whole page, bestie! this one's dated July 2024, from the mcstas crew, and it lives in the mcDISPLAY-WEBGL-CLASSIC(1) manual section. go debug something gorgeous 💅✨🦋
📦 where this page comes from