Skip to content

Tutorials

Short, progressive, runnable tutorials for the euroflood library. They read the published index (zero config — pip install "euroflood[viz]" and go) and follow one place throughout: Zutphen, a Hanseatic town on the river IJssel in the Netherlands, whose recurrent high-water flooding makes for a rich, interesting catalogue.

  • Quickstart

    1. Quickstart

    The whole idea in a few lines: query → .plot(), straight from the index.

  • Discover & filter

    2. Discover & filter

    Query by place / bbox / point / shape; filter by time; it's a GeoDataFrame.

  • Visualize

    3. Visualize

    Recurrence heatmaps, per-event footprints, and interactive folium maps.

  • Download & measure

    4. Download & measure

    .download() → depth rasters → DepthRaster / .stats() / .summary().

  • Hazard

    5. Hazard

    Modelled GLOFAS flood-hazard maps by return period (static + interactive).

  • Quantitative analysis

    6. Quantitative analysis

    Rank events, estimate exposure, compare depths across events.

  • CLI & configuration

    7. CLI & configuration

    The euroflood command line, every setting, and offline / HPC use.

Run them yourself

pip install "euroflood[viz]"
jupyter lab examples/             # open the .ipynb, or:
python examples/01_quickstart.py  # the paired .py runs top-to-bottom as a script

Each tutorial is a jupytext pair — the .py is the readable source of truth, paired to a .ipynb with rich outputs.

For maintainers

The .py and .ipynb are kept in sync by the jupytext pre-commit hook (jupytext --sync). The cheap-path tutorials (01, 02, 03, 07) are executed offline against the committed tests/fixtures/realdata/index/ bundle on every PR; the download-dependent ones (04, 05, 06) run in the nightly live workflow. See .github/workflows/examples.yml. Regenerate the docs hero/figure images + these thumbnails with python scripts/make_doc_images.py.