Skip to main content

Flood Risk Assessment Workflow for GR4H-Based Design Flood Analysis

Project description

pyfloodrisk

Flood Risk Assessment Workflow for GR4H-Based Design Flood Analysis.

pyfloodrisk is a Python port of an R-based design flood workflow built around the GR4H hourly rainfall-runoff model. It covers the full pipeline from streamflow calibration through to design flood simulation:

  • GR4H — hourly production/routing rainfall-runoff model (pyfloodrisk.gr4h).
  • Calibration — DREAM-based calibration against observed streamflow, plus an optional robust re-calibration step that re-ranks the behavioural posterior against design storm events (calibration, behavioural_posterior, robust_calibration).
  • Event delineation — baseflow separation and hydrologic event extraction (peaks-over-threshold or local maxima), used to derive antecedent model states ahead of each event (hydro_event_pipeline, extract_initial_states).
  • Design storms — builds design storms from temporal-pattern increment files (build_design_storm).
  • Design flood simulation — runs GR4H forward across design storm patterns and antecedent states to produce a design flood ensemble (simulate_design_flood, run_demo_workflow).

A small bundled demo dataset (climate data and design storm increments for two stations) lets the whole workflow run end-to-end without any external data.

Installation

pip install -e .

For running the test suite:

pip install -e ".[dev]"

Quickstart

from pyfloodrisk import run_demo_workflow

results = run_demo_workflow(station="421026")

Development

License

MIT — see LICENSE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyfloodrisk-0.1.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyfloodrisk-0.1.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file pyfloodrisk-0.1.0.tar.gz.

File metadata

  • Download URL: pyfloodrisk-0.1.0.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for pyfloodrisk-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cfd0a5519310cfedc0d3464dab35f7519a95ab1a13dc8188651900af25b242f8
MD5 91e4e15fdae8e5b9f64d548f6f63dfaa
BLAKE2b-256 bfc4bf4a92b47f3fb54e976b99496e22e6d081e934584e1c9ff8e060c83374e5

See more details on using hashes here.

File details

Details for the file pyfloodrisk-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: pyfloodrisk-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 1.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for pyfloodrisk-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 311317e58a39988ac307bc60a9c9b884fb3e133acfdc25adaa1b7d687e780892
MD5 252b87668c47fc93f10878df71bd6d0b
BLAKE2b-256 c073d9a20a207afde1ff987b667d2ac9d55f6cfee1686bb3ed7b19de30a0283a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page