HydPy 6.2.dev1__cp313-cp313-win_amd64.whl

hydpy/models/evap/evap_factors.py

@@ -0,0 +1,188 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+from hydpy.models.evap import evap_sequences
+
+
+class MeanAirTemperature(sequencetools.FactorSequence):
+    """The basin's mean air temperature [°C]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class AirTemperature(evap_sequences.FactorSequence1D):
+    """Air temperature [°C]."""
+
+    NUMERIC = False
+
+
+class DailyAirTemperature(evap_sequences.FactorSequence1D):
+    """The average air temperature in the last 24 hours [°C]."""
+
+    NUMERIC = False
+
+
+class WindSpeed2m(sequencetools.FactorSequence):
+    """Wind speed at 2 m above grass-like vegetation [m/s]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DailyWindSpeed2m(sequencetools.FactorSequence):
+    """Average wind speed 2 meters above ground in the last 24 hours [m/s]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class WindSpeed10m(sequencetools.FactorSequence):
+    """Wind speed at 10 m above grass-like vegetation [m/s]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DailyRelativeHumidity(sequencetools.FactorSequence):
+    """Average relative humidity in the last 24 hours [%]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class SunshineDuration(sequencetools.FactorSequence):
+    """Sunshine duration [h]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class PossibleSunshineDuration(sequencetools.FactorSequence):
+    """Astronomically possible sunshine duration [h]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DailySunshineDuration(sequencetools.FactorSequence):
+    """The actual sunshine duration in the last 24 hours [h]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DailyPossibleSunshineDuration(sequencetools.FactorSequence):
+    """The astronomically possible sunshine duration in the last 24 hours [h]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class SaturationVapourPressure(evap_sequences.FactorSequence1D):
+    """Saturation vapour pressure [hPa]."""
+
+    NUMERIC = False
+
+
+class DailySaturationVapourPressure(evap_sequences.FactorSequence1D):
+    """Average saturation vapour pressure in the last 24 hours [hPa]."""
+
+    NUMERIC = False
+
+
+class SaturationVapourPressureSlope(evap_sequences.FactorSequence1D):
+    """The slope of the saturation vapour pressure curve [hPa/K]."""
+
+    NUMERIC = False
+
+
+class DailySaturationVapourPressureSlope(evap_sequences.FactorSequence1D):
+    """Average saturation vapour pressure slope in the last 24 hours [hPa/K]."""
+
+    NUMERIC = False
+
+
+class ActualVapourPressure(evap_sequences.FactorSequence1D):
+    """Actual vapour pressure [hPa]."""
+
+    NUMERIC = False
+
+
+class DailyActualVapourPressure(evap_sequences.FactorSequence1D):
+    """The average actual vapour pressure in the last 24 hours [hPa]."""
+
+    NUMERIC = False
+
+
+class DryAirPressure(evap_sequences.FactorSequence1D):
+    """Dry air pressure [hPa]."""
+
+    NUMERIC = False
+
+
+class AirDensity(evap_sequences.FactorSequence1D):
+    """Air density [kg/m³]."""
+
+    NUMERIC = False
+
+
+class PsychrometricConstant(sequencetools.FactorSequence):
+    """Psychrometric constant [hPa/K]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class CurrentAlbedo(evap_sequences.FactorSequence1D):
+    """The current albedo of the relevant surface [-]."""
+
+    NUMERIC = False
+
+
+class AdjustedCloudCoverage(sequencetools.FactorSequence):
+    """Adjusted degree of cloud coverage [-]."""
+
+    NDIM, NUMERIC, SPAN = 0, False, (0.0, 1.0)
+
+
+class AerodynamicResistance(evap_sequences.FactorSequence1D):
+    """Aerodynamic resistance [s/m]."""
+
+    NUMERIC = False
+
+
+class SoilSurfaceResistance(evap_sequences.FactorSequence1D):
+    """Soil surface resistance [s/m]."""
+
+    NUMERIC = False
+
+
+class LanduseSurfaceResistance(evap_sequences.FactorSequence1D):
+    """Surface resistance for the current moisture conditions of water areas, sealed
+    areas, and vegetation [s/m]."""
+
+    NUMERIC = False
+
+
+class ActualSurfaceResistance(evap_sequences.FactorSequence1D):
+    """Actual surface resistance [s/m]."""
+
+    NUMERIC = False
+
+
+class InterceptedWater(evap_sequences.FactorSequence1D):
+    """Intercepted water [mm]."""
+
+    NUMERIC = False
+
+
+class SoilWater(evap_sequences.FactorSequence1D):
+    """Soil water content [mm]."""
+
+    NUMERIC = False
+
+
+class SnowCover(evap_sequences.FactorSequence1D):
+    """Snow cover degree [-]."""
+
+    NUMERIC = False
+
+
+class SnowyCanopy(evap_sequences.FactorSequence1D):
+    """Snow cover degree in the canopies of tree-like vegetation (is for |numpy.nan|
+    non-tree-like vegetation) [-]."""
+
+    NUMERIC = False

