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.

View the source code on GitHub: https://github.com/passah2o/pygeoflood

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

Example workflows in python

• Example gallery
  • Fluvial flood inundation mapping quick start
  • Fluvial flood inundation mapping detailed workflow
  • Coastal flood inundation mapping workflow

Contributing

• Contributing bug reports and development

API Reference

• pygeoflood API reference

Acknowledgements

• Acknowledgements

• Index

• Module Index

• Search Page