Skip to main content

MnMS 🍬

MnMS (Multimodal Network Modelling and Simulation) is a multimodal dynamic traffic simulator designed for a large urban scale. It results from all research activities of the ERC MAGnUM project. Further extensions related to on-demand mobility have been developed with the DIT4TraM project.

MnMS is an agent-based dynamic simulator for urban mobility. Travelers make mode and route choices considering all multimodal options on the city transportation network, including traditional modes, such as personal cars or public transportation, and new mobility services, such as ride-hailing, ride-sharing, or vehicle sharing. Vehicles motion is governed by regional multimodal MFD (Macroscopic Fundamental Diagram) curves, so all vehicles of the same type (car, bus, etc.) share the same speed within a specific region at a given time. The adoption of this traffic flow modelling framework makes it possible to address at large urban scale timely research topics such as the management of new mobility services (operation, optimization, regulation), the design of regulatory policies taking into account the multiple stakeholders setting of today's urban transportation system, and beyond!

Installation

From package manager

This is the recommended (and most simple!) method to install MnMS: just download it from PyPI.

pip install mnms

From sources

  1. Download the latest MnMS sources from https://github.com/EMob-Lab/MnMS/archive/refs/heads/main.zip or by cloning the git repository:

    git clone https://github.com/EMob-Lab/MnMS.git
    
  2. From the root directory of the MnMS sources:

    pip install .
    
    # Optionally, to run the tests:
    pip install --group dev
    pytest
    

Remarks: the --group <group-name> option requires pip ≥ 25.1. If you have an older version, the install command above will fail with an error message such as no such option: --group. In this case, try to upgrade pip beforehand with:

pip install --upgrade pip

Alternatively, install the test dependencies pytest and pytest-cov manually (or skip the optional test running step).

HiPOP dependency

MnMS depends on HiPOP, the C++ graph library used under the hood. It is declared as a regular dependency, thus is automatically fetched from PyPI when necessary. For most users this is transparent: a prebuilt HiPOP distribution adapted to your OS / system architecture is downloaded, and no C++ toolchain is required.

Prebuilt distributions are currently provided for the following environments:

  • Windows on x86_64 architecture (i.e. Intel/AMD CPU)
  • Linux on x86_64 architecture (i.e. Intel/AMD CPU)
  • MacOS (≥ 14 Sonoma) on ARM64 architecture (i.e. Apple M* CPU)

If your environment is not covered, the installation fails while fetching HiPOP. You then need to build HiPOP locally (a C++ toolchain is required; see the HiPOP documentation), or contact the package maintainers.

Usage, tutorials and examples

Simulations can be run from the command line with:

mnms path/to/config.json

... where path/to/config.json is a JSON configuration file defining the simulation parameters. See examples/cli/mnms_settings.json for an example of such a configuration file, and run mnms -h for more details.

Tutorials can be found in the doc/tutorials directory as jupyter notebooks. Some simulation examples can be found in the examples directory.

Documentation

Built

Build the technical documentation using mkdocs with:

pip install --group doc
mkdocs serve

Detailed

The detailed documentation is available here: https://github.com/EMob-Lab/MnMS/blob/main/doc/MnMS_detailed_documentation.pdf

Metadata

Release files for MnMS 1.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for MnMS 1.1.0
File Size Uploaded Provenance Actions
mnms-1.1.0.tar.gz 165.2 kB With provenance Details for mnms-1.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for MnMS 1.1.0
File Interpreter ABI Platform Actions
mnms-1.1.0-py3-none-any.whl Python 3 none any Details for mnms-1.1.0-py3-none-any.whl

Total release size: 302.6 kB

Release files / mnms-1.1.0.tar.gz

Download URL mnms-1.1.0.tar.gz
Size 165.2 kB
Tags Source
SHA-256 checksum
How to use checksums
c86e33b2f95853ff2ed6ee197d6747feae8a1e1cb8a1b8320360097e15d1d405
BLAKE2b-256 checksum
How to use checksums
f221fedbbd57c0f4e02d88e5ad995fb3cf75010b57f131e7576e0db7f772e823
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

Release files / mnms-1.1.0-py3-none-any.whl

Download URL mnms-1.1.0-py3-none-any.whl
Size 137.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ed78e5b462530de184e9bac2959a1743ecc9e7713887435faa567dee91f07214
BLAKE2b-256 checksum
How to use checksums
0b303c65a57ba5008fb292912a4db32cf2a9a0eb791e47cb9e0a7ddbf2ff64aa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

Security for MnMS 1.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mnms-1.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 18, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page