HydPy 6.2.dev2__tar.gz → 6.2.dev3__tar.gz

{hydpy-6.2.dev2 → hydpy-6.2.dev3/HydPy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: HydPy
-Version: 6.2.dev2
+Version: 6.2.dev3
 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.2.dev2/HydPy.egg-info → hydpy-6.2.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: HydPy
-Version: 6.2.dev2
+Version: 6.2.dev3
 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.2.dev2 → hydpy-6.2.dev3}/appveyor.yml

@@ -1,5 +1,5 @@
 
-version: 6.2dev2.{build}
+version: 6.2dev3.{build}
 
 image: Visual Studio 2019
 

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/__init__.py

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

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_musk.pxd

@@ -49,6 +49,7 @@ cdef class SolverParameters:
     cdef public numpy.int64_t nmbruns
     cdef public double tolerancewaterdepth
     cdef public double tolerancedischarge
+    cdef public double tolerancenegativeinflow
 @cython.final
 cdef class Sequences:
     cdef public InletSequences inlets
@@ -251,6 +252,7 @@ cdef class Model:
     cpdef inline void update_senders(self, numpy.int64_t idx) noexcept nogil
     cpdef inline void update_outputs(self) noexcept nogil
     cpdef inline void pick_inflow_v1(self) noexcept nogil
+    cpdef inline void adjust_inflow_v1(self) noexcept nogil
     cpdef inline void update_discharge_v1(self) noexcept nogil
     cpdef inline void calc_discharge_v1(self) noexcept nogil
     cpdef inline void calc_referencedischarge_v1(self) noexcept nogil
@@ -267,6 +269,7 @@ cdef class Model:
     cpdef inline void calc_outflow_v1(self) noexcept nogil
     cpdef inline void pass_outflow_v1(self) noexcept nogil
     cpdef inline void pick_inflow(self) noexcept nogil
+    cpdef inline void adjust_inflow(self) noexcept nogil
     cpdef inline void update_discharge(self) noexcept nogil
     cpdef inline void calc_referencedischarge(self) noexcept nogil
     cpdef inline void calc_referencewaterdepth(self) noexcept nogil

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_musk.pyx

@@ -409,6 +409,7 @@ cdef class Model:
                 self.calc_discharge_v2()
     cpdef inline void update_inlets(self) noexcept nogil:
         self.pick_inflow_v1()
+        self.adjust_inflow_v1()
         self.update_discharge_v1()
     cpdef inline void update_outlets(self) noexcept nogil:
         self.calc_outflow_v1()
@@ -426,6 +427,12 @@ cdef class Model:
         self.sequences.fluxes.inflow = 0.0
         for idx in range(self.sequences.inlets.len_q):
             self.sequences.fluxes.inflow = self.sequences.fluxes.inflow + (self.sequences.inlets.q[idx][0])
+    cpdef inline void adjust_inflow_v1(self) noexcept nogil:
+        if self.sequences.fluxes.inflow < 0.0:
+            if self.sequences.fluxes.inflow < self.parameters.solver.tolerancenegativeinflow:
+                self.sequences.fluxes.inflow = nan
+            else:
+                self.sequences.fluxes.inflow = 0.0
     cpdef inline void update_discharge_v1(self) noexcept nogil:
         self.sequences.states.discharge[0] = self.sequences.fluxes.inflow
     cpdef inline void calc_discharge_v1(self) noexcept nogil:
@@ -440,7 +447,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
@@ -523,6 +530,12 @@ cdef class Model:
         self.sequences.fluxes.inflow = 0.0
         for idx in range(self.sequences.inlets.len_q):
             self.sequences.fluxes.inflow = self.sequences.fluxes.inflow + (self.sequences.inlets.q[idx][0])
+    cpdef inline void adjust_inflow(self) noexcept nogil:
+        if self.sequences.fluxes.inflow < 0.0:
+            if self.sequences.fluxes.inflow < self.parameters.solver.tolerancenegativeinflow:
+                self.sequences.fluxes.inflow = nan
+            else:
+                self.sequences.fluxes.inflow = 0.0
     cpdef inline void update_discharge(self) noexcept nogil:
         self.sequences.states.discharge[0] = self.sequences.fluxes.inflow
     cpdef inline void calc_referencedischarge(self) noexcept nogil:
@@ -533,7 +546,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.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_musk_mct.pxd

@@ -48,6 +48,7 @@ cdef class DerivedParameters:
 cdef class SolverParameters:
     cdef public double tolerancewaterdepth
     cdef public double tolerancedischarge
+    cdef public double tolerancenegativeinflow
     cdef public numpy.int64_t nmbruns
 @cython.final
 cdef class Sequences:
@@ -251,6 +252,7 @@ cdef class Model:
     cpdef inline void update_senders(self, numpy.int64_t idx) noexcept nogil
     cpdef inline void update_outputs(self) noexcept nogil
     cpdef inline void pick_inflow_v1(self) noexcept nogil
+    cpdef inline void adjust_inflow_v1(self) noexcept nogil
     cpdef inline void update_discharge_v1(self) noexcept nogil
     cpdef inline void calc_referencedischarge_v1(self) noexcept nogil
     cpdef inline void calc_referencewaterdepth_v1(self) noexcept nogil
