Biogenic Factors

This module provides a data structure to represent the biogenic factors that impact the trophic status of a reservoir.

Biogenic factors are composed of: biome, climate type, soil type, treatment factor, i.e. the type of wastewater treatment in the catchment, and land use intensity.

Classes:: BiogenicFactors: A class to represent and manage the properties of a catchment area that influence the trophic status of a reservoir.

Usage Example:

from reemission.constants import (
    Biome, Climate, SoilType, TreatmentFactor,
    LanduseIntensity)
from reemission.descriptors import BiogenicFactors

factors = BiogenicFactors(
    biome=Biome.DESERTS,
    climate=Climate.TROPICAL,
    soil_type=SoilType.ORGANIC,
    treatment_factor=TreatmentFactor.TERTIARY,
    landuse_intensity=LanduseIntensity.HIGH
)
print(factors)

class reemission.biogenic.BiogenicFactors(biome: Biome, climate: Climate, soil_type: SoilType = SoilType.MINERAL, treatment_factor: TreatmentFactor = TreatmentFactor.NONE, landuse_intensity: LanduseIntensity = LanduseIntensity.LOW)[source]

Bases: object

Catchment’s properties impacting the reservoir’s trophic status.

biome

The biome type of the catchment area.

Type:: Biome

climate

The climate type of the catchment area.

Type:: Climate

soil_type

The soil type of the catchment area. Defaults to SoilType.MINERAL.

Type:: SoilType

treatment_factor

The wastewater treatment factor. Defaults to TreatmentFactor.NONE.

Type:: TreatmentFactor

landuse_intensity

The land use intensity. Defaults to LanduseIntensity.LOW.

Type:: LanduseIntensity

Note

Move optional attributes to a config file

__repr__() → str[source]

Return a string representation of the BiogenicFactors instance.

Returns:: String representation of the instance.
Return type:: str

biome: Biome

climate: Climate

classmethod fromdict(data_dict: Dict, method: Literal['name', 'value'] = 'name') → BiogenicFactors[source]

Initialize class from a dictionary.

Parameters:

data_dict (Dict) – Dictionary containing the data to initialize the class.
method (ToDictMethod) – Method to convert dictionary values. Either “name” or “value”. Defaults to “name”.

Returns:

An instance of BiogenicFactors.

Return type:

BiogenicFactors

Raises:

ConversionMethodUnknownException – If the method provided is not recognized.

get_attributes() → List[str][source]

Get a list of non-callable attributes of the class that do not start with ‘__’.

Returns:: A list of attribute names.
Return type:: List[str]

landuse_intensity: LanduseIntensity = 'low intensity'

soil_type: SoilType = 'mineral'

todict(method: Literal['name', 'value'] = 'name') → Dict[source]

Convert the class to its dictionary representation.

Parameters:: method (ToDictMethod) – Method to convert attributes. Either “name” or “value”. Defaults to “name”.
Returns:: A dictionary representation of the class.
Return type:: Dict
Raises:: ConversionMethodUnknownException – If the method provided is not recognized.

treatment_factor: TreatmentFactor = 'no treatment'

MonthlyTemperature

Emission Profile Calculator