Fix pre-existing docs build errors (#1021)

- hydrology.rst: point autosummary entries to actual module paths
  (xrspatial.hydro.*.* instead of non-existent xrspatial.*.*)
- multispectral.rst: fix Built=Up typo to Built-Up
- multispectral.py: fix ndvi plot directive indentation
- emerging_hotspots.py: fix RST table indentation and add blank line
- zonal.py: fix crop example using zones_ids=[0] on terrain with no
  zeros; create a proper binary zone raster instead

Author: brendancol

docs/source/reference/hydrology.rst

@@ -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

docs/source/reference/multispectral.rst

@@ -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
 

xrspatial/emerging_hotspots.py

@@ -661,21 +661,22 @@ def emerging_hotspots(raster, kernel, boundary='nan'):
 
     Category codes
     --------------
-    ====  ============  ==================================
-    Code  Name          Rule
-    ====  ============  ==================================
-     1    New           Hot only at the final time step
-     2    Consecutive   Hot for final N consecutive steps
-                        (N>=2), never before
-     3    Intensifying  Hot >=90% incl. final, MK up
-     4    Persistent    Hot >=90% incl. final, MK flat
-     5    Diminishing   Hot >=90% incl. final, MK down
-     6    Sporadic      Hot at final, <90%, never cold
-     7    Oscillating   Hot at final, was cold at least once
-     8    Historical    Hot >=90% of steps, NOT at final
-    -1..-8              Cold spot mirrors of 1-8
-     0    No Pattern    None of the above
-    ====  ============  ==================================
+
+    ======  ============  ======================================
+    Code    Name          Rule
+    ======  ============  ======================================
+    1       New           Hot only at the final time step
+    2       Consecutive   Hot for final N consecutive steps
+                          (N>=2), never before
+    3       Intensifying  Hot >=90% incl. final, MK up
+    4       Persistent    Hot >=90% incl. final, MK flat
+    5       Diminishing   Hot >=90% incl. final, MK down
+    6       Sporadic      Hot at final, <90%, never cold
+    7       Oscillating   Hot at final, was cold at least once
+    8       Historical    Hot >=90% of steps, NOT at final
+    -1..-8                Cold spot mirrors of 1-8
+    0       No Pattern    None of the above
+    ======  ============  ======================================
     """
     if not isinstance(raster, xr.DataArray):
         raise TypeError("`raster` must be an xarray.DataArray")

xrspatial/multispectral.py

@@ -704,16 +704,17 @@ def ndvi(nir_agg: xr.DataArray,
     --------
     .. plot::
        :include-source:
-        >>> from xrspatial.datasets import get_data
-        >>> data = get_data('sentinel-2')  # Open Example Data
-        >>> nir = data['NIR']
-        >>> red = data['Red']
-        >>> from xrspatial.multispectral import ndvi
-        >>> # Generate NDVI Aggregate Array
-        >>> ndvi_agg = ndvi(nir_agg=nir, red_agg=red)
-        >>> nir.plot(aspect=2, size=4)
-        >>> red.plot(aspect=2, size=4)
-        >>> ndvi_agg.plot(aspect=2, size=4)
+
+       >>> from xrspatial.datasets import get_data
+       >>> data = get_data('sentinel-2')  # Open Example Data
+       >>> nir = data['NIR']
+       >>> red = data['Red']
+       >>> from xrspatial.multispectral import ndvi
+       >>> # Generate NDVI Aggregate Array
+       >>> ndvi_agg = ndvi(nir_agg=nir, red_agg=red)
+       >>> nir.plot(aspect=2, size=4)
+       >>> red.plot(aspect=2, size=4)
+       >>> ndvi_agg.plot(aspect=2, size=4)
 
     .. sourcecode:: python
 

xrspatial/zonal.py

@@ -2336,12 +2336,18 @@ def crop(
         terrain_agg = terrain_agg.rename({'x': 'lon', 'y': 'lat'})
         terrain_agg = terrain_agg.rename('Elevation')
 
-        # Crop Image
+        # Create a simple zone raster (0 = below median, 1 = above)
+        zones_agg = (terrain_agg > terrain_agg.median()).astype(int)
+        zones_agg.attrs = terrain_agg.attrs
+        zones_agg = zones_agg.rename('Zone')
+
+        # Crop to keep only the above-median zone
         values_agg = terrain_agg[0:300, 0:250]
+        zones_sub = zones_agg[0:300, 0:250]
         cropped_agg = crop(
-            zones=terrain_agg,
+            zones=zones_sub,
             values=values_agg,
-            zones_ids=[0],
+            zones_ids=[1],
         )
 
         # Edit Attributes