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 and Elioth with ADEME support, but anyone can join us! For now, it is mainly focused on French territories.
Documentation on mobility.readthedocs.io
Find more infos (in French) on Mobility website
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 et Elioth avec le soutien de l'ADEME, 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
Plus d'infos sur le site web !
Installation
- Installer mamba avec 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). - Il faut appeler
mobility.setupavant 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 |
| AREP | En cours (2022) | Étude pour le Grand Annecy |
Comment utiliser Mobility ?
En cours de rédaction
Comment contribuer ?
- Vous pouvez regarder nos issues, particulièrement celles marquées comme good-first-issue, 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.
- 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 !