Tutorial

Install, run, read, and extend an XMDS project.

This guide is tuned for xmds-extended: start from the Windows portable installer, validate with the Lorenz example, then connect the XML structure of an .xmds file to the files generated by XMDS.

1. Install on Windows

Download the latest portable zip from Releases.
Extract it to a temporary directory.
Run the installer script.
Pick a short install directory.
Optionally add the install directory to PATH.

powershell -ExecutionPolicy Bypass -File .\install_windows.ps1

2. Validate with Lorenz

After installation, compile and run the repository's Lorenz example.

run_xmds E:\path\to\xmds-extended\examples\lorenz.xmds

You should then see generated files such as lorenz.cc, lorenz.exe, lorenz.cmd, lorenz.h5, and lorenz.xsil.

3. Understand the pipeline

.xmds: simulation description
.cc: generated C++
.exe: compiled binary
.cmd: Windows launcher with DLL path setup
.xsil / .h5 / .dat: output files

4. Read a simple script

examples/lorenz.xmds is a good first script because it clearly shows the main XMDS blocks:

<features> for globals
<geometry> for dimensions
<vector> for evolving variables
<sequence> for equations and integrator
<output> for sampled quantities

Continue Learning

Use the upstream tutorials to learn XMDS itself.

For the full repository tutorial, including upgrade, uninstall, troubleshooting, and recommended workflows, read the complete guide in the repository.