XMDS2(1)

πŸ‘‘ XMDS2 β€” the eXtensible Multi-Dimensional Simulator v2

okay bestie, welcome to the User Commands section of the manual, and buckle up because this one is a whole vibe. ✨ This is xmds2(1), and it's genuinely iconic.


🌈 SYNOPSIS

xmds2 [options] fileToBeParsed

πŸ’– DESCRIPTION

so xmds2 is a code generator that integrates equations. that's the whole thing. that's the girlboss energy. πŸŽ€

here's the tea: you write your equations down in human readable form inside an XML file, and then it literally goes away and writes and compiles a C++ program that integrates those equations as fast as it can possibly be done in your architecture. no cap. it's giving "I'll handle the hard part, you go be a genius." πŸ’…

and if you wanna know how to actually write a script for xmds, or how to solve problems in physics, mathematics, and even finance and economics (yes really, she does it all 🫢), go read the associated documentation, available from the xmds web site: http://www.xmds.org.


✨ OPTIONS ✨

  • -h, --help β€” prints the help message. bestie behavior honestly, always ask for help when you need it πŸ’–
  • -o file, --output-file=file β€” overrides the name of the output file to be generated. you're renaming the baby πŸŽ€
  • -v, --verbose β€” verbose mode. she will tell you EVERYTHING. yapper mode activated πŸ—£οΈ
  • -g, --debug β€” debug mode. compiler error messages report errors in the .cc file, not the .xmds file. implies --verbose. mostly useful when debugging xmds code generation. > heads up: this changes where your errors point, so don't get confused when it's talking about .cc instead of .xmds 😭
  • -n, --no-compile β€” only generate a source file, don't compile. she writes the homework but doesn't submit it πŸ“
  • --configure β€” runs configuration checks for compiling simulations. vibe check for your whole setup ⭐
  • --reconfigure β€” runs configuration using the same options as used with the last time --configure was run, with the additional arguments specified. she remembers what you told her last time 🧠✨
  • --include-path /path/to/include β€” adds the path /path/to/include to the list of paths searched for include headers. this option is only meaningful when used with --(re)configure. πŸ‘€
  • --lib-path /path/to/lib β€” adds the path /path/to/lib to the list of paths searched for libraries. this option is only meaningful when used with --(re)configure. same energy, different folder πŸ’œ

🌸 FILES

  • ${HOME}/.xmds/ β€” directory for storing settings and fftw wisdom files. yes, "wisdom files." she's keeping secrets in there and honestly? iconic. πŸ¦‹

πŸ”₯ SEE ALSO

for further help, please see http://www.xmds.org 🌈


🫢 AUTHORS

Graham Dennis <graham.dennis@anu.edu.au>, Joe Hope, Mattias Johnsson, Andy Ferris, Michael Hush, Gabriel McManus, and others.

the "and others" is doing so much heavy lifting and we love that for them πŸ’€ no but fr, thank you to everyone who built this.

and that's the whole page, bestie. this was xmds2 β€” source xmds2, dated December 2012, living in the XMDS2(1) manual. slay, go integrate some equations. πŸ’…βœ¨πŸŽ€