MAMUT-routing documentation¶
MAMUT-routing is a curated collection of vehicle-routing benchmarks (CVRP, VRPTW, TDVRP, TDVRPTW) with checker-validated best-known solutions, a fully static website that browses and visualises them, and a Python stack to load, check, solve, generate and publish them. It is part of the ANR MAMUT project.
This documentation follows the Diátaxis split: tutorials to learn, guides to get a task done, reference to look things up, and explanation where the why matters.
-
I want to use the benchmarks
Download instances and best-known solutions, read the formats, check a solution, export to CVRPLIB
.vrp, cite the data. -
I maintain the platform
Update a family or a BKS, add a family or a problem type, run generation and BKS campaigns, build and deploy the website, cut a release.
-
I contribute code
Architecture of the four repositories, development setup, tests, conventions and the generated API reference.
-
I want to browse first
The website's catalog, instance pages with route maps, objectives, publication history and the upload workbench.
The pieces¶
| Repository | Role | Install |
|---|---|---|
| MAMUT-routing | The benchmark tree (families as submodules), the website publisher mamut-routing-publish, this documentation |
checkout + uv sync |
| MAMUT-routing-lib | The data contract: models, checkers, BKS logic, remote archives, CVRPLIB export, mamut-routing CLI |
pip install "mamut-routing-lib[cli]" |
| MAMUT-routing-tools | Local generation and solving: OSM fetch, road graphs, instance generation, converters, workbench GUI, mamut-tools CLI |
uvx --from mamut-routing-tools mamut-tools |
| Benchmark satellites | One repository per large family or collection (MAMUT-routing-TDVRPTW-Rifki2020, MAMUT-routing-Poryos2026, ...) |
git submodule update --init benchmarks/<...> |
Where things are¶
- Benchmark families, one page each, with their repository README: Families.
- Formats and the checker contract: Formats and the Python API reference.
- Every command-line option: CLI reference.
- Why things are the way they are: the FAQ and the Developer guide.