Tutorials

This page collects hands-on floodsr walkthroughs.

Running Tutorials

To best use the tutorials, we recommend running them in a notebook environment:

• Download the notebook as an .ipynb file, save it to your local machine, and open it with your local Jupyter kernel. See Local notebook (Jupyter).

• Launch the same notebook directly in Google Colab for a browser-based interactive session. See Hosted notebook (Colab).

Alternatively, you can copy/paste the commands from the tutorials into your terminal. See Command line (CLI). If you are sanity-checking an environment before starting a tutorial, run floodsr --version first and floodsr doctor when you need backend diagnostics.

Select Tutorial 1 from the list below to get started.

• Tutorial 1: Quick Start
• Tutorial 2: Plotting and Advanced Options
• Tutorial 3: Large rasters