.. pygeoflood documentation master file, created by
   sphinx-quickstart on Fri May 24 10:07:38 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pygeoflood
===========

**pygeoflood** is a new implementation of geonet and geoflood, which are topographic based channel extraction packages that delineate surface slope, curvature, flow direction, and flow accumulation in order to implement the heigh above nearest drainage (HAND) inundaiton mapping method.

This package is under active development as we build out additional methods to map compound flooding in near-real time.


.. toctree::
   :maxdepth: 2
   :caption: Contents:



Getting Started
###############

Background
##########

User Guide
##########

API Reference
#############

.. toctree::
   :maxdepth: 1

   apiref/apiref 

Examples
########

Issues, Questions, and Contributions
####################################

Acknowledgements
################



* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`