API for the constants module

The models.abiotic_simple.constants module contains a set of dataclasses containing parameters required by the broader abiotic_simple model. These parameters are constants in that they should not be changed during a particular simulation.

Classes:

AbioticSimpleBounds([air_temperature, ...])

Upper and lower bounds for abiotic variables.

AbioticSimpleConsts(...)

Dataclass to store all constants for the abiotic_simple model.
class virtual_ecosystem.models.abiotic_simple.constants.AbioticSimpleBounds(air_temperature: tuple[float, float, float] = (-20.0, 80.0, -1.27), relative_humidity: tuple[float, float, float] = (0.0, 100.0, 5.4), vapour_pressure_deficit: tuple[float, float, float] = (0.0, 10.0, -252.24), soil_temperature: tuple[float, float] = (-10.0, 50.0))

Upper and lower bounds for abiotic variables.

When a values falls outside these bounds, it is set to the bound value. Note that this approach does not conserve energy and matter in the system. This will be implemented at a later stage.

Methods:

__init__([air_temperature, ...])

Attributes:

air_temperature

Bounds and gradient for air temperature, [C].

relative_humidity

Bounds and gradient for relative humidity, dimensionless.

soil_temperature

Bounds for soil temperature, [C].

vapour_pressure_deficit

Bounds and gradient for vapour pressure deficit, [kPa].
__init__(air_temperature: tuple[float, float, float] = (-20.0, 80.0, -1.27), relative_humidity: tuple[float, float, float] = (0.0, 100.0, 5.4), vapour_pressure_deficit: tuple[float, float, float] = (0.0, 10.0, -252.24), soil_temperature: tuple[float, float] = (-10.0, 50.0)) → None
air_temperature: tuple[float, float, float] = (-20.0, 80.0, -1.27)

Bounds and gradient for air temperature, [C].

Gradient for linear regression to calculate air temperature as a function of leaf area index from Hardwick et al. (2015).

relative_humidity: tuple[float, float, float] = (0.0, 100.0, 5.4)

Bounds and gradient for relative humidity, dimensionless.

Gradient for linear regression to calculate relative humidity as a function of leaf area index from Hardwick et al. (2015).

soil_temperature: tuple[float, float] = (-10.0, 50.0)

Bounds for soil temperature, [C].

Gradient for linear regression to calculate vapour pressure deficit as a function of leaf area index from Hardwick et al. (2015)

vapour_pressure_deficit: tuple[float, float, float] = (0.0, 10.0, -252.24)

Bounds and gradient for vapour pressure deficit, [kPa].

class virtual_ecosystem.models.abiotic_simple.constants.AbioticSimpleConsts(saturation_vapour_pressure_factors: list[float] = <factory>)

Dataclass to store all constants for the abiotic_simple model.

Methods:

__init__([saturation_vapour_pressure_factors])

Attributes:

saturation_vapour_pressure_factors

Factors for saturation vapour pressure calculation.
__init__(saturation_vapour_pressure_factors: list[float] = <factory>) → None
saturation_vapour_pressure_factors: list[float]

Factors for saturation vapour pressure calculation.