mcPLOT-MATLAB(1)

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

💖 mcPLOT-MATLAB 💖

okay bestie, so this is the mcPLOT-MATLAB(1) manual page, and it's literally about plotting your mcstas simulation results with Matlab or Octave. it's giving ✨ data visualization ✨ and honestly? iconic. let's get into it 🫶

🌸 NAME 🌸

mcplot-matlab — plotting the results of a mcstas simulation using Matlab/Octave 🎀

✨ SYNOPSIS ✨

mcplot-matlab [-hom] [-png|-jpg|-fig|-eps|-pdf] [FILE|DIR]

💅 DESCRIPTION 💅

So the front-end mcplot-matlab is a program that makes plots of all the monitors in a simulation, which means it's the absolute bestie for getting a quick overview of what your simulation actually did. 👑

In the simplest case you just run the front-end by typing mcplot-matlab and that's it. It'll plot any simulation data stored in the current directory — which is where simulations store their results by default, no cap. 📁

If you've used the --dir or --file options, you pass the name of the file or directory to mcplot-matlab, like:

mcplot-matlab dir
mcplot-matlab file

You can also plot one single text (not binary) data file from a given monitor by passing its name to mcplot-matlab. Note the text part, bestie — not binary, we don't do binary here. 🙈

And the -h option will list all the valid options, in case you want the receipts. 🧾

Also just so you know: this is the Matlab/Octave plotting tool.

🌈 OPTIONS 🌈

  • [-png|-jpg|-fig|-eps|-pdf] — export the specified monitor file or directory to the given format. pick your fave, they're all valid 💖
  • -m FILE|DIR — explicitly request to use Matlab. like, you're sure. you're committed. Matlab it is. 💜
  • -o — explicitly request to use Octave. the free & open source bestie 🐙

🎀 FILES 🎀

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

🦋 EXAMPLES 🦋

Let's run and plot the Test_SX example (that's Single crystal diffraction, for the record ✨):

  1. mcrun Test_SX.instr -d output_dir -n 1e7 TTH=13.4
  2. mcplot-matlab output_dir

and boom, plots. ate. 💅

👑 AUTHORS 👑

mcstas Team (mcstas.org) — shoutout 🫶

⭐ SEE ALSO ⭐

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

go read those too, they're all part of the family 🌸

💜 AUTHORS 💜

MCSTAS neutron Ray Tracing Team.

k that's the whole page bestie 💖 this one came from the git source, and it's dated in the footer — so yeah, that's the version you're reading. mwah, go plot something gorgeous 🌈✨

📦 where this page comes from