Installation

Installation#

L’installation express, probablement un peu trop simple :

pipx install floodsr

Installation de base#

floodsr existe en deux variantes :

  • installation de base : pour des rasters de moins ~2 milliards de pixels ou ~25 km² (en supposant une résolution cible de 1 m)

  • installation étendue : pour des rasters trop volumineux pour la mémoire vive. Si vous pensez en avoir besoin, passez directement à Installation étendue.

Comme floodsr est un simple paquet Python distribué sur PyPI, il peut être installé dans plusieurs contextes. Nous fournissons ici des instructions pour les trois plus courants :

Ligne de commande (CLI)#

Une interface de ligne de commande (CLI) consiste à exécuter des commandes dans un terminal plutôt que de cliquer dans une application graphique. floodsr a été conçu comme un paquet Python d’abord pensé pour la CLI, nous recommandons donc une installation avec pipx pour une isolation simple de l’environnement. Pour cela, il vous faut un Python 3.12+ fonctionnel et pip (généralement déjà fourni avec Python). Ensuite, installer pipx est simple :

python -m pip install --user pipx
python -m pipx ensurepath

Si un avertissement indique qu’il faut faire quelque chose pour que les modifications du chemin d’accès entrent en vigueur : PATH changes to take effect, suivez les instructions.

Installez ensuite floodsr avec pipx:

pipx install floodsr

Si vous voyez un message du type installed package floodsr, tout est prêt et vous devriez avoir accès à la ligne de commande floodsr, que vous pouvez utiliser pour valider l’installation. Commencez par la commande d’aide pour confirmer que la CLI fonctionne :

floodsr --help

Vous pouvez aussi essayer la commande doctor pour afficher l’environnement actuel et la configuration de floodsr :

floodsr doctor

Cela devrait montrer la version et l’état des moteurs utilisés par floodsr.

Carnet local (Jupyter)#

Exécuter floodsr dans un environnement de carnet local est une bonne façon de traiter des rasters individuels de manière interactive et de visualiser les résultats. Pour cela, il faut disposer de Jupyter dans un environnement Python 3.12+.

Vérifiez votre installation Python et Jupyter en exécutant ce qui suit dans un terminal :

python --version
python -m jupyter --version

Vous pouvez ensuite installer floodsr avec pip et lui associer un noyau Jupyter dédié :

python -m pip install floodsr ipykernel
python -m ipykernel install --user --name floodsr --display-name "Python (floodsr)"

Lancez ensuite Jupyter depuis cet environnement :

python -m jupyter lab

Note

Sinon, pour une installation rapide et simplifiée dans le cadre d’un usage ponctuel (pratique pour les tutoriels), vous pouvez exécuter ce qui suit depuis un noyau actif (c.-à-d. dans une cellule de carnet) :

%pip install floodsr

Mais cela peut produire des environnements incohérents et ce n’est pas recommandé pour un usage régulier.

Enfin, confirmez que la CLI est accessible depuis le carnet :

!floodsr doctor

Carnet hébergé (Colab)#

Google Colab est un environnement de carnets hébergés populaire qui fournit une interface web pratique avec des bibliothèques courantes déjà installées, ce qui le rend bien adapté aux expériences rapides ou aux tutoriels interactifs. En revanche, ajouter de nouveaux paquets (comme floodsr) peut être un peu délicat, donc ce n’est pas recommandé pour un usage régulier.

Pour configurer un carnet Colab pour floodsr, ouvrez Google Colab dans votre navigateur et connectez-vous avec votre compte Google. Créez ensuite un nouveau carnet et ajoutez ce qui suit dans la première cellule :

!python -m pip install -q floodsr

Enfin, confirmez que la CLI est accessible depuis le carnet :

!floodsr --help

Installation étendue#

Pour traiter des rasters trop volumineux pour la mémoire, floodsr utilise des moteurs GDAL. Pour activer ces fonctionnalités, installez floodsr dans un environnement avec GDAL. Le modèle téléchargé ResUNet_16x_DEM fonctionne dans cet environnement, et le modèle intégré CostGrow_Terrain nécessite en plus PCRaster dans ce même environnement.

Ligne de commande (CLI) - étendue#

Le gestionnaire de paquets conda est le moyen le plus simple de créer un environnement isolé avec GDAL. La meilleure façon d’installer conda est de passer par le projet open source Miniforge, et non par la distribution propriétaire Anaconda. Une fois conda installé, servez-vous-en pour créer un environnement dédié avec GDAL, l’activer, puis installer floodsr avec pip dans ce même environnement :

conda create -n floodsr-gdal -c conda-forge python=3.12 gdal -y
conda activate floodsr-gdal
python -m pip install floodsr

Si vous voulez le modèle CostGrow_Terrain, installez PCRaster dans ce même environnement :

conda install -n floodsr-gdal -c conda-forge pcraster -y

Confirmez ensuite que l’environnement avec GDAL est bien actif :

floodsr doctor

Vous devriez voir quelque chose comme gdal_config_installed=True. Si PCRaster est installé, floodsr doctor devrait aussi indiquer pcraster_installed=True. À ce stade, vous pouvez exécuter ResUNet_16x_DEM ou CostGrow_Terrain avec floodsr tohr.

Carnet local (Jupyter) - étendu#

Suivez les mêmes instructions que Ligne de commande (CLI) - étendue pour préparer votre environnement floodsr avec GDAL, puis installez Jupyter dans ce même environnement et enregistrez un noyau dédié :

conda activate floodsr-gdal # make sure you're in the GDAL-backed environment created above
python -m pip install jupyterlab ipykernel matplotlib
python -m ipykernel install --user --name floodsr-gdal --display-name "Python (floodsr-gdal)"

Lancez ensuite Jupyter depuis cet environnement et sélectionnez le noyau « Python (floodsr-gdal) » :

python -m jupyter lab

Enfin, confirmez depuis le carnet que l’environnement avec GDAL est actif :

!floodsr doctor

Carnet hébergé (Colab) - étendu#

Même si Colab est agréable pour les environnements standard, GDAL n’y est pas standard… donc la version étendue de floodsr avec GDAL est capricieuse et risque fort de ne pas fonctionner. Pour les plus téméraires, ce qui suit semble fonctionner en mars 2026, mais cela cassera probablement lorsque Colab mettra à jour ses images de base, donc ne perdez peut-être pas votre temps :

# setup an experimental GDAL environment in Colab
!apt-get update -qq
!apt-get install -y -qq gdal-bin libgdal-dev
!pip install -q --upgrade pip
!pip install -q "gdal[numpy]==$(gdal-config --version).*" rasterio geopandas pyproj shapely fiona

# install floodsr
!pip install -q floodsr

Désinstallation#

Utilisez la commande de désinstallation qui correspond à la fois à votre mode d’installation et à votre contexte d’exécution.

Désinstallation de base#

  • Ligne de commande (CLI) avec pipx :

pipx uninstall floodsr

  • Carnet local (Jupyter) avec pip dans l’environnement du noyau :

python -m pip uninstall floodsr
jupyter kernelspec uninstall floodsr

  • Carnet hébergé (Colab) avec pip dans l’environnement d’exécution :

!python -m pip uninstall -y floodsr

Désinstallation étendue#

  • Ligne de commande (CLI) ou carnet local (Jupyter) dans l’environnement conda floodsr-gdal :

conda deactivate
conda env remove -n floodsr-gdal

  • Carnet hébergé (Colab) : configuration expérimentale de GDAL :

# easiest cleanup is to restart the runtime
# Runtime > Restart session