https://github.com/mobility-team/mobility
Mobility, an open-source library for mobility modelisation
https://github.com/mobility-team/mobility
carbon carbon-footprint mobility open-source transport transportation
Last synced: 5 months ago
JSON representation
Mobility, an open-source library for mobility modelisation
- Host: GitHub
- URL: https://github.com/mobility-team/mobility
- Owner: mobility-team
- License: mit
- Created: 2022-05-09T08:49:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T09:00:22.000Z (6 months ago)
- Last Synced: 2024-10-12T12:31:05.426Z (6 months ago)
- Topics: carbon, carbon-footprint, mobility, open-source, transport, transportation
- Language: Python
- Homepage:
- Size: 51 MB
- Stars: 18
- Watchers: 5
- Forks: 11
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- open-sustainable-technology - Mobility - An open-source solution to compute the carbon emissions due to the mobility of a local population. (Consumption / Mobility and Transportation)
README
[](https://codecov.io/github/mobility-team/mobility)
[](https://github.com/mobility-team/mobility/actions/workflows/python-package.yml)
[![Code style: black][black-badge]][black-link]
[![Documentation Status][rtd-badge]][rtd-link]
# Mobility, an open-source library for mobility modelisation
Mobility is an open-source solution to compute the carbon emissions due to the mobility of a local population.
It is developed mainly by [AREP](https://arep.fr) and [Elioth](https://elioth.com/) with [ADEME](https://wiki.resilience-territoire.ademe.fr/wiki/Mobility) support, but anyone can join us!
For now, it is mainly focused on French territories.
[Documentation on mobility.readthedocs.io](https://mobility.readthedocs.io/en/latest/)
Find more infos (in French) on [Mobility website](https://mobility-team.github.io/)
# Mobility, une librairie open source pour la modélisation de la mobilité
Mobility est une solution open source servant à calculer l'empreinte carbone liée à la mobilité d'une population locale.
L'outil est principalement développé par [AREP](https://arep.fr) et [Elioth](https://elioth.com/) avec le soutien de l'[ADEME](https://wiki.resilience-territoire.ademe.fr/wiki/Mobility), mais toute personne peut nous rejoindre !
Pour l'instant, la solution est centrée sur les territoires et les données françaises.
[Documentation sur mobility.readthedocs.io](https://mobility.readthedocs.io/en/latest/)
Plus d'infos sur [le site web](https://mobility-team.github.io/) !
# Installation
- Installer mamba avec [miniforge](https://github.com/conda-forge/miniforge).
- Aller dans le dossier qui contient le code du repo : `cd path/to/mobility-repo`.
- Créer un environnement pour mobility à partir du fichier environment.yml : `mamba env create -n mobility -f environment.yml`.
- Activer l'environnement mobility : `mamba activate mobility`.
- Installer mobility avec pip : `pip install -e .`.
- Importer mobility dans votre code avec `import mobility` (script d'exemple [ici](https://github.com/mobility-team/mobility/blob/main/examples/trip_localizer_detailed_steps/trip_localizer_detailed_steps.py)).
- Il faut appeler `mobility.setup` avant de pouvoir utiliser mobility : la fonction va fixer plusieurs variables d'environnement qui peuvent être nécessaires (où stocker les fichiers temporaires, info sur le proxy pour les requêtes http...) et installer si besoin les packages R.
# Contributeur·ices
| Entreprise/école | Participant·es |
| :------------- | :------------- |
| AREP | Capucine-Marin Dubroca-Voisin
Antoine Gauchot
Félix Pouchain |
| Elioth | Louise Gontier
Arthur Haulon |
| École Centrale de Lyon | Anas Lahmar
Ayoub Foundou
Charles Pequignot
Lyes Kaya
Zakariaa El Mhassani |
# Utilisations
| Utilisateur | Date | Projet |
| :------------- | :------------- | :------------- |
| AREP | 2020-2022 | [Luxembourg in Transition]([url](https://www.arep.fr/nos-projets/luxembourg-in-transition-paysage-capital/)) |
| AREP | En cours (2022) | Étude pour le [Grand Annecy]([url](https://www.arep.fr/nos-projets/grand-annecy/)) |
# Comment utiliser Mobility ?
_En cours de rédaction_
# Comment contribuer ?
* Vous pouvez regarder nos [issues](https://github.com/mobility-team/mobility/issues), particulièrement celles marquées comme [good-first-issue](https://github.com/mobility-team/mobility/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22), et proposer d'y contribuer.
* Tester l'outil et nous indiquer là où la documentation peut être améliorée est très utile ! Que ce soit pour une suggestion ou une issue, n'hésitez pas à [ouvrir une issue](https://github.com/mobility-team/mobility/issues/new).
* Nous espérons que vous pourrez utiliser Mobility pour vos travaux de recherche et de conseil ! Nous comptons sur vous pour partager le code que vous avez utilisé.
* Nous suivons PEP8 pour notre code Python. Pour d'autres bonnes pratiques, [suivez le guide](https://github.com/mobility-team/mobility/tree/main/mobility) !
[rtd-badge]: https://readthedocs.org/projects/mobility/badge/?version=latest
[rtd-link]: https://mobility.readthedocs.io/en/latest/?badge=latest
[black-badge]: https://img.shields.io/badge/code%20style-black-000000.svg
[black-link]: https://github.com/ambv/black