Guides
Practical, step-by-step walkthroughs for installing WareMax, writing scenarios, training RL policies, and verifying reproducibility.
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.
Writing a WareMax scenario YAML
Define an RMFS scenario in YAML: seed, robots, stations, order arrivals, traffic, and the policy stack — the file that drives a deterministic run.
Plug WareMax into a Gymnasium RL loop
Use WaremaxAllocEnv as a Gymnasium environment: the Dict observation, action mask, SMDP framing, and the four reward modes — wired for MaskablePPO.
Verifying determinism and replay in WareMax
How WareMax guarantees byte-identical trajectories: a ChaCha8 RNG, canonical id-based tie-breaking, and single-threaded runs. A tested property.
Reading WareMax delay attribution
Every completed task decomposes into five buckets — assignment, travel, queue, congestion, service — summing to cycle time. Read it and use it as reward.