Implement NoDataStrategy to deal with optional setup_functions

docs/changelog.rst

@@ -23,6 +23,7 @@ Fixed
 - **setup_config_output_timeseries**: bugfix for reducer.
 - update hydromt configuration files from ini to yml format. PR #230
 - remove or update calls to check if source in self.data_catalog `Issue #501 <https://github.com/Deltares/hydromt/issues/501>`_
+- Included NoDataStrategy from hydromt-core: setup functions for lakes, reservoirs, glaciers, and gauges are skipped when no data is found withing the model region (same behavior as before) PR #229
 
 Deprecated
 ----------

hydromt_wflow/wflow.py

@@ -1,4 +1,5 @@
 """Implement Wflow model class."""
+
 # Implement model class following model API
 
 import codecs
@@ -22,6 +23,7 @@
 from dask.diagnostics import ProgressBar
 from hydromt import flw
 from hydromt.models.model_grid import GridModel
+from hydromt.nodata import NoDataStrategy
 from pyflwdir import core_conversion, core_d8, core_ldd
 from shapely.geometry import box
 
@@ -1186,14 +1188,27 @@ def setup_gauges(
                 code = self.crs
             kwargs.update(crs=code)
             gdf_gauges = self.data_catalog.get_geodataframe(
-                gauges_fn, geom=self.basins, assert_gtype="Point", **kwargs
+                gauges_fn,
+                geom=self.basins,
+                assert_gtype="Point",
+                handle_nodata=NoDataStrategy.IGNORE,
+                **kwargs,
             )
         elif self.data_catalog[gauges_fn].data_type == "GeoDataFrame":
             gdf_gauges = self.data_catalog.get_geodataframe(
-                gauges_fn, geom=self.basins, assert_gtype="Point", **kwargs
+                gauges_fn,
+                geom=self.basins,
+                assert_gtype="Point",
+                handle_nodata=NoDataStrategy.IGNORE,
+                **kwargs,
             )
         elif self.data_catalog[gauges_fn].data_type == "GeoDataset":
-            da = self.data_catalog.get_geodataset(gauges_fn, geom=self.basins, **kwargs)
+            da = self.data_catalog.get_geodataset(
+                gauges_fn,
+                geom=self.basins,
+                handle_nodata=NoDataStrategy.IGNORE,
+                **kwargs,
+            )
             gdf_gauges = da.vector.to_gdf()
             # Check for point geometry
             if not np.all(np.isin(gdf_gauges.geometry.type, "Point")):
@@ -1208,10 +1223,9 @@ def setup_gauges(
         if basename is None:
             basename = os.path.basename(gauges_fn).split(".")[0].replace("_", "-")
 
-        # Create gauge map, subcatch map and update toml
-        if gdf_gauges.index.size == 0:
-            self.logger.warning(f"No {gauges_fn} gauge locations found within domain")
-
+        # Check if there is data found
+        if gdf_gauges is None:
+            self.logger.info("Skipping method, as no data has been found")
             return
 
         # Create the gauges map
@@ -1424,6 +1438,7 @@ def setup_lakes(
             lakes_fn, "lake", min_area, **kwargs
         )
         if ds_lakes is None:
+            self.logger.info("Skipping method, as no data has been found")
             return
         rmdict = {k: v for k, v in self._MAPS.items() if k in ds_lakes.data_vars}
         ds_lakes = ds_lakes.rename(rmdict)
@@ -1677,6 +1692,8 @@ def setup_reservoirs(
 
             for option in res_toml:
                 self.set_config(option, res_toml[option])
+        else:
+            self.logger.info("Skipping method, as no data has been found")
 
     def _setup_waterbodies(self, waterbodies_fn, wb_type, min_area=0.0, **kwargs):
         """Help with common workflow of setup_lakes and setup_reservoir.
@@ -1688,8 +1705,16 @@ def _setup_waterbodies(self, waterbodies_fn, wb_type, min_area=0.0, **kwargs):
         if "predicate" not in kwargs:
             kwargs.update(predicate="contains")
         gdf_org = self.data_catalog.get_geodataframe(
-            waterbodies_fn, geom=self.basins, **kwargs
+            waterbodies_fn,
+            geom=self.basins,
+            handle_nodata=NoDataStrategy.IGNORE,
+            **kwargs,
         )
+        if gdf_org is None:
+            # Return two times None (similair to main function output), if there is no
+            # data found
+            return None, None
+
         # skip small size waterbodies
         if "Area_avg" in gdf_org.columns and gdf_org.geometry.size > 0:
             min_area_m2 = min_area * 1e6
@@ -1859,8 +1884,16 @@ def setup_glaciers(self, glaciers_fn="rgi", min_area=1):
         # retrieve data for basin
         self.logger.info("Preparing glacier maps.")
         gdf_org = self.data_catalog.get_geodataframe(
-            glaciers_fn, geom=self.basins, predicate="intersects"
+            glaciers_fn,
+            geom=self.basins,
+            predicate="intersects",
+            handle_nodata=NoDataStrategy.IGNORE,
         )
+        # Check if there are glaciers found
+        if gdf_org is None:
+            self.logger.info("Skipping method, as no data has been found")
+            return
+
         # skip small size glacier
         if "AREA" in gdf_org.columns and gdf_org.geometry.size > 0:
             gdf_org = gdf_org[gdf_org["AREA"] >= min_area]

tests/conftest.py

@@ -1,4 +1,5 @@
 """add global fixtures."""
+
 import logging
 import platform
 from os.path import abspath, dirname, join
@@ -72,7 +73,7 @@ def example_wflow_results():
 @pytest.fixture()
 def clipped_wflow_model():
     root = join(EXAMPLEDIR, "wflow_piave_clip")
-    mod = WflowModel(root=root, mode="r")
+    mod = WflowModel(root=root, mode="r", data_libs="artifact_data")
     return mod
 
 

tests/test_model_methods.py

@@ -516,3 +516,18 @@ def test_setup_floodplains_2d(elevtn_map, example_wflow_model, floodplain1d_test
         .raster.mask_nodata()
         .equals(floodplain1d_testdata[f"{mapname}_D4"])
     )
+
+
+def test_skip_nodata_reservoir(clipped_wflow_model):
+    # Using the clipped_wflow_model as the reservoirs are not in this model
+    clipped_wflow_model.setup_reservoirs(
+        reservoirs_fn="hydro_reservoirs",
+        min_area=0.0,
+    )
+    assert clipped_wflow_model.config["model"]["reservoirs"] == False
+    # Get names for two reservoir layers
+    for mapname in ["resareas", "reslocs"]:
+        # Check if layers are indeed not present in the model
+        assert (
+            clipped_wflow_model._MAPS[mapname] not in clipped_wflow_model.grid.data_vars
+        )