Partially enable RHF v4.0 evaluation metrics, stability/typing fixes

AUTHORS.rst

@@ -19,4 +19,4 @@ Contributors
 ------------
 
 * Louise Arnal <[email protected]> `@lou-a <https://github.com/lou-a>`_
-* Pascal Bourgault <[email protected]> `@aulemahal <https://github.com/aulemaha>`_
+* Pascal Bourgault <[email protected]> `@aulemahal <https://github.com/aulemahal>`_

README.rst

@@ -15,7 +15,7 @@ RavenPy |logo|
 +----------------------------+-----------------------------------------------------+
 
 
-A Python wrapper to setup and run the hydrologic modelling framework Raven_.
+A Python wrapper for running the hydrologic modelling framework Raven_.
 
 * Free software: MIT license
 * Documentation: https://ravenpy.readthedocs.io

docs/conf.py

@@ -170,7 +170,7 @@ def rebuild_readme():
 # the built documents.
 #
 # The short X.Y version.
-version = ravenpy.__version__
+version = ravenpy.__version__.split("-")[0]
 # The full version, including alpha/beta/rc tags.
 release = ravenpy.__version__
 

src/ravenpy/__init__.py

@@ -1,4 +1,4 @@
-"""A Python wrapper to setup and run the hydrologic modelling framework Raven."""
+"""A Python wrapper for running the hydrologic modelling framework Raven."""
 
 ###################################################################################
 # MIT License

src/ravenpy/cli/aggregate_forcings_to_hrus.py

@@ -66,7 +66,7 @@ def aggregate_forcings_to_hrus(
     command will require.
     """
     # NOTE: This is in order to make sphinx-click happy. Magic. Do not touch.
-    import netCDF4 as nc4  # noqa: N813
+    import netCDF4
     import numpy as np
 
     gws = GridWeights.parse(Path(input_weight_file).read_text())
@@ -76,7 +76,7 @@ def aggregate_forcings_to_hrus(
     weights_data = gws.data
 
     # read NetCDF
-    nc_in = nc4.Dataset(input_nc_file, "r")
+    nc_in = netCDF4.Dataset(input_nc_file, "r")
 
     # length of dimensions
     nlon = nc_in.dimensions[dim_names[0]].size
@@ -107,7 +107,7 @@ def aggregate_forcings_to_hrus(
     else:
         output_nc_file_path = Path(output_nc_file)
 
-    nc_out = nc4.Dataset(output_nc_file_path, "w")
+    nc_out = netCDF4.Dataset(output_nc_file_path, "w")
     _ = nc_out.createDimension("time", ntime)
     _ = nc_out.createDimension("nHRU", nHRU)
 

src/ravenpy/config/base.py

@@ -320,7 +320,7 @@ def parse_symbolic(value, **kwds):
     Note that parsing the output of `model_dump` can cause problems because there is not always enough information in the
     dictionary to recreate the correct model.
     """
-    from pymbolic.mapper.evaluator import EvaluationMapper as EM  # noqa: N817
+    from pymbolic.mapper.evaluator import EvaluationMapper
     from pymbolic.primitives import ExpressionNode, Variable
 
     if isinstance(value, dict):
@@ -337,7 +337,7 @@ def parse_symbolic(value, **kwds):
 
     elif isinstance(value, (Variable, ExpressionNode)):
         # Inject numerical values numerical value
-        return EM(context=kwds)(value)
+        return EvaluationMapper(context=kwds)(value)
 
     else:
         return value

src/ravenpy/config/commands.py

@@ -166,8 +166,8 @@ class EvaluationPeriod(LineCommand):
     """
 
     name: str
-    start: dt.date
-    end: dt.date
+    start: Union[str, dt.date]
+    end: Union[str, dt.date]
 
 
 class CustomOutput(LineCommand):
@@ -427,8 +427,8 @@ class ChannelProfile(FlatCommand):
 
     name: str = "chn_XXX"
     bed_slope: float = 0
-    survey_points: tuple[tuple[float, float], ...] = ()
-    roughness_zones: tuple[tuple[float, float], ...] = ()
+    survey_points: list[tuple[Union[int, float], Union[int, float]]] = ()
+    roughness_zones: list[tuple[Union[int, float], Union[int, float]]] = ()
 
     def to_rv(self):
         template = """

src/ravenpy/config/defaults.py

@@ -47,8 +47,8 @@
 
 def nc_attrs(cls, val):
     """Ensure default netCDF attributes are present."""
-    # FIXME: assertions should not be found outside of testing code. Replace with conditional logic.
-    assert "model_id" in val  # noqa: S101
+    if "model_id" not in val:
+        raise ValueError("The key 'model_id' must be present in the input dictionary.")
 
     out = default_nc_attrs()
     out.update(val)

src/ravenpy/config/emulators/gr4jcn.py

@@ -131,7 +131,7 @@ class GR4JCN(Config):
             p.Split(
                 algo="RAVEN_DEFAULT",
                 source="SOIL[2]",
-                to=["CONVOLUTION[0]", "CONVOLUTION[1]"],
+                to=("CONVOLUTION[0]", "CONVOLUTION[1]"),
                 p=0.9,
             ),
             p.Convolve(algo="CONVOL_GR4J_1", source="CONVOLUTION[0]", to="SOIL[1]"),