hydpy/models/evap/evap_fixed.py

@@ -0,0 +1,68 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import parametertools
+
+
+class StefanBoltzmannConstant(parametertools.FixedParameter):
+    """Stefan-Boltzmann constant [W/m²/K]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 5.67e-08
+
+
+class FactorCounterRadiation(parametertools.FixedParameter):
+    """A factor for adjusting the atmospheric counter radiation [-]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 1.28
+
+
+class GasConstantDryAir(parametertools.FixedParameter):
+    """Gas constant for dry air [J/kg/K]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 287.058
+
+
+class GasConstantWaterVapour(parametertools.FixedParameter):
+    """Gas constant for water vapour [J/kg/K]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 461.495
+
+
+class HeatCapacityAir(parametertools.FixedParameter):
+    """Specific heat capacity of air [J/kg/K]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 1005.0
+
+
+class HeatOfCondensation(parametertools.FixedParameter):
+    """Latent condensation heat of water at 15°C [WT/kg]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, False, (0.0, None)
+    INIT = 28.5
+
+
+class RoughnessLengthGrass(parametertools.FixedParameter):
+    """Roughness length for short grass [m]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 0.003
+
+
+class PsychrometricConstant(parametertools.FixedParameter):
+    """Psychrometric constant [hPa/K]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 0.655
+
+
+class AerodynamicResistanceFactorMinimum(parametertools.FixedParameter):
+    """The lowest allowed factor for calculating aerodynamic resistance [-]."""
+
+    NDIM, TYPE, TIME, SPAN = 0, float, None, (0.0, None)
+    INIT = 94.0

hydpy/models/evap/evap_fluxes.py

