Tutorial 1: Quick Start

This notebook mirrors the quick-start flow from the getting started guide.

Use the download button, then use browser Save As to download this notebook as an .ipynb file to your local machine and open it with your local Jupyter kernel. Install Jupyter from jupyter.org/install if needed.

Use the Colab launch button to open this tutorial on Google Colab.

What is floodsr?

floodsr is a flood-depth resolution enhancement tool. It takes a low-resolution depth raster and reconstructs a higher-resolution result using terrain context from a DEM.

Download test data

Before running commands, download a small example dataset into your current working directory.

!curl -L -O https://github.com/cefect/floodsr/releases/download/v0.0.3/hires002_dem.tif -O https://github.com/cefect/floodsr/releases/download/v0.0.3/lowres032.tif

Install floodsr

The recommended install path is pipx for environment isolation.

!pipx install floodsr

List available models

Before running inference, inspect the manifest to see which model versions are available.

!floodsr models list

Fetch model weights

Fetch the default model into the local cache.

!floodsr models fetch ResUNet_16x_DEM

Run tohr with fetched HRDEM data

If your low-resolution raster falls within HRDEM coverage, you can fetch the high-resolution DEM automatically.

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

Run tohr with a local DEM

If you already have a local DEM, point floodsr at it directly.

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

Next steps

For more detail, continue with User Guide or inspect the full CLI Reference.