Plusieurs méthodes d'installation sont décrites dans la documentation de poetry dont:
- avec pipx
- avec l'installateur officiel
Chaque méthode a ses avantages et inconvénients. Par exemple, la méthode pipx nécessite d'installer pipx au préable, l'installateur officiel utilise curl pour télécharger un script qui doit ensuite être exécuté et comporte des instructions spécifiques pour la completion des commandes poetry selon le shell utilisé (bash, zsh, etc...).
L'avantage de pipx est que l'installation de pipx est documentée pour linux, windows et macos. D'autre part, les outils installées avec pipx bénéficient d'un environment d'exécution isolé, ce qui est permet de fiabiliser leur fonctionnement. Finalement, l'installation de poetry, voire d'autres outils est relativement simple avec pipx.
Cependant, libre à toi d'utiliser la méthode qui te convient le mieux ! Quelque soit la méthode choisie, il est important de ne pas installer poetry dans l'environnement virtuel qui sera créé un peu plus tard dans ce README pour les dépendances de la base de code de ce repo git.
Suivre les instructions pour installer pipx selon ta plateforme (linux, windows, etc...)
Par exemple pour Ubuntu 23.04+:
sudo apt update
sudo apt install pipx
pipx ensurepath
pipx install poetry
L'installation avec l'installateur officiel nécessitant quelques étapes supplémentaires, se référer à la documentation officielle.
poetry config virtualenvs.in-project true
cd algorithme
poetry install --with dev
poetry env info
alembic upgrade head
-
Sur un departement:
poetry run algorithme calculate-for-schools -d 093 -
Sur une region:
poetry run algorithme calculate-for-schools -r 11 -
Sur toute la France:
poetry run algorithme calculate-for-schools --all_departements -
Mettre à jour les indicateurs dans la database duckdb:
poetry run algorithme update-database-indicators -
Obtenir les etablissements prioritaires selon les criteres de Greenpeace :
poetry run algorithme save-high-priority-schools
Note : pour executer la pipeline sur toute la France, il faut avoir à minima 180 Go d'espace disponible et compter minimum 10H de temps d'execution.
- un fichier .gpkg dans le dossier results pour les resultats pour chaque departement (ex: D093_pipeline_results.gpkg)
- dans la database duckdb
- un fichier .csv dans le dossier results avec les etablissements prioritaires selon les criteres de Greenpeace
Le notebook analyse_qualite_resultats_pipeline.ipynb permet d'analyser les resulats sur le departement de son choix.
poetry run pre-commit run --all-files
poetry run tox -vv
cd algorithme
Il est aussi possible de le faire avec Docker d'installé sans passer par python (cf 2.1).
docker build -t 13_potentiel_solaire_algo --platform linux/amd64 .
docker run --rm \
--volume ./data:/app/data \
--volume ./database:/app/database \
13_potentiel_solaire_algo alembic upgrade head
docker run --rm \
--volume ./data:/app/data \
--volume ./database:/app/database \
13_potentiel_solaire_algo algorithme calculate-for-schools --all_departements
Avec comme scope : write:packages.
Plus de détails ici.
sh publish_algorithme_results.sh