Install WareMax and run your first scenario
Install the WareMax Rust CLI, run a deterministic RMFS scenario from a YAML file, and read the resulting metrics — from clone to first trajectory.
WareMax is a Cargo workspace with two surfaces: a Rust CLI (waremax) and a Python
extension that exposes a Gymnasium environment. This guide gets the CLI running and
produces your first deterministic trajectory.
1. Clone and build
git clone https://github.com/Skelf-Research/waremax
cd waremax
cargo install --path .The build produces a single waremax binary. Nothing else needs to run — there is no
daemon and no server for a basic simulation.
2. Run a scenario
A scenario is a YAML file describing the topology, robots, stations, orders, traffic, and policy stack. Run it with:
waremax run scenario.yamlBecause the scenario fixes a seed, the run is deterministic: the same file produces
the same trajectory every time. See writing a scenario YAML
for the full schema.
3. Read the output
WareMax exports an event log, time-series metrics, and a per-task delay attribution. The delay-attribution guide explains how to read the five-bucket decomposition that sums to cycle time.
Next steps
WareMax is a research benchmark from Skelf Research. The authoritative source is the GitHub repository.
Frequently Asked Questions
What do I need installed to build WareMax?
A recent stable Rust toolchain (via rustup) is enough for the CLI. For the Gymnasium environment you also need Python and maturin to build the PyO3 extension.
Is the first run reproducible?
Yes. As long as the scenario fixes a seed, running the same scenario twice produces a byte-identical trajectory — that is a tested property of the simulator.