..  _reference.hydrology:

*********
Hydrology
*********

.. warning::

   NaN cells act as **impassable barriers** in all hydrology functions.
   Flow cannot cross them.  If your DEM has NaN holes (e.g. water bodies
   masked out), fill or interpolate them first, or expect disconnected
   drainage networks.

Flow Direction (D8)
===================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_direction_d8.flow_direction_d8

Flow Direction (D-infinity)
===========================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_direction_dinf.flow_direction_dinf

Flow Direction (MFD)
====================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_direction_mfd.flow_direction_mfd

Flow Accumulation (D8)
======================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_accumulation_d8.flow_accumulation_d8

Flow Accumulation (D-infinity)
===============================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_accumulation_dinf.flow_accumulation_dinf

Flow Accumulation (MFD)
=======================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_accumulation_mfd.flow_accumulation_mfd

Flow Length (D8)
================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_length_d8.flow_length_d8

Flow Length (D-infinity)
========================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_length_dinf.flow_length_dinf

Flow Length (MFD)
=================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_length_mfd.flow_length_mfd

Flow Path (D8)
==============
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_path_d8.flow_path_d8

Flow Path (D-infinity)
======================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_path_dinf.flow_path_dinf

Flow Path (MFD)
===============
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.flow_path_mfd.flow_path_mfd

Fill
====
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.fill_d8.fill_d8

Sink
====
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.sink_d8.sink_d8

Basin
=====
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.basin_d8.basin_d8

Watershed (D8)
==============
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.watershed_d8.watershed_d8
    xrspatial.hydro.watershed_d8.basins_d8

Watershed (D-infinity)
======================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.watershed_dinf.watershed_dinf

Watershed (MFD)
===============
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.watershed_mfd.watershed_mfd

Snap Pour Point
===============
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.snap_pour_point_d8.snap_pour_point_d8

Stream Link (D8)
================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_link_d8.stream_link_d8

Stream Link (D-infinity)
========================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_link_dinf.stream_link_dinf

Stream Link (MFD)
=================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_link_mfd.stream_link_mfd

Stream Order (D8)
=================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_order_d8.stream_order_d8

Stream Order (D-infinity)
=========================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_order_dinf.stream_order_dinf

Stream Order (MFD)
==================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.stream_order_mfd.stream_order_mfd

Height Above Nearest Drainage (D8)
===================================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.hand_d8.hand_d8

Height Above Nearest Drainage (D-infinity)
==========================================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.hand_dinf.hand_dinf

Height Above Nearest Drainage (MFD)
====================================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.hand_mfd.hand_mfd

Topographic Wetness Index (TWI)
===============================
.. autosummary::
    :toctree: _autosummary

    xrspatial.hydro.twi_d8.twi_d8