Pymetropolis

Pymetropolis is a Python pipeline to generate, calibrate, run and analyze METROPOLIS2 simulation instances.
Explore the docs »

Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Semver
2. Getting Started
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

METROPOLIS2 is a dynamic multi-modal agent-based transport simulator.

Built With

Pymetropolis make use of some great Python libraries, including:

• geopandas for geospatial data manipulation
• loguru for logging
• matplotlib for data visualization
• networkx for graph manipulation
• numpy for arrays and random number generators
• pyosmium for OpenStreetMap data manipulation
• polars for extremely fast dataframes
• shapely for geometric objects
• typer for easy CLI

Semver

Pymetropolis is following Semantic Versioning 2.0.

Each new version is given a number MAJOR.MINOR.PATCH. An increase of the MAJOR number indicates backward incompatibilities with previous versions. An increase of the MINOR number indicates new features, that are backward-compatible. An increase of the PATCH number indicates bug fixes.

(back to top)

Getting Started

1. Install the Python package with pip install pymetropolis.
2. Download the Metropolis-Core simulator.
3. Create a TOML configuration file describing the simulation instance.
4. Run the pipeline with pymetropolis my-config.toml.

For more details, please refer to the documentation. You can find complete examples of simulation instances in the official case studies.

(back to top)

Contributing

If you would like to add a feature to Pymetropolis, start by opening an issue with the tag "enhancement" so that we can discuss its feasibility.

If your suggestion is accepted, you can then create a Pull Request:

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

For more details, please read CONTRIBUTING.md and CODE_OF_CONDUCT.md.

(back to top)

License

Pymetropolis is free and open-source software licensed under the GNU General Public License v3.0.

You are free to:

• Modify and redistribute this software
• Use it for any purpose, personal or commercial

Under the following conditions:

• You retain the original copyright notice
• You distribute you modifications under the same license (GPL-3.0 or later)
• You document any significant changes you make

For the full license text and legal details, see the LICENSE.txt file.

(back to top)

Contact

If you have any questions, either post an issue or send an e-mail to any of these addresses:

• METROPOLIS2 team - contact@metropolis2.org
• Lucas Javaudin - metropolis@lucasjavaudin.com

Project Link: https://github.com/Metropolis2/pymetropolis

(back to top)

Acknowledgments

Pymetropolis benefited from the work of Kokouvi Joseph Djafon on the calibration tools.

(back to top)