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
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.
Getting Started
- Install the Python package with
pip install pymetropolis. - Download the Metropolis-Core simulator.
- Create a TOML configuration file describing the simulation instance.
- 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.
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:
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
For more details, please read CONTRIBUTING.md and CODE_OF_CONDUCT.md.
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.
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
Acknowledgments
Pymetropolis benefited from the work of Kokouvi Joseph Djafon on the calibration tools.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pymetropolis-0.11.0.tar.gz.
File metadata
- Download URL: pymetropolis-0.11.0.tar.gz
- Upload date:
- Size: 158.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
921da2df46b45d039a20146248580194426517099fbe4a21cd265d040554e8b7
|
|
| MD5 |
c05f990b1b17b883d5309b48485dddcf
|
|
| BLAKE2b-256 |
e3a79af7a08b3b81cef0d5da47e3e9429ed50d57d3c931191e113eb7ec218bdd
|
File details
Details for the file pymetropolis-0.11.0-py3-none-any.whl.
File metadata
- Download URL: pymetropolis-0.11.0-py3-none-any.whl
- Upload date:
- Size: 213.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
03a333fe77823918fe31a933e08651c5b161a7b7adfb947c12a168697aafbf82
|
|
| MD5 |
02420a80e8a8b37e2fc8003086cbc681
|
|
| BLAKE2b-256 |
38be5753a0d21df636cbfc07c7ab4421eeaa3c0dcbd6b439c8eaa7c049b5d87c
|