@@ -0,0 +1,150 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+from hydpy.models.evap import evap_sequences
+
+
+class Precipitation(evap_sequences.FluxSequence1D):
+    """Precipitation [mm/T]."""
+
+    NUMERIC = False
+
+
+class DailyPrecipitation(evap_sequences.FluxSequence1D):
+    """The precipitation sum of the last 24 hours [mm/d]."""
+
+    NUMERIC = False
+
+
+class GlobalRadiation(sequencetools.FluxSequence):
+    """Global radiation [W/m²]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class ClearSkySolarRadiation(sequencetools.FluxSequence):
+    """Clear sky solar radiation [W/m²]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class DailyGlobalRadiation(sequencetools.FluxSequence):
+    """Average global radiation in the last 24 hours [W/m²]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class NetShortwaveRadiation(evap_sequences.FluxSequence1D):
+    """Net shortwave radiation [W/m²]."""
+
+    NUMERIC = False
+
+
+class DailyNetShortwaveRadiation(evap_sequences.FluxSequence1D):
+    """Average net shortwave radiation in the last 24 hours [W/m²]."""
+
+    NUMERIC = False
+
+
+class NetLongwaveRadiation(evap_sequences.FluxSequence1D):
+    """Net longwave radiation [W/m²]."""
+
+    NUMERIC = False
+
+
+class DailyNetLongwaveRadiation(evap_sequences.FluxSequence1D):
+    """Average net longwave radiation in the last 24 hours [W/m²]."""
+
+    NUMERIC = False
+
+
+class NetRadiation(evap_sequences.FluxSequence1D):
+    """Total net radiation [W/m²]."""
+
+    NUMERIC = False
+
+
+class DailyNetRadiation(evap_sequences.FluxSequence1D):
+    """Average net radiation in the last 24 hours [W/m²]."""
+
+    NUMERIC = False
+
+
+class SoilHeatFlux(evap_sequences.FluxSequence1D):
+    """Soil heat flux [W/m²]."""
+
+    NUMERIC = False
+
+
+class ReferenceEvapotranspiration(evap_sequences.FluxSequence1D):
+    """Reference (grass) evapotranspiration [mm/T]."""
+
+    NUMERIC = False
+
+
+class PotentialInterceptionEvaporation(evap_sequences.FluxSequence1D):
+    """Potential interception evaporation [mm/T]."""
+
+    NUMERIC = False
+
+
+class PotentialSoilEvapotranspiration(evap_sequences.FluxSequence1D):
+    """Potential evapotranspiration from soils [mm/T]."""
+
+    NUMERIC = False
+
+
+class PotentialEvapotranspiration(evap_sequences.FluxSequence1D):
+    """Potential (land type-specific) evapotranspiration [mm/T]."""
+
+    NUMERIC = False
+
+
+class DailyPotentialSoilEvapotranspiration(evap_sequences.FluxSequence1D):
+    """The potential soil evapotranspiration sum of the last 24 hours [mm/d]."""
+
+    NUMERIC = False
+
+
+class MeanReferenceEvapotranspiration(sequencetools.FluxSequence):
+    """Mean reference evapotranspiration [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class MeanPotentialEvapotranspiration(sequencetools.FluxSequence):
+    """Mean potential evapotranspiration [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+
+
+class PotentialWaterEvaporation(evap_sequences.FluxSequence1D):
+    """Potential evaporation from open water areas [mm/T]."""
+
+    NUMERIC = False
+
+
+class WaterEvaporation(evap_sequences.FluxSequence1D):
+    """Actual evaporation from open water areas [mm/T]."""
+
+    NUMERIC = False
+
+
+class DailyWaterEvaporation(evap_sequences.FluxSequence1D):
+    """The water evaporation sum of the last 24 hours [mm/d]."""
+
+    NUMERIC = False
+
+
+class InterceptionEvaporation(evap_sequences.FluxSequence1D):
+    """Actual interception evaporation [mm/T]."""
+
+    NUMERIC = False
+
+
+class SoilEvapotranspiration(evap_sequences.FluxSequence1D):
+    """Actual soil evapotranspiration [mm/T]."""
+
+    NUMERIC = False

hydpy/models/evap/evap_inputs.py

@@ -0,0 +1,54 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import sequencetools
+
+
+class ReferenceEvapotranspiration(sequencetools.InputSequence):
+    """Reference evapotranspiration [mm/T]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.POTENTIAL_EVAPOTRANSPIRATION
+
+
+class RelativeHumidity(sequencetools.InputSequence):
+    """Relative humidity [%]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.RELATIVE_HUMIDITY
+
+
+class WindSpeed(sequencetools.InputSequence):
+    """Wind speed [m/s]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.WIND_SPEED
+
+
+class AtmosphericPressure(sequencetools.InputSequence):
+    """Atmospheric pressure [hPa]."""
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.ATMOSPHERIC_PRESSURE
+
+
+class NormalAirTemperature(sequencetools.InputSequence):
+    """Normal air temperature [°C].
+
+
+    In the terminology of HBV96: TN.
+    """
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.NORMAL_AIR_TEMPERATURE
+
+
+class NormalEvapotranspiration(sequencetools.InputSequence):
+    """Normal evapotranspiration [mm/T].
+
+    In the terminology of HBV96: EPN.
+    """
+
+    NDIM, NUMERIC = 0, False
+    STANDARD_NAME = sequencetools.StandardInputNames.NORMAL_EVAPOTRANSPIRATION

hydpy/models/evap/evap_logs.py

@@ -0,0 +1,91 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from HydPy
+from hydpy.core import propertytools
+from hydpy.core import sequencetools
+
+
+class LoggedAirTemperature(sequencetools.LogSequence):
+    """Logged air temperature [°C]."""
+
+    NDIM, NUMERIC = 2, False
+
+
+class LoggedPrecipitation(sequencetools.LogSequence):
+    """Logged precipitation [mm/T]."""
+
+    NDIM, NUMERIC = 2, False
+
+
+class LoggedWindSpeed2m(sequencetools.LogSequence):
+    """Logged wind speed at 2 m above grass-like vegetation [m/s]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedRelativeHumidity(sequencetools.LogSequence):
+    """Logged relative humidity [%]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedSunshineDuration(sequencetools.LogSequence):
+    """Logged sunshine duration [h]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedPossibleSunshineDuration(sequencetools.LogSequence):
+    """Logged astronomically possible sunshine duration [h]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedGlobalRadiation(sequencetools.LogSequence):
+    """Logged global radiation [W/m²]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedClearSkySolarRadiation(sequencetools.LogSequence):
+    """Logged clear sky radiation [W/m²]."""
+
+    NDIM, NUMERIC = 1, False
+
+
+class LoggedPotentialEvapotranspiration(sequencetools.LogSequence):
+    """Logged (damped) potential evapotranspiration [mm/T]."""
+
+    NDIM, NUMERIC = 2, False
+
+    def _get_shape(self):
+        """A tuple containing the lengths of all dimensions.
+
+        |LoggedPotentialEvapotranspiration| is generally initialised with a length of
+        one on the first axis:
+
+        >>> from hydpy.models.evap import *
+        >>> parameterstep()
+        >>> logs.loggedpotentialevapotranspiration.shape = 3
+        >>> logs.loggedpotentialevapotranspiration.shape
+        (1, 3)
+        """
+        return super()._get_shape()
+
+    def _set_shape(self, shape):
+        super()._set_shape((1, shape))
+
+    shape = propertytools.Property(fget=_get_shape, fset=_set_shape)
+
+
+class LoggedWaterEvaporation(sequencetools.LogSequence):
+    """Logged evaporation from water areas [mm/T]."""
+
+    NDIM, NUMERIC = 2, False
+
+
+class LoggedPotentialSoilEvapotranspiration(sequencetools.LogSequence):
+    """Logged potential soil evapotranspiration [mm/T]."""
+
+    NDIM, NUMERIC = 2, False

hydpy/models/evap/evap_masks.py

@@ -0,0 +1,48 @@
+# pylint: disable=missing-module-docstring
+
+# import...
+# ...from standard library
+from __future__ import annotations
+
+# ...from HydPy
+from hydpy.core import masktools
+from hydpy.core import variabletools
+from hydpy.core.typingtools import *
+
+if TYPE_CHECKING:
+    from hydpy.models.evap import evap_control
+
+
+class Soil(masktools.SubmodelIndexMask):
+    """Mask including hydrological response units where evapotranspiration from soils
+    occurs."""
+
+    @staticmethod
+    def get_refinement(variable: variabletools.Variable) -> evap_control.Soil:
+        """Return a reference to the associated |evap_control.Soil| instance."""
+        return variable.subvars.vars.model.parameters.control.soil
+
+
+class Plant(masktools.SubmodelIndexMask):
+    """Mask including hydrological response units containing any vegetation."""
+
+    @staticmethod
+    def get_refinement(variable: variabletools.Variable) -> evap_control.Plant:
+        """Return a reference to the associated |evap_control.Plant| instance."""
+        return variable.subvars.vars.model.parameters.control.plant
+
+
+class Water(masktools.SubmodelIndexMask):
+    """Mask including hydrological response units where evaporation from open water
+    areas."""
+
+    @staticmethod
+    def get_refinement(variable: variabletools.Variable) -> evap_control.Water:
+        """Return a reference to the associated |evap_control.Water| instance."""
+        return variable.subvars.vars.model.parameters.control.water
+
+
+class Masks(masktools.Masks):
+    """Masks of base model |evap|."""
+
+    CLASSES = (Soil, Plant, Water)