HydPy 6.1.2__tar.gz → 6.1.4__tar.gz

{hydpy-6.1.2 → hydpy-6.1.4/HydPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: HydPy
-Version: 6.1.2
+Version: 6.1.4
 Summary: A framework for the development and application of hydrological models.
 Home-page: https://github.com/hydpy-dev/hydpy
 Author: HydPy Developers
@@ -44,6 +44,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{hydpy-6.1.2/HydPy.egg-info → hydpy-6.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: HydPy
-Version: 6.1.2
+Version: 6.1.4
 Summary: A framework for the development and application of hydrological models.
 Home-page: https://github.com/hydpy-dev/hydpy
 Author: HydPy Developers
@@ -44,6 +44,7 @@ Dynamic: description
 Dynamic: home-page
 Dynamic: keywords
 Dynamic: license
+Dynamic: license-file
 Dynamic: requires-dist
 Dynamic: requires-python
 Dynamic: summary

{hydpy-6.1.2 → hydpy-6.1.4}/appveyor.yml

@@ -1,5 +1,5 @@
 
-version: 6.1.2.{build}
+version: 6.1.4.{build}
 
 image: Visual Studio 2019
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/__init__.py

@@ -118,7 +118,7 @@ from hydpy.exe.servertools import await_server, start_server
 from hydpy.exe.xmltools import XMLInterface, run_simulation, xml_validate
 
 
-__version__ = "6.1.2"
+__version__ = "6.1.4"
 
 pub.options = optiontools.Options()
 pub.indexer = indextools.Indexer()

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/aliases.py

@@ -1,4 +1,4 @@
-"""This module provides the aliases of the sequences of all available models one might 
+"""This module provides the aliases of the sequences of all available models one might
 want to connect to node sequences.
 
 This file was automatically created by function |write_sequencealiases|.

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/auxs/calibtools.py

@@ -1178,11 +1178,11 @@ class CalibrationInterface(Generic[TypeRule1]):
         selections=("complete",),
     )
 
-    >>> ci.FC
+    >>> ci.FC  # doctest: +ELLIPSIS
     Traceback (most recent call last):
     ...
     AttributeError: The actual calibration interface does neither handle a normal \
-attribute nor a rule object named `FC`.
+attribute nor a rule object named `FC`...
 
     >>> ci["damp"]
     Replace(

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/core/auxfiletools.py

@@ -194,7 +194,7 @@ nor does it handle a model named `lland_dd`...
 
     @staticmethod
     def _get_model(
-        value: Union[str, types.ModuleType, modeltools.Model]
+        value: Union[str, types.ModuleType, modeltools.Model],
     ) -> modeltools.Model:
         if isinstance(value, modeltools.Model):
             return value

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/core/devicetools.py

@@ -2476,7 +2476,7 @@ Attribute timegrids of module `pub` is not defined at the moment.
         t = TypeVar("t", str, int)
 
         def _make_tuple(
-            x: Union[Optional[t], tuple[Optional[t], Optional[t]]]
+            x: Union[Optional[t], tuple[Optional[t], Optional[t]]],
         ) -> tuple[Optional[t], Optional[t]]:
             return (x, x) if ((x is None) or isinstance(x, (str, int))) else x
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/core/importtools.py

@@ -400,7 +400,9 @@ def prepare_submodel(
     instance."""
 
     def _prepare_submodel(
-        wrapped: Union[PrepSub0D[TM_contra, TI_contra], PrepSub1D[TM_contra, TI_contra]]
+        wrapped: Union[
+            PrepSub0D[TM_contra, TI_contra], PrepSub1D[TM_contra, TI_contra]
+        ],
     ) -> SubmodelAdder[TD, TM_contra, TI_contra]:
         return SubmodelAdder[TD, TM_contra, TI_contra](
             wrapped=cast(Any, wrapped),
@@ -684,16 +686,16 @@ following error occurred: The given `lland_knauf` instance is not considered sha
 
     @overload
     def get_wrapped(
-        self: SubmodelAdder[Literal[0], TM_contra, TI_contra]
+        self: SubmodelAdder[Literal[0], TM_contra, TI_contra],
     ) -> PrepSub0D[TM_contra, TI_contra]: ...
 
     @overload
     def get_wrapped(
-        self: SubmodelAdder[Literal[1], TM_contra, TI_contra]
+        self: SubmodelAdder[Literal[1], TM_contra, TI_contra],
     ) -> PrepSub1D[TM_contra, TI_contra]: ...
 
     def get_wrapped(
-        self: SubmodelAdder[TD, TM_contra, TI_contra]
+        self: SubmodelAdder[TD, TM_contra, TI_contra],
     ) -> Union[PrepSub0D[TM_contra, TI_contra], PrepSub1D[TM_contra, TI_contra]]:
         """Return the wrapped, model-specific method for automatically preparing some
         control parameters."""
@@ -942,7 +944,7 @@ def define_targetparameter(
     instance."""
 
     def _select_parameter(
-        wrapped: Callable[Concatenate[TM_contra, P], None]
+        wrapped: Callable[Concatenate[TM_contra, P], None],
     ) -> TargetParameterUpdater[TM_contra, P]:
         return TargetParameterUpdater[TM_contra, P](wrapped, parameter)
 
@@ -1009,11 +1011,11 @@ class TargetParameterUpdater(_DoctestAdder, Generic[TM_contra, P]):
     already available parameter values in the |TargetParameterUpdater.values_test|
     dictionary.
     """
-    values_orig: dict[modeltools.Model, tuple[tuple[P.args, P.kwargs], Any]]
+    values_orig: dict[modeltools.Model, tuple[tuple[Any, Any], Any]]
     """Deep copies of the input data (separated by positional and keyword arguments) 
     and the resulting values of the target parameters of the respective model 
     instances."""
-    values_test: dict[modeltools.Model, tuple[tuple[P.args, P.kwargs], Any]]
+    values_test: dict[modeltools.Model, tuple[tuple[Any, Any], Any]]
     """Deep copies of the input data (separated by positional and keyword arguments) 
     and the already available values of the target parameters of the respective model 
     instances."""
@@ -1043,17 +1045,19 @@ class TargetParameterUpdater(_DoctestAdder, Generic[TM_contra, P]):
 
     def __call__(self, *args: P.args, **kwargs: P.kwargs) -> None:
         assert (model := self._model) is not None
+        args = copy.deepcopy(args)
+        kwargs = copy.deepcopy(kwargs)
         model.preparemethod2arguments[self._wrapped.__name__] = args, kwargs
         control = model.parameters.control
         if self.testmode:
             if (name := self.targetparameter.name) in control.names:
                 par = control[name]
-                self.values_test[model] = copy.deepcopy(((args, kwargs), par.value))
+                self.values_test[model] = ((args, kwargs), copy.deepcopy(par.value))
         else:
             if (name := self.targetparameter.name) in control.names:
                 self._wrapped(model, *args, **kwargs)
                 par = control[name]
-                self.values_orig[model] = copy.deepcopy(((args, kwargs), par.value))
+                self.values_orig[model] = ((args, kwargs), copy.deepcopy(par.value))
 
 
 def simulationstep(timestep: timetools.PeriodConstrArg) -> None:

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/core/netcdftools.py

@@ -2096,7 +2096,7 @@ named `lland_dd` nor does it define a member named `lland_dd`.
 
     @staticmethod
     def _yield_disksequences(
-        deviceorder: Iterable[Union[devicetools.Node, devicetools.Element]]
+        deviceorder: Iterable[Union[devicetools.Node, devicetools.Element]],
     ) -> Iterator[sequencetools.IOSequence]:
         for device in deviceorder:
             if isinstance(device, devicetools.Node):

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/core/variabletools.py

@@ -2286,12 +2286,12 @@ def sort_variables(
 
 @overload
 def sort_variables(
-    values: Iterable[tuple[type[TypeVariable_co], T]]
+    values: Iterable[tuple[type[TypeVariable_co], T]],
 ) -> tuple[tuple[type[TypeVariable_co], T], ...]: ...
 
 
 def sort_variables(
-    values: Iterable[Union[type[TypeVariable], tuple[type[TypeVariable], T]]]
+    values: Iterable[Union[type[TypeVariable], tuple[type[TypeVariable], T]]],
 ) -> tuple[Union[type[TypeVariable], tuple[type[TypeVariable], T]], ...]:
     """Sort the given |Variable| subclasses by their initialisation order.
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/cythons/autogen/c_musk.pyx

@@ -440,7 +440,7 @@ cdef class Model:
             est = self.sequences.old_states.discharge[i + 1] + self.sequences.new_states.discharge[i] - self.sequences.old_states.discharge[i]
         else:
             est = self.sequences.new_states.discharge[i + 1]
-        self.sequences.fluxes.referencedischarge[i] = (self.sequences.new_states.discharge[i] + est) / 2.0
+        self.sequences.fluxes.referencedischarge[i] = max((self.sequences.new_states.discharge[i] + est) / 2.0, 0.0)
     cpdef inline void calc_referencewaterdepth_v1(self) noexcept nogil:
         cdef double tol_q
         cdef double mx
@@ -533,7 +533,7 @@ cdef class Model:
             est = self.sequences.old_states.discharge[i + 1] + self.sequences.new_states.discharge[i] - self.sequences.old_states.discharge[i]
         else:
             est = self.sequences.new_states.discharge[i + 1]
-        self.sequences.fluxes.referencedischarge[i] = (self.sequences.new_states.discharge[i] + est) / 2.0
+        self.sequences.fluxes.referencedischarge[i] = max((self.sequences.new_states.discharge[i] + est) / 2.0, 0.0)
     cpdef inline void calc_referencewaterdepth(self) noexcept nogil:
         cdef double tol_q
         cdef double mx

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/cythons/autogen/c_musk_mct.pyx

@@ -436,7 +436,7 @@ cdef class Model:
             est = self.sequences.old_states.discharge[i + 1] + self.sequences.new_states.discharge[i] - self.sequences.old_states.discharge[i]
         else:
             est = self.sequences.new_states.discharge[i + 1]
-        self.sequences.fluxes.referencedischarge[i] = (self.sequences.new_states.discharge[i] + est) / 2.0
+        self.sequences.fluxes.referencedischarge[i] = max((self.sequences.new_states.discharge[i] + est) / 2.0, 0.0)
     cpdef inline void calc_referencewaterdepth_v1(self) noexcept nogil:
         cdef double tol_q
         cdef double mx
@@ -529,7 +529,7 @@ cdef class Model:
             est = self.sequences.old_states.discharge[i + 1] + self.sequences.new_states.discharge[i] - self.sequences.old_states.discharge[i]
         else:
             est = self.sequences.new_states.discharge[i + 1]
-        self.sequences.fluxes.referencedischarge[i] = (self.sequences.new_states.discharge[i] + est) / 2.0
+        self.sequences.fluxes.referencedischarge[i] = max((self.sequences.new_states.discharge[i] + est) / 2.0, 0.0)
     cpdef inline void calc_referencewaterdepth(self) noexcept nogil:
         cdef double tol_q
         cdef double mx

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/cythons/modelutils.py

@@ -454,7 +454,7 @@ def get_methodheader(
 
 
 def decorate_method(
-    wrapped: Callable[[PyxWriter], Iterator[str]]
+    wrapped: Callable[[PyxWriter], Iterator[str]],
 ) -> Callable[[PyxWriter, PyxPxdLines], None]:
     """The decorated method returns a |Lines| object including a method header.
     However, the |Lines| object is empty if the respective model does not implement a

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/docs/draw_model_sketches.py

@@ -540,7 +540,7 @@ class Glacier(Element):
         )
         self.draw_text(
             frame=frame,
-            text="\u221E",
+            text="\u221e",
             point=Point(0.5, TOL),
             properties=TextProperties(),
         )

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/docs/sphinx/conf.py

@@ -202,7 +202,7 @@ copyright = f"2013-{datetime.datetime.now().year}, HydPy Developers"
 # The short X.Y version.
 version = "6.1"
 # The full version, including alpha/beta/rc tags.
-release = "6.1.2"
+release = "6.1.4"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/exe/servertools.py

@@ -1769,7 +1769,7 @@ method `evaluate` if you have started the `HydPy Server` in debugging mode.
 
     @staticmethod
     def _array2output(
-        values: Union[float, VectorInputObject, MatrixInputObject]
+        values: Union[float, VectorInputObject, MatrixInputObject],
     ) -> str:
         # duck-typing for simplicity:
         try:

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/exch/exch_factors.py

@@ -6,9 +6,7 @@ from hydpy.core import sequencetools
 from hydpy.core import variabletools
 
 
-class WaterLevels(  # type: ignore[misc]
-    variabletools.MixinFixedShape, sequencetools.FactorSequence
-):
+class WaterLevels(variabletools.MixinFixedShape, sequencetools.FactorSequence):
     """The water level at two locations [m].
 
     After each simulation step, the value of |exch_factors.WaterLevels| corresponds to

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/ga_garto.py

@@ -542,7 +542,7 @@ There is no indication of an error in the water balance:
 ________________________
 
 In this and the following subsection, we deal with more complex series of rainfall
-events spanning 24 hours: 
+events spanning 24 hours:
 
 >>> pub.timegrids = pub.timegrids.init
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/hland/hland_model.py

@@ -4567,7 +4567,7 @@ class Main_AETModel_V1(modeltools.AdHocModel):
         prepare_elevations: [300. 300. 300. 300. 300.]
         prepare_maxsoilwater: [200. 200. 200. 200. 200.]
         prepare_water: [False False  True False False]
-        prepare_interception: [ True  True False False False]
+        prepare_interception: [ True  True False False  True]
         prepare_plant: [ True  True False False False]
         prepare_soil: [ True  True False False False]
 
@@ -4596,8 +4596,8 @@ class Main_AETModel_V1(modeltools.AdHocModel):
         sel = ~sel
         sel[zonetype == GLACIER] = False
         aetmodel.prepare_interception(sel)
-        aetmodel.prepare_plant(sel)
         sel[zonetype == SEALED] = False
+        aetmodel.prepare_plant(sel)
         aetmodel.prepare_soil(sel)
 
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/lland/lland_model.py

@@ -7532,11 +7532,11 @@ glets=1.1)
         prepare_leafareaindex: [[1. 1. 1. 1. 1. 1. 1. 1. 1. 1. 1. 1.]
         ...
         prepare_maxsoilwater: [50. 50. 50. 50. 50. 50. 50. 50. 50.]
-        prepare_water: [False False False  True  True  True  True  True  True]
+        prepare_water: [False False False False  True  True  True False False]
         prepare_interception: [ True  True  True  True False False False  True  True]
         prepare_soil: [ True  True  True False False False False  True  True]
         prepare_plant: [ True  True  True False False False False False False]
-        prepare_conifer: [False  True  True False False False False False False]
+        prepare_conifer: [False False  True False False False False False False]
         prepare_tree: [False  True  True False False False False False False]
 
         >>> model.aetmodel.parameters.control.leafareaindex.acker_jan

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/meteo_glob_fao56.py

@@ -44,8 +44,8 @@ connected to the prepared nodes:
 daily simulation
 ________________
 
-The first example deals with a daily simulation time step.  We calculate the radiation 
-terms on 6 July in Uccle (Brussels, Belgium) and take all input data from example 18 of 
+The first example deals with a daily simulation time step.  We calculate the radiation
+terms on 6 July in Uccle (Brussels, Belgium) and take all input data from example 18 of
 :cite:t:`ref-Allen1998`:
 
 >>> from hydpy import IntegrationTest, pub, round_
@@ -87,8 +87,8 @@ All getters specified by the |RadiationModel_V1| interface return the correct da
 hourly simulation
 _________________
 
-The second example deals with an hourly simulation over multiple time steps.  We 
-calculate the different radiation terms from 30 September to 1 October in N'Diaye 
+The second example deals with an hourly simulation over multiple time steps.  We
+calculate the different radiation terms from 30 September to 1 October in N'Diaye
 (Senegal) and take (or try to derive as well as possible) all parameter and input
 values from example 19 of :cite:t:`ref-Allen1998`.
 

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/musk/musk_model.py

@@ -185,6 +185,17 @@ class Calc_ReferenceDischarge_V1(modeltools.Method):
         >>> model.calc_referencedischarge_v1()
         >>> fluxes.referencedischarge
         referencedischarge(4.5)
+
+        The given basic equation can result in negative reference discharge estimates
+        during severe low-flow conditions.  |Calc_ReferenceDischarge_V1| resets those
+        to zero:
+
+        >>> model.idx_run = 0
+        >>> states.discharge.old = 0.6, 0.1
+        >>> states.discharge.new = 0.2, nan
+        >>> model.calc_referencedischarge_v1()
+        >>> fluxes.referencedischarge
+        referencedischarge(0.0)
     """
 
     REQUIREDSEQUENCES = (musk_states.Discharge,)
@@ -200,7 +211,7 @@ class Calc_ReferenceDischarge_V1(modeltools.Method):
             est: float = old.discharge[i + 1] + new.discharge[i] - old.discharge[i]
         else:
             est = new.discharge[i + 1]
-        flu.referencedischarge[i] = (new.discharge[i] + est) / 2.0
+        flu.referencedischarge[i] = max((new.discharge[i] + est) / 2.0, 0.0)
 
 
 class Return_Discharge_CrossSectionModel_V1(modeltools.Method):

{hydpy-6.1.2 → hydpy-6.1.4}/hydpy/models/wland/wland_model.py

@@ -3467,8 +3467,13 @@ class Main_PETModel_V1(modeltools.ELSModel):
         ...     nmbhru
         ...     hruarea
         ...     evapotranspirationfactor(field=1.0, trees=2.0, water=1.5)
+        ...     for method, arguments in model.preparemethod2arguments.items():
+        ...         print(method, arguments[0][0], sep=": ")
         nmbhru(3)
         hruarea(5.0, 3.0, 2.0)
+        prepare_nmbzones: 3
+        prepare_zonetypes: [13 19 23]
+        prepare_subareas: [5. 3. 2.]
 
         >>> etf = model.petmodel.parameters.control.evapotranspirationfactor
         >>> etf
@@ -3546,6 +3551,8 @@ class Main_PETModel_V2(modeltools.ELSModel):
         ...     groundalbedo(conifer=0.05, decidious=0.1, field=0.15, mixed=0.2,
         ...                  orchard=0.25, pasture=0.3, sealed=0.35, soil=0.4,
         ...                  trees=0.45, water=0.5, wetland=0.55, wine=0.6)
+        ...     for method, arguments in model.preparemethod2arguments.items():
+        ...         print(method, arguments[0][0], sep=": ")  # doctest: +ELLIPSIS
         nmbhru(12)
         hrutype(SEALED, FIELD, WINE, ORCHARD, SOIL, PASTURE, WETLAND, TREES,
                 CONIFER, DECIDIOUS, MIXED, WATER)
@@ -3565,6 +3572,21 @@ class Main_PETModel_V2(modeltools.ELSModel):
         ((12,), {})
         ((array([0.06, 0.2 , 0.34, 0.48, 0.62, 0.76, 0.9 , 1.04, 1.18, 1.32, 1.46,
                1.64]),), {})
+        prepare_nmbzones: 12
+        prepare_zonetypes: [12 13 14 15 16 17 18 19 20 21 22 23]
+        prepare_subareas: [0.06 0.2  0.34 0.48 0.62 0.76 0.9  1.04 1.18 1.32 1.46 1.64]
+        prepare_leafareaindex: [[1. 1. 1. 1. 1. 1. 1. 1. 1. 1. 1. 1.]
+        ...
+        prepare_water: [False False False False False False False False False False \
+False  True]
+        prepare_interception: [ True  True  True  True  True  True  True  True  True  \
+True  True False]
+        prepare_soil: [False  True  True  True  True  True  True  True  True  True  \
+True False]
+        prepare_plant: [False  True  True  True False  True  True  True  True  True  \
+True False]
+        prepare_tree: [False False False False False False False False  True  True  \
+True False]
 
         >>> assert model is model.petmodel.tempmodel
         >>> assert model is model.petmodel.precipmodel

{hydpy-6.1.2 → hydpy-6.1.4}/make_hydpy_installer.cfgt

@@ -1,6 +1,6 @@
 [Application]
 name = HydPy
-version = 6.1.2-cp[auto]-win_amd64
+version = 6.1.4-cp[auto]-win_amd64
 entry_point = execute_exe:execute_scriptfunction
 console = true
 icon = logo.ico
@@ -38,6 +38,7 @@ pypi_wheels =
 	Pillow==[auto]
 	plotly==[auto]
 	tenacity==[auto]
+	narwhals==[auto]
 	networkx==[auto]
 	platformdirs==[auto]
 	click==[auto]

{hydpy-6.1.2 → hydpy-6.1.4}/noxfile.py

@@ -141,7 +141,7 @@ def mypy(session: nox.Session) -> None:
     the typing of numpy arrays, model parameters and so on.
     """
     _install_hydpy(session)
-    session.run("pip", "install", "numpy!=2.2.0,!=2.2.1")
+    session.run("pip", "install", "numpy<2.2")
     session.install("mypy", "types-docutils")
     session.run("mypy", "hydpy")
 

{hydpy-6.1.2 → hydpy-6.1.4}/setup.py

@@ -22,7 +22,7 @@ extension_modules = [
 
 setuptools.setup(
     name="HydPy",
-    version="6.1.2",
+    version="6.1.4",
     description="A framework for the development and application of hydrological "
     "models.",
     long_description=long_description,