diff --git a/README.md b/README.md index ba62db9..f2fbbcd 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,14 @@ Calcul altimétrique # Principe -L'objectif de ce projet est de calculer des différentiels entre les MNT LIDAR HD et le RGE ALTI +L'objectif de ce projet est de calculer des différentiels entre : +- les MNT LIDAR HD (stockés localement sous forme de fichiers .tif) +- le produit [RGE ALTI](https://geoservices.ign.fr/rgealti) récupéré via les flux de diffusions de la [geoplateforme](https://geoservices.ign.fr/services-geoplateforme-diffusion). Ce projet utilise une infrastructure de gestion de production par ordinateur [IGN GPAO](https://github.com/ign-gpao) développée au sein de l'IGNF pour la parallélisation des calculs. - # Installation Ce code utilise mamba pour l'installation de l'environnement python (et suppose qu'une version de mamba ou micromamba @@ -30,7 +31,7 @@ Sous linux : # Usage -## Commande +## Activation de l'environnement Sous Windows : lancer `Miniforge Prompt` @@ -43,36 +44,95 @@ Activer l'environnement conda : conda activate altianalysis ``` -Lancer l'utilitaire avec la commande suivante : +## Utilisation sur un seul fichier tif + +Lancer l'utilitaire avec la commande suivante si vous disposez de deux sources de MNT pour calculer la différence : + +```bash +python -m altianalysis.compute_difference \ +--primary_elevation_file \ +--second_elevation_file \ +--name_save_out +``` + +Dans le cas où vous voudriez calculer la carte de différence entre un MNT et le RGE Alti: ```bash -python -m altianalysis.calculDifferentiel -i \ - -o \ - -g \ - -l \ - -s \ - -p +python -m altianalysis.compute_difference \ +--primary_elevation_file \ +--name_save_out ``` options: -* -i INPUT [INPUT ...], --input INPUT [INPUT ...] - Dossier(s) contenant des dalles mnt Lidar HD. -* -o OUT, --out OUT Dossier de sortie des cartes de différence -* -l LOCAL_STORE_PATH, --local-store-path LOCAL_STORE_PATH - Chemin vers un store commun sur le PC qui lance ce script -* -s RUNNER_STORE_PATH, --runner-store-path RUNNER_STORE_PATH - Chemin vers un store commun sur les clients GPAO (Unix path) -* -g GPAO_HOSTNAME, --gpao-hostname GPAO_HOSTNAME - Hostname du serveur GPAO -* -p PROJECT_NAME, --project-name PROJECT_NAME - Nom de projet pour la GPAO + * --primary_elevation_file FIRST_DTM_FILE + Chemin vers le permier MNT + + * --second_elevation_file SECOND_DTM_FILE + Chemin vers le deuxième MNT + + * --name_save_out NAME_SAVE_OUT + Chemin vers le fichier tif de sortie (carte de différence) + + +## Utilisation pour un batch en utilisant la [GPAO](https://github.com/ign-gpao/) +Lancer l'utilitaire avec la commande suivante si vous disposez de deux dossiers contenant des MNT dont vous voudriez calculer la différence: +NB. Les fichiers doivent avoir les mêmes noms pour être appariés. + +```bash +python -m altianalysis.run_difference_with_gpao \ + -i \ + -ii \ + -o \ + -l \ + -s \ + [-g ] \ + [-p ] \ + [-c ] +``` + +Pour calculer des cartes de différences par rapport au flux RGE Alti: + +```bash +python -m altianalysis.run_difference_with_gpao \ + -i \ + -o \ + -l \ + -s \ + [-g ] \ + [-p ] \ + [-c ] +``` + + +options: + * -h, --help show this help message and exit + * -i FIRST_DTM_DIR, --primary_dtm_dir FIRST_DTM_DIR + Dossier contenant le permier set de MNTs + * -ii SECOND_DTM_DIR, --secondary_dtm_dir SECOND_DTM_DIR + Dossier contenant le deuxième set de MNTs ( s'il existe ) + * -o OUT, --out OUT Dossier de sortie où seront sauvegardées les cartes de + differences + * -l LOCAL_STORE_PATH, --local_store_path LOCAL_STORE_PATH + Chemin vers un store commun sur le PC qui lance ce + script + * -s RUNNER_STORE_PATH, --runner_store_path RUNNER_STORE_PATH + Chemin vers un store commun sur les clients GPAO (Unix + path) + * -g GPAO_HOSTNAME, --gpao_hostname GPAO_HOSTNAME + Hostname du serveur GPAO + * -p PROJECT_NAME, --project_name PROJECT_NAME + Nom de projet pour la GPAO + * -c COG_FILENAME, --cog_filename COG_FILENAME + Nom du fichier cog sauvé dans le même dossier que les + sorties individuelles. Pas de cog généré si non + renseigné # Contribuer -Ce dépôt utiliser des pre-commits pour le formattage du code. +Ce dépôt utilise des pre-commits pour le formattage du code. Avant de d'ajouter des changements, veillez à lancer `make install-precommit` pour installer les precommit hooks. Pour lancer les tests : `make testing`