Utilisation en ligne de commande¶

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

Fonctionnement général¶

Commandes et options¶

GPF Check RLT 1.5.0 -

gpf-check-rlt [-h] [-v] [--version] [-w GPF_WORK_DIR] [-c GPF_INPUT_CONFIGURATION_FILENAME]
              [--s3-url GPF_S3_URL] [--s3-key GPF_S3_KEY] [--s3-secret-key GPF_S3_SECRETKEY]
              [--s3-region GPF_S3_REGION] [--type-livraison GPF_RLT_LIVRAISON_TYPE]
              [-x GPF_RLT_AUTHORIZED_FILE_EXTENSION_RASTER]
              [--raster-filename-column GPF_RLT_RASTER_FILENAME_COLUMN]

gpf-check-rlt 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 GPF_WORK_DIR, --workdir GPF_WORK_DIR, --work-dir-path GPF_WORK_DIR - Input working directory. Must exist. (default: None)
-c GPF_INPUT_CONFIGURATION_FILENAME, --input-configuration-filename GPF_INPUT_CONFIGURATION_FILENAME - Name (not the path) of the input configuration file. (default: parameters.json)
--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)
--type-livraison GPF_RLT_LIVRAISON_TYPE - Type de livraison (PREFIX, GENERIC, AUTO) (default: AUTO)
-x GPF_RLT_AUTHORIZED_FILE_EXTENSION_RASTER, --raster-file-extensions GPF_RLT_AUTHORIZED_FILE_EXTENSION_RASTER, --authorized-raster-file-extensions GPF_RLT_AUTHORIZED_FILE_EXTENSION_RASTER - List of authorized raster file extensions as list of strings. Example: tif,tiff,jp2 (default: tif,tiff,jp2)
--raster-filename-column GPF_RLT_RASTER_FILENAME_COLUMN - Nom de la colonne contenant le nom de chaque fichier raster (default: JP2)

.

Développé par Quy Thy TRUONG
Documentation : https://geoplateforme.pages.gpf-tech.ign.fr/

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_WORK_DIR`	`--work-dir-path`
`GPF_S3_URL`	`--s3-url`	``
`GPF_S3_KEY`	`--s3-key`	`admin`
`GPF_S3_SECRETKEY`	`--s3-secret-key`	`minioadmin`
`GPF_S3_REGION`	`--s3-region`	`eu-west-3`

Spécifiques¶

Nom de la variable	Argument CLI correspondant	Valeur par défaut
`GPF_RLT_LIVRAISON_TYPE`	`--type-livraison`	`AUTO`
`GPF_RLT_AUTHORIZED_FILE_EXTENSION_RASTER`	`--raster-file-extensions`	`tif,tiff,jp2`
`GPF_RLT_RASTER_FILENAME_COLUMN`	`--raster-filename-column`	`JP2`