@@ -266,6 +268,7 @@ cdef class Model:
     cpdef inline void calc_outflow_v1(self) noexcept nogil
     cpdef inline void pass_outflow_v1(self) noexcept nogil
     cpdef inline void pick_inflow(self) noexcept nogil
+    cpdef inline void adjust_inflow(self) noexcept nogil
     cpdef inline void update_discharge(self) noexcept nogil
     cpdef inline void calc_referencedischarge(self) noexcept nogil
     cpdef inline void calc_referencewaterdepth(self) noexcept nogil

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_musk_mct.pyx

@@ -409,6 +409,7 @@ cdef class Model:
                 self.calc_discharge_v2()
     cpdef inline void update_inlets(self) noexcept nogil:
         self.pick_inflow_v1()
+        self.adjust_inflow_v1()
         self.update_discharge_v1()
     cpdef inline void update_outlets(self) noexcept nogil:
         self.calc_outflow_v1()
@@ -426,6 +427,12 @@ cdef class Model:
         self.sequences.fluxes.inflow = 0.0
         for idx in range(self.sequences.inlets.len_q):
             self.sequences.fluxes.inflow = self.sequences.fluxes.inflow + (self.sequences.inlets.q[idx][0])
+    cpdef inline void adjust_inflow_v1(self) noexcept nogil:
+        if self.sequences.fluxes.inflow < 0.0:
+            if self.sequences.fluxes.inflow < self.parameters.solver.tolerancenegativeinflow:
+                self.sequences.fluxes.inflow = nan
+            else:
+                self.sequences.fluxes.inflow = 0.0
     cpdef inline void update_discharge_v1(self) noexcept nogil:
         self.sequences.states.discharge[0] = self.sequences.fluxes.inflow
     cpdef inline void calc_referencedischarge_v1(self) noexcept nogil:
@@ -436,7 +443,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
@@ -519,6 +526,12 @@ cdef class Model:
         self.sequences.fluxes.inflow = 0.0
         for idx in range(self.sequences.inlets.len_q):
             self.sequences.fluxes.inflow = self.sequences.fluxes.inflow + (self.sequences.inlets.q[idx][0])
+    cpdef inline void adjust_inflow(self) noexcept nogil:
+        if self.sequences.fluxes.inflow < 0.0:
+            if self.sequences.fluxes.inflow < self.parameters.solver.tolerancenegativeinflow:
+                self.sequences.fluxes.inflow = nan
+            else:
+                self.sequences.fluxes.inflow = 0.0
     cpdef inline void update_discharge(self) noexcept nogil:
         self.sequences.states.discharge[0] = self.sequences.fluxes.inflow
     cpdef inline void calc_referencedischarge(self) noexcept nogil:
@@ -529,7 +542,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.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_sw1d.pyx

@@ -784,7 +784,10 @@ cdef class Model:
             lu = self.sequences.factors.waterlevelupstream
             ld = self.sequences.factors.waterleveldownstream
             cel = c * h * (2.0 * g * fabs(lu - ld)) ** 0.5
-            self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
+            if cel == 0.0:
+                self.sequences.factors.maxtimestep = inf
+            else:
+                self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
         else:
             self.sequences.factors.maxtimestep = inf
     cpdef inline void calc_maxtimestep_v6(self) noexcept nogil:

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/cythons/autogen/c_sw1d_gate_out.pyx

@@ -338,7 +338,10 @@ cdef class Model(masterinterface.MasterInterface):
             lu = self.sequences.factors.waterlevelupstream
             ld = self.sequences.factors.waterleveldownstream
             cel = c * h * (2.0 * g * fabs(lu - ld)) ** 0.5
-            self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
+            if cel == 0.0:
+                self.sequences.factors.maxtimestep = inf
+            else:
+                self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
         else:
             self.sequences.factors.maxtimestep = inf
     cpdef inline void calc_discharge_v3(self) noexcept nogil:
@@ -415,7 +418,10 @@ cdef class Model(masterinterface.MasterInterface):
             lu = self.sequences.factors.waterlevelupstream
             ld = self.sequences.factors.waterleveldownstream
             cel = c * h * (2.0 * g * fabs(lu - ld)) ** 0.5
-            self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
+            if cel == 0.0:
+                self.sequences.factors.maxtimestep = inf
+            else:
+                self.sequences.factors.maxtimestep = self.parameters.control.timestepfactor * 1000.0 * self.parameters.control.lengthupstream / cel
         else:
             self.sequences.factors.maxtimestep = inf
     cpdef inline void calc_discharge(self) noexcept nogil:

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/docs/rst/simulation.rst

@@ -474,7 +474,7 @@ parts `<!--` and `-->` define a usual XML comment. As such comments count as not
 |xml_validate| reports the following error when checking `single_run.xmlt`:
 
 >>> subprocess = run_subprocess("hyd.py xml_validate HydPy-H-Lahn/single_run.xmlt")  # doctest: +ELLIPSIS
