Utilisation en ligne de commande

Une fois l’outil installé, il est appelable en ligne de commande : gpf-vector-checker.

Fonctionnement général

Vérification des données vectorielles téléversées au regard des règles de la Géoplateforme.

Commandes et options

Vector Checker 2.13.1-beta - Script de vérification d’une livraison de données vectorielles dans la Géoplateforme de l’IGN.

gpf-vector-checker [-h] [-v] [--version] [-w WORK_DIR_PATH] [-u UPLOAD_DIR_NAME]
                   [-c INPUT_CONFIGURATION_FILE_NAME] [-j NUMBER_THREADS]
                   [-m MIN_FILES_MULTITHREAD] [--s3-url GPF_S3_URL] [--s3-key GPF_S3_KEY]
                   [--s3-secret-key GPF_S3_SECRETKEY] [--s3-region GPF_S3_REGION]

gpf-vector-checker options

  • -h, --help - show this help message and exit

  • -v, --verbose - Verbosity level: None = WARNING, -v = INFO, -vv = DEBUG (default: 1)

  • --version - show program’s version number and exit

  • -w WORK_DIR_PATH, --workdir WORK_DIR_PATH, --work-dir-path WORK_DIR_PATH - Input working directory. Must exist. (default: None)

  • -u UPLOAD_DIR_NAME, --uploaddir UPLOAD_DIR_NAME, --upload-dir-name UPLOAD_DIR_NAME - Name (not the path) of the upload directory. (default: upload)

  • -c INPUT_CONFIGURATION_FILE_NAME, --input-configuration-filename INPUT_CONFIGURATION_FILE_NAME - Name (not the path) of the input configuration file. (default: parameters.json)

  • -j NUMBER_THREADS, --number-threads NUMBER_THREADS - Nombre de threads à utiliser pour paralléliser l’exécution (nombre de fichiers vérifiés en parallèle). Si inférieur à 2, alors le traitement de chaque fichier est exécuté dans le thread principal : utile pour faciliter le debogage. (default: 10)

  • -m MIN_FILES_MULTITHREAD, --min-files-threshold-for-multithread MIN_FILES_MULTITHREAD - Nombre minimal de fichiers pour paralléliser l’exécution. En deçà de ce seuil minimal, le multithread est désactivé. (default: 10)

  • --s3-url GPF_S3_URL - Url du storage S3 (default: http://localhost:9000)

  • --s3-key GPF_S3_KEY - Utilisateur du stockage S3 (default: admin)

  • --s3-secret-key GPF_S3_SECRETKEY - Password du stockage S3 (default: minioadmin)

  • --s3-region GPF_S3_REGION - Region du stockage S3 (default: eu-west-3)

Vérification des données vectorielles téléversées au regard des règles de la Géoplateforme.

Développé par Oslandia
Documentation : https://geoplateforme.pages.gpf-tech.ign.fr/scripts-verification/check-vector/

Exemple

gpf-vector-checker --workdir /mount/d/data/livraison/ --upload-dir-name upload --input-configuration-filename parameters.json -vv

Variables d’environnement

Génériques

Nom de la variable

Argument CLI correspondant

Valeur par défaut

GPF_INPUT_CONFIGURATION_FILENAME

--input-configuration-filename

parameters.json

GPF_UPLOAD_DIR

--upload-dir-name

upload

GPF_WORK_DIR

--work-dir-path

Spécifiques

Nom de la variable

Argument CLI correspondant

Valeur par défaut

GPF_AUTHORIZED_FILE_EXTENSION

--authorized-file-extension

geojson,csv,gpkg,shp,dbf,sql

GPF_RUN_THREADS

Nombre de threads à utiliser pour paralléliser l’exécution (nombre de fichiers vérifiés en parallèle). Si inférieur à 2, le téléchargement est exécuté dans le thread principal : utile pour faciliter le debogage.

10