Tutoriel 1 : prise en main

Tutoriel 1 : prise en main#

Ce carnet reprend le parcours de prise en main présenté dans le guide de démarrage.

Qu’est-ce que floodsr ?#

floodsr est un outil d’amélioration de résolution pour les rasters de profondeur d’inondation. Il prend un raster de profondeur à basse résolution et reconstruit un résultat à plus haute résolution à l’aide du contexte topographique fourni par un DEM.

Utiliser ce tutoriel#

Il existe trois façons courantes d’exécuter ce tutoriel (autrement dit, trois contextes d’exécution) :

  • interface de ligne de commande (CLI) : copiez-collez les commandes ci-dessous depuis votre navigateur web dans votre terminal. REMARQUE : dans la plupart des terminaux, il faudra retirer le préfixe ! de chaque commande.

  • carnet local (Jupyter) : utilisez le bouton pour enregistrer ce carnet comme fichier .ipynb sur votre machine (il faut parfois cliquer sur enregistrer sous), puis ouvrez-le avec votre noyau Jupyter local. Voir Carnet local (Jupyter) pour plus de détails.

  • carnet hébergé (Colab) : utilisez le bouton pour ouvrir ce tutoriel dans Google Colab.

Installer floodsr#

Pas de panique : l’installation est très simple.

Les étapes d’installation adaptées dépendent de votre contexte d’exécution, décrit en détail dans Installation de base. Voici le minimum à faire dans chaque cas :

  • interface de ligne de commande (CLI) : commencez par vérifier que pipx est installé et disponible dans le PATH, puis exécutez pipx install floodsr. Consultez Ligne de commande (CLI) pour plus de détails.

  • carnet local (Jupyter) : même chose. Ensuite, soit vous suivez les étapes supplémentaires de Carnet local (Jupyter) pour configurer proprement votre environnement, soit vous faites au plus simple et vous décommentez la cellule Jupyter ci-dessous avant de l’exécuter.

  • carnet hébergé (Colab) : décommentez la cellule Colab ci-dessous et exécutez-la. Voir Carnet hébergé (Colab) pour les détails.

installation via l’interface de ligne de commande (CLI) : exécutez pipx install floodsr dans votre terminal

Installation rapide dans un carnet local (Jupyter)

# %pip install -q floodsr

Installation dans un carnet hébergé (Colab)

# !python -m pip install -q floodsr

Vérifier l’installation#

Exécutez la commande ci-dessous pour confirmer que l’installation a réussi et que floodsr est bien disponible dans votre PATH :

!floodsr --help

Télécharger les données de test#

Avant d’exécuter les commandes, téléchargez un petit jeu de données d’exemple dans votre répertoire de travail courant.

from urllib.request import urlretrieve

urlretrieve(
    "https://github.com/cefect/floodsr/releases/download/v0.0.3/hires002_dem.tif",
    "hires002_dem.tif",
)
urlretrieve(
    "https://github.com/cefect/floodsr/releases/download/v0.0.3/lowres032.tif",
    "lowres032.tif",
)

('lowres032.tif', <http.client.HTTPMessage at 0x7470adcd5940>)

Lister les modèles disponibles#

Avant de lancer l’inférence, consultez le manifeste pour voir quelles versions de modèle sont disponibles.

!floodsr models list

CostGrow_Terrain	(built-in, no download)	Rules-based terrain-penalty CostGrow method (fluvial only)
ResUNet_16x_DEM	model_infer.onnx	https://github.com/cefect/floodsr/releases/download/v2026.02.19/model_infer.onnx

Récupérer les poids du modèle#

Téléchargez le modèle par défaut dans le cache local.

!floodsr models fetch --no-progress ResUNet_16x_DEM

version=ResUNet_16x_DEM stored=/tmp/.cache/floodsr/ResUNet_16x_DEM/model_infer.onnx retrieved_from=cache

Exécuter tohr avec un DEM local#

Lançons maintenant la commande to high resolution tohr pour améliorer la résolution de notre raster de profondeur basse résolution à l’aide du DEM haute résolution.

!floodsr tohr --in lowres032.tif --dem hires002_dem.tif

Si vous regardez dans votre répertoire de travail, vous devriez voir un nouveau fichier nommé lowres032_sr.tif. C’est la sortie de la commande tohr, et sa résolution devrait correspondre à celle du DEM (2 m dans ce cas). Comme nous n’avons pas précisé de chemin de sortie, floodsr a écrit la sortie par défaut dans le même répertoire que l’entrée, en ajoutant _sr au nom du fichier.

Hourra ! Vous venez d’exécuter votre première commande floodsr. Vous méritez bien un peu de 🍰.

Exécuter tohr avec des données HRDEM récupérées#

Passer --fetch-hrdem indique à tohr d’essayer de récupérer les données HRDEM correspondant à l’emprise de votre raster. Bien sûr, cela ne fonctionnera que si cette emprise chevauche la zone de couverture des données HRDEM. Sinon, vous obtiendrez une erreur.

!floodsr tohr --in lowres032.tif --fetch-hrdem

Suite#

Pour aller plus loin dans votre parcours vers la haute résolution, c’est un bon moment pour consulter :

  • le Guide d’utilisation pour une présentation plus détaillée des étapes et concepts ci-dessus.

  • la Référence CLI pour une référence détaillée de toutes les commandes et options disponibles.

Ou poursuivez avec le tutoriel suivant.