-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #222 from Geoplateforme/dev
v0.1.35
- Loading branch information
Showing
62 changed files
with
2,272 additions
and
1,093 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,6 +7,7 @@ | |
| "dépubliée", | ||
| "dépubliées", | ||
| "dépublier", | ||
| "egpf", | ||
| "EPSG", | ||
| "fontawesome", | ||
| "Géoplateforme", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,152 @@ | ||
| # Tutoriel : publier un flux PCRS | ||
|
|
||
| La Géoplateforme permet d'héberger et diffuser vos données PCRS raster/image (Plan Corps de Rue Simplifié). | ||
|
|
||
| Pour cela, vous devez téléverser des dalles « PCRS » qui permettront de créer une pyramide image qui sera diffusée en flux. | ||
|
|
||
| Voici les prérequis pour suivre ce tutoriel : | ||
|
|
||
| * vous devez disposer d'un compte Géoplateforme (création en suivant ce [tuto](https://geoplateforme.github.io/tutoriels/production/controle-des-acces/entrepot/creation_compte/) ou sur [cartes.gouv](https://cartes.gouv.fr/)) | ||
| * vous devez disposer d'un datastore (pour sa création, vous pouvez contacter [email protected] ou faire une demande [ici](https://cartes.gouv.fr/entrepot/demande-de-creation) en précisant votre établissement, qu'il s'agit d'une diffusion partenaire PCRS et votre identifiant utilisateur que vous trouver sur votre [espace](https://cartes.gouv.fr/mon-compte)) | ||
| * vous devez avoir installé python et le module [SDK](index.md) | ||
|
|
||
| Vous allez avoir besoin de 3 fichiers pour réaliser le tutoriel dont le contenu va être détaillé : | ||
|
|
||
| * un fichier de configuration pour définir vos paramètres SDK | ||
| * un fichier descripteur qui détaille votre livraison | ||
| * un fichier de workflow en plusieurs étapes qui effectuera les traitements | ||
|
|
||
| ## Définition de la configuration | ||
|
|
||
| Vous allez devoir déposer à la racine du dossier de votre projet un fichier `config.ini` contenant les informations suivantes : | ||
|
|
||
| ```text | ||
| # Informations pour l'authentification | ||
| [store_authentification] | ||
| # paramètres du SDK | ||
| client_id=gpf-warehouse | ||
| client_secret=BK2G7Vvkn7UDc8cV7edbCnHdYminWVw2 | ||
| # Votre login | ||
| login=******** | ||
| # Votre mot de passe | ||
| password=******** | ||
| # Informations pour l'API | ||
| [store_api] | ||
| # L'identifiant sandbox | ||
| datastore=******** | ||
| ``` | ||
|
|
||
| Il faut compléter le fichier avec votre login/mot de passe et l'identifiant du datastore qui vous a été aloué. | ||
|
|
||
| Vous pouvez tester la validité de votre fichier avec la commande suivante : | ||
|
|
||
| ```text | ||
| python3 -m sdk_entrepot_gpf me | ||
| ``` | ||
|
|
||
| Cela devrait renvoyer : | ||
|
|
||
| ```text | ||
| Vos informations : | ||
| * email : ******** | ||
| * nom : ******** | ||
| * votre id : ******** | ||
| Vous êtes membre de 1 communauté(s) : | ||
| * communauté « ******** » : | ||
| - id de la communauté : ******** | ||
| - id du datastore : ******** | ||
| - nom technique : ******** | ||
| - droits : community, uploads, processings, datastore, stored_data, broadcast | ||
| ``` | ||
|
|
||
| Il peut être nécessaire de rajouter certains paramètres pour que cela fonctionne comme le proxy si vous en utilisez un. Vous pouvez suivre la page [configuration](configuration.md) pour compléter votre fichier si nécessaire. | ||
|
|
||
| ## Fichier descripteur de livraison | ||
|
|
||
| Vous allez devoir créer un fichier `PCRS_descriptor.json` à la racine de votre projet avec les informations suivantes : | ||
|
|
||
| ```text | ||
| { | ||
| "datasets": [ | ||
| { | ||
| "data_dirs": [ | ||
| "$votre_chantier_PCRS" | ||
| ], | ||
| "upload_infos": { | ||
| "description": "Description de votre chantier (département, zone, date...)", | ||
| "name": "$votre_chantier_PCRS", | ||
| "srs": "EPSG:2154", | ||
| "type": "RASTER" | ||
| }, | ||
| "comments": [ | ||
| "Votre commentaire" | ||
| ], | ||
| "tags": { | ||
| "datasheet_name": "$votre_chantier_PCRS", | ||
| "type": "PCRS" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Il faut remplacer 3 fois dans le fichier `$votre_chantier_PCRS` par une valeur sous la forme `PCRS_chantier_********` (ex: PCRS_chantier_HDF_A_2022). Cette valeur vous permettra de retrouver votre fiche de données sur cartes.gouv.fr. Vous pouvez également compléter le fichier avec une description et éventuellement un commentaire. | ||
|
|
||
| Vous déposerez vos données dans un répertoire du même nom `$votre_chantier_PCRS` à la racine de votre projet comme suit : | ||
|
|
||
| ```text | ||
| $votre_chantier_PCRS/ | ||
| ├── dalle_1.tif | ||
| ├── dalle_2.tif | ||
| └── ... | ||
| ``` | ||
|
|
||
| Vous pouvez maintenant effectuer la livraison en lançant la commande depuis la racine de votre projet ou en indiquant le chemin du fichier descripteur au programme : | ||
|
|
||
| ```sh | ||
| python3 -m sdk_entrepot_gpf delivery PCRS_descriptor.jsonc | ||
| ``` | ||
|
|
||
| Le programme doit vous indiquer que le transfert est en cours, puis qu'il attend la fin des vérification côté API avant de conclure que tout est bon `INFO - BILAN : les 1 livraisons se sont bien passées` (cela peut être long selon la taille de la livraison et la qualité de votre connexion, ne fermez pas votre terminal pendant ce temps). | ||
|
|
||
| ## Workflow | ||
|
|
||
| Une fois les données livrées, il faut créer la pyramide image avant de la diffuser en flux (WMSRaster et WMTS). | ||
|
|
||
| Ces étapes sont décrites grâces à un workflow. | ||
|
|
||
| Vous pouvez récupérer le template du workflow grâce à la commande suivante : | ||
|
|
||
| ```sh | ||
| python3 -m sdk_entrepot_gpf example workflow PCRS.jsonc | ||
| ``` | ||
|
|
||
| Pour plus de détails, consultez la [documentation sur les workflows](workflow.md). | ||
|
|
||
| Le workflow `PCRS.jsonc` est composé de 2 étapes (une pour la génération de la pyramide et une pour la publication des flux). Il faudra lancer une commande pour chacune d'elles. | ||
|
|
||
| Les commandes à lancer sont les suivantes : | ||
|
|
||
| ```sh | ||
| # partie génération de la pyramide | ||
| python3 -m sdk_entrepot_gpf workflow -f generic_raster.jsonc -s pyramide --param producteur $votre_chantier_PCRS | ||
| # partie publication | ||
| python3 -m sdk_entrepot_gpf workflow -f generic_raster.jsonc -s publication --param producteur $votre_chantier_PCRS | ||
| ``` | ||
|
|
||
| La première commande peut être longue selon le nombre de dalles livrées. Des logs doivent vous être remontés et se terminer par : | ||
|
|
||
| ```text | ||
| INFO - Exécution de l'action 'pyramide-0' : terminée | ||
| ``` | ||
|
|
||
| Avec la deuxième commande, deux offres (une WMTS et une WMSRaster) devraient être créées : | ||
|
|
||
| ```text | ||
| INFO - Offre créée : Offering(id=********, layer_name=$votre_chantier_PCRS) | ||
| ``` | ||
|
|
||
| Vous pouvez maintenant retrouver vos données dans cartes.gouv (https://cartes.gouv.fr/entrepot/$id_datastore/donnees/$votre_chantier_PCRS) ou les visionner dans un SIG comme QGIS en renseignant les urls des GetCapabilities des services ([WMTS](https://data.geopf.fr/wmts?service=WMTS&request=GetCapabilities) et [WMSRaster](https://data.geopf.fr/wms-r?)). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| """Python API to simplify the use of the GPF Warehouse HTTPS API.""" | ||
|
|
||
| __version__ = "0.1.34" | ||
| __version__ = "0.1.35" |
Oops, something went wrong.