Skip to content

Release v0.2.1: interactive outlet picker + example notebook #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rehsani merged 1 commit into from
May 7, 2026
Merged

Release v0.2.1: interactive outlet picker + example notebook #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,12 @@ It does **not** yet model:

The steady-state routing assumption is appropriate for small basins under intense storms; larger basins where peak attenuation along the channel matters will see biased-high peak Q and biased-high flood depths. If you need full physics, look at [LISFLOOD-FP](https://www.bristol.ac.uk/geography/research/hydrology/models/lisflood/), [HEC-RAS 2D](https://www.hec.usace.army.mil/software/hec-ras/), or [WFlow](https://github.com/Deltares/Wflow.jl).

### What's new in v0.2.1

- New optional module `floodpath.interactive` — ArcSWAT-style outlet picker on a leafmap widget. `pick_outlet(lat, lon)` shows a hillshaded DEM + Strahler-coloured stream network on a Carto Positron basemap; clicks auto-snap downstream to the nearest stream cell, the upstream basin is delineated and overlaid, and the marker is draggable for fine-tuning. Install via `pip install floodpath[interactive]`.
- New `floodpath.hydrology.snap_to_stream` helper underpins the picker; surfaces outside-DEM-bbox clicks as a clean `ValueError` so callers handle one branch.
- New end-to-end example notebook at [`examples/pick_outlet.ipynb`](examples/pick_outlet.ipynb), walking the full DEM → flow → streams → outlet → HAND → flood → population → damage chain at Kigali, Rwanda.

### What's new in v0.2

- New modules: `floodpath.landuse` (ESA WorldCover + Manning's roughness), `floodpath.soil` (SoilGrids 2.0 + NEH 630 Ch7 hydrologic soil group), `floodpath.precip` (uniform synthetic; pluggable for any user-supplied grid), `floodpath.runoff` (NEH 630 Ch9 SCS Curve Number + Ch10 SCS-CN equation), `floodpath.routing` (steady-state hydrologic + Manning hydraulic closure)
Expand Down
2 changes: 1 addition & 1 deletion floodpath/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
"""floodpath — modular Python pipeline for HAND-based flood inundation and damage estimation."""

__version__ = "0.2.0"
__version__ = "0.2.1"
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"

[project]
name = "floodpath"
version = "0.2.0"
version = "0.2.1"
description = "Modular Python pipeline for HAND-based flood inundation and damage estimation."
readme = "README.md"
requires-python = ">=3.10"
Expand Down
Loading