HydPy-Evap-RET-IO (external data)

Use evap_ret_io as a submodel for handing externally available time series of reference evapotranspiration to main models like lland_dd.

Integration test

Note

When new to HydPy, consider reading section Integration Tests first.

The only functionality of evap_ret_io besides reading input time series is to adjust the given values to multiple hydrological response units. Hence, configuring and testing it does not require additional explanations:

>>> from hydpy.models.evap_ret_io import *
>>> parameterstep()
>>> from hydpy import Element
>>> element = Element("element")
>>> element.model = model

>>> from hydpy import IntegrationTest, pub
>>> pub.timegrids = "2000-01-01", "2000-01-03", "1d"
>>> nmbhru(2)
>>> hruarea(0.2, 0.8)
>>> evapotranspirationfactor(0.8, 1.2)

>>> test = IntegrationTest(element)
>>> test.dateformat = "%Y-%d-%m"

>>> inputs.referenceevapotranspiration.series = 1.0, 2.0

>>> test()
Click to see the table
|       date | referenceevapotranspiration |      referenceevapotranspiration | meanreferenceevapotranspiration |
-----------------------------------------------------------------------------------------------------------------
| 2000-01-01 |                         1.0 | 0.8                          1.2 |                            1.12 |
| 2000-02-01 |                         2.0 | 1.6                          2.4 |                            2.24 |

class hydpy.models.evap_ret_io.Model

Bases: Sub_ETModel, PETModel_V1

HydPy-Evap-RET-IO (external data).

The following “run methods” are called in the given sequence during each simulation step:

• Calc_ReferenceEvapotranspiration_V3 Take the input reference evapotranspiration for each hydrological response unit.

• Adjust_ReferenceEvapotranspiration_V1 Adjust the previously calculated reference evapotranspiration.

• Calc_MeanReferenceEvapotranspiration_V1 Calculate the average reference evapotranspiration.

The following interface methods are available to main models using the defined model as a submodel:

• Determine_PotentialEvapotranspiration_V1 Interface method that applies the complete application model by executing all “run methods”.

• Get_PotentialEvapotranspiration_V1 Get the current reference evapotranspiration from the selected hydrological response unit.

• Get_MeanPotentialEvapotranspiration_V1 Get the averaged reference evapotranspiration.

DOCNAME: DocName = ('Evap-RET-IO', 'external data')

OBSERVER_METHODS: ClassVar[tuple[type[Method], ...]] = ()

REUSABLE_METHODS: ClassVar[tuple[type[ReusableMethod], ...]] = ()

cymodel: CyModelProtocol | None

parameters: parametertools.Parameters

sequences: sequencetools.Sequences

masks: masktools.Masks

class hydpy.models.evap_ret_io.ControlParameters(master: Parameters, cls_fastaccess: type[FastAccessParameter] | None = None, cymodel: CyModelProtocol | None = None)

Bases: SubParameters

Control parameters of model evap_ret_io.

The following classes are selected:

• NmbHRU() The number of separately modelled hydrological response units [-].

• HRUArea() The area of each hydrological response unit [km²].

• EvapotranspirationFactor() The adjustment factor for potential evapotranspiration [-].

class hydpy.models.evap_ret_io.DerivedParameters(master: Parameters, cls_fastaccess: type[FastAccessParameter] | None = None, cymodel: CyModelProtocol | None = None)

Bases: SubParameters

Derived parameters of model evap_ret_io.

The following classes are selected:

• HRUAreaFraction() The area fraction of each hydrological response unit [-].

class hydpy.models.evap_ret_io.FluxSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: FluxSequences

Flux sequences of model evap_ret_io.

The following classes are selected:

• ReferenceEvapotranspiration() Reference (grass) evapotranspiration [mm/T].

• MeanReferenceEvapotranspiration() Mean reference evapotranspiration [mm/T].

class hydpy.models.evap_ret_io.InputSequences(master: Sequences, cls_fastaccess: type[TypeFastAccess_co] | None = None, cymodel: CyModelProtocol | None = None)

Bases: InputSequences

Input sequences of model evap_ret_io.

The following classes are selected:

• ReferenceEvapotranspiration() Reference evapotranspiration [mm/T].