-failed validating '' with XsdAtomicBuiltin(name='xs:dateTime'):
+failed decoding '' with XsdAtomicBuiltin(name='xs:dateTime'):
 <BLANKLINE>
 Reason: Invalid datetime string '' for <class 'elementpath.datatypes.datetime.DateTime10'>
 ...
@@ -502,7 +502,7 @@ Although technically successful, the replacement was flawed because, as |xml_val
 can tell us, `wrong` is not a boolean value, as would be required:
 
 >>> subprocess = run_subprocess("hyd.py xml_validate HydPy-H-Lahn/single_run.xml")  # doctest: +ELLIPSIS
-failed validating 'wrong' with XsdAtomicBuiltin(name='xs:boolean'):
+failed decoding 'wrong' with XsdAtomicBuiltin(name='xs:boolean'):
 <BLANKLINE>
 Reason: 'wrong' is not a boolean value
 ...

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/docs/sphinx/conf.py

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

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/exe/xmltools.py

@@ -485,8 +485,8 @@ HydPyConfigMultipleRuns.xsd}config'
         Traceback (most recent call last):
         ...
         xmlschema.validators.exceptions.XMLSchemaDecodeError: While trying to \
-validate XML file `...single_run.xml`, the following error occurred: failed \
-validating '1996-01-32T00:00:00' with XsdAtomicBuiltin(name='xs:dateTime')...
+validate XML file `...single_run.xml`, the following error occurred: failed decoding \
+'1996-01-32T00:00:00' with XsdAtomicBuiltin(name='xs:dateTime')...
         ...
         Reason: day is out of range for month
         ...

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/models/musk/musk_model.py

@@ -33,6 +33,49 @@ class Pick_Inflow_V1(modeltools.Method):
             flu.inflow += inl.q[idx][0]
 
 
+class Adjust_Inflow_V1(modeltools.Method):
+    """Protect against negative inflow.
+
+    Examples:
+
+        Models like |musk_mct| cannot handle negative inflow.  Hence,
+        |Adjust_Inflow_V1| sets all such values to zero:
+
+        >>> from hydpy.models.musk import *
+        >>> parameterstep()
+        >>> fluxes.inflow = -0.1
+        >>> model.adjust_inflow_v1()
+        >>> fluxes.inflow
+        inflow(0.0)
+
+        This behaviour serves well in situations where numerical issues like rounding
+        errors cause slightly negative inflow values but bears the risk of severely
+        violating the water balance in case the upstream models produce strong negative
+        inflow values on purpose.  You can modify the solver parameter
+        |ToleranceNegativeInflow|, below which negative inflows are set to |numpy.nan|
+        instead of zero, to ensure such problems get noticed:
+
+        >>> fluxes.inflow = -0.1
+        >>> solver.tolerancenegativeinflow(-0.01)
+        >>> model.adjust_inflow_v1()
+        >>> fluxes.inflow
+        inflow(nan)
+    """
+
+    SOLVERPARAMETERS = (musk_solver.ToleranceNegativeInflow,)
+    UPDATEDSEQUENCES = (musk_fluxes.Inflow,)
+
+    @staticmethod
+    def __call__(model: modeltools.SegmentModel) -> None:
+        sol = model.parameters.solver.fastaccess
+        flu = model.sequences.fluxes.fastaccess
+        if flu.inflow < 0.0:
+            if flu.inflow < sol.tolerancenegativeinflow:
+                flu.inflow = modelutils.nan
+            else:
+                flu.inflow = 0.0
+
+
 class Update_Discharge_V1(modeltools.Method):
     r"""Assign the inflow to the start point of the first channel segment.
 
@@ -184,6 +227,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,)
@@ -199,7 +253,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):
@@ -809,8 +863,9 @@ class Model(modeltools.SegmentModel):
         musk_solver.NmbRuns,
         musk_solver.ToleranceWaterDepth,
         musk_solver.ToleranceDischarge,
+        musk_solver.ToleranceNegativeInflow,
     )
-    INLET_METHODS = (Pick_Inflow_V1, Update_Discharge_V1)
+    INLET_METHODS = (Pick_Inflow_V1, Adjust_Inflow_V1, Update_Discharge_V1)
     RECEIVER_METHODS = ()
     RUN_METHODS = (
         Calc_Discharge_V1,

{hydpy-6.2.dev2 → hydpy-6.2.dev3}/hydpy/models/musk/musk_solver.py

@@ -1,6 +1,10 @@
 # pylint: disable=missing-module-docstring
 
 # import...
+
+# ...from site-packages
+import numpy
+
 # ...from HydPy
 from hydpy.core import parametertools
 from hydpy.models.musk import musk_control
@@ -66,3 +70,13 @@ class ToleranceDischarge(parametertools.SolverParameter):
         tolerancedischarge(0.002)
         """
         return self.INIT * self.subpars.pars.control.catchmentarea.value
+
+
+class ToleranceNegativeInflow(parametertools.SolverParameter):
+    """Threshold for setting negative inflow values to zero or |numpy.nan| [m³/s]."""
+
+    NDIM = 0
+    TYPE = float
+    TIME = None
+    SPAN = (0.0, -numpy.inf)
+    INIT = -numpy.inf