Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 82 additions & 40 deletions docs/source/reference/hydrology.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,164 +4,206 @@
Hydrology
*********

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

xrspatial.flow_direction.flow_direction
xrspatial.hydro.flow_direction_d8.flow_direction_d8

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

xrspatial.flow_direction_dinf.flow_direction_dinf
xrspatial.hydro.flow_direction_dinf.flow_direction_dinf

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

xrspatial.flow_direction_mfd.flow_direction_mfd
xrspatial.hydro.flow_direction_mfd.flow_direction_mfd

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

xrspatial.flow_accumulation.flow_accumulation
xrspatial.hydro.flow_accumulation_d8.flow_accumulation_d8

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

xrspatial.flow_accumulation_dinf.flow_accumulation_dinf
xrspatial.hydro.flow_accumulation_dinf.flow_accumulation_dinf

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

xrspatial.flow_accumulation_mfd.flow_accumulation_mfd
xrspatial.hydro.flow_accumulation_mfd.flow_accumulation_mfd

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

xrspatial.flow_length.flow_length
xrspatial.hydro.flow_length_d8.flow_length_d8

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

xrspatial.flow_length_dinf.flow_length_dinf
xrspatial.hydro.flow_length_dinf.flow_length_dinf

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

xrspatial.flow_length_mfd.flow_length_mfd
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
=========
Flow Path (MFD)
===============
.. autosummary::
:toctree: _autosummary

xrspatial.flow_path.flow_path
xrspatial.hydro.flow_path_mfd.flow_path_mfd

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

xrspatial.fill.fill
xrspatial.hydro.fill_d8.fill_d8

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

xrspatial.sink.sink
xrspatial.hydro.sink_d8.sink_d8

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

xrspatial.basin.basin
xrspatial.hydro.basin_d8.basin_d8

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

xrspatial.watershed.watershed
xrspatial.watershed.basins
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.snap_pour_point.snap_pour_point
xrspatial.hydro.snap_pour_point_d8.snap_pour_point_d8

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

xrspatial.stream_link.stream_link
xrspatial.hydro.stream_link_d8.stream_link_d8

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

xrspatial.stream_link_dinf.stream_link_dinf
xrspatial.hydro.stream_link_dinf.stream_link_dinf

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

xrspatial.stream_link_mfd.stream_link_mfd
xrspatial.hydro.stream_link_mfd.stream_link_mfd

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

xrspatial.stream_order.stream_order
xrspatial.hydro.stream_order_d8.stream_order_d8

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

xrspatial.stream_order_dinf.stream_order_dinf
xrspatial.hydro.stream_order_dinf.stream_order_dinf

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

xrspatial.stream_order_mfd.stream_order_mfd
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 (HAND)
=====================================
Height Above Nearest Drainage (MFD)
====================================
.. autosummary::
:toctree: _autosummary

xrspatial.hand.hand
xrspatial.hydro.hand_mfd.hand_mfd

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

xrspatial.twi.twi
xrspatial.hydro.twi_d8.twi_d8
4 changes: 2 additions & 2 deletions docs/source/reference/multispectral.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Atmospherically Resistant Vegetation Index (ARVI)

xrspatial.multispectral.arvi

Enhanced Built=Up and Bareness Index (EBBI)
===========================================
Enhanced Built-Up and Bareness Index (EBBI)
============================================
.. autosummary::
:toctree: _autosummary

Expand Down
Loading
Loading