pygeoflood docs¶

pygeoflood is a suite of terrain-analysis tools for mapping flood inundation in near-real time.

This package is under active development as we incorporate efficient methods for mapping fluvial, pluvial, and coastal flooding.

Installation¶

We recommend installing pygeoflood into a conda environment. Python 3.10, 3.11, and 3.12 are currently supported:

pip install pygeoflood

For the bleeding-edge version, install from GitHub:

pip install git+https://github.com/passah2o/pygeoflood

If you plan to estimate pluvial flooding, install this fork of richdem, which provides Fill-Spill-Merge:

git clone https://github.com/mdp0023/richdem.git
cd richdem/wrappers/pyrichdem
pip install "setuptools<81" && pip install .