pyholos 0.0.1__py3-none-any.whl

pyholos/common.py

@@ -0,0 +1,141 @@
+from enum import Enum, StrEnum, auto, unique
+from typing import Any
+
+from pyholos.common2 import CanadianProvince
+from pyholos.utils import AutoNameEnum
+
+
+class EnumGeneric(Enum):
+    @classmethod
+    def get_value(cls, name: str) -> str:
+        return getattr(cls, name).value
+
+    @classmethod
+    def get_member(cls, name: str):
+        return getattr(cls, name)
+
+
+class HolosVar:
+    def __init__(
+            self,
+            name: str,
+            value: Any = None
+    ):
+        self.name = name
+        self.value = value
+
+
+class Component:
+    def __init__(self):
+        pass
+
+    def to_dict(self) -> dict:
+        return {v.name: v.value for k, v in self.__dict__.items() if isinstance(v, HolosVar)}
+
+
+class Region(AutoNameEnum):
+    EasternCanada = auto()
+    WesternCanada = auto()
+
+
+def get_region(
+        province: CanadianProvince
+) -> str:
+    if province in [
+        CanadianProvince.Alberta,
+        CanadianProvince.BritishColumbia,
+        CanadianProvince.Manitoba,
+        CanadianProvince.Saskatchewan,
+        CanadianProvince.NorthwestTerritories,
+        CanadianProvince.Nunavut]:
+
+        res = Region.WesternCanada
+
+    else:
+        res = Region.EasternCanada
+
+    return res
+
+
+def verify_is_prairie_province(
+        province: CanadianProvince
+) -> bool:
+    return province in [
+        CanadianProvince.Alberta,
+        CanadianProvince.Saskatchewan,
+        CanadianProvince.Manitoba]
+
+
+@unique
+class ClimateZones(StrEnum):
+    CoolTemperateMoist = auto()
+    CoolTemperateDry = auto()
+    BorealMoist = auto()
+    BorealDry = auto()
+    WarmTemperateMoist = auto()
+    WarmTemperateDry = auto()
+
+
+def get_climate_zone(
+        mean_annual_temperature: float,
+        mean_annual_precipitation: float,
+        mean_annual_potential_evapotranspiration: float
+) -> ClimateZones:
+    """Returns a ClimateZones member for the specified climate conditions
+
+    Args:
+        mean_annual_temperature: (°C) mean annual air temperature
+        mean_annual_precipitation: (mm) mean annual precipitation
+        mean_annual_potential_evapotranspiration: (mm) mean annual potential evapotranspiration
+
+    Returns:
+        ClimateZones object
+
+    Notes:
+        For the determination of the methane conversion factor) MCF value, IPCC (2019) defines the different climate zones as follows:
+            1. Warm temperate moist: mean annual temperature (MAT) > 10 °C, P:PE >1;
+            2. Warm temperate dry: MAT >10 °C, P:PE < 1;
+            3. Cool temperate moist: MAT > 0 °C, P:PE >1;
+            4. Cool temperate dry: MAT > 0 °C, P:PE <1;
+            5. Boreal moist: MAT < 0 °C but some monthly temperatures > 10 °C, P:PE >1;
+            6. Boreal dry: MAT < 0 °C but some monthly temperatures > 10 °C, P:PE <1.
+        The MAT for cool temperate moist, cool temperate dry, warm temperate moist and warm temperate dry were 4.6, 5.8, 13.9, 14.0, respectively.
+        For deep pit manure storage systems for dairy cattle and swine, an average storage duration of 1 month was assumed.
+        (Source: IPCC (2019), Table 10.17)
+
+    Holos Source Code:
+        https://github.com/holos-aafc/Holos/blob/396f1ab9bc7247e6d78766f9445c14d2eb7c0d9d/H.Core/Providers/Animals/Table_37_MCF_By_Climate_Livestock_MansureSystem_Provider.cs#L147
+    """
+    is_high_ratio_precipitation_to_potential_evapotranspiration = (
+            (mean_annual_precipitation / mean_annual_potential_evapotranspiration) >= 1)
+
+    if (mean_annual_temperature >= 10) and is_high_ratio_precipitation_to_potential_evapotranspiration:
+        climate_zone = ClimateZones.WarmTemperateMoist
+
+    elif (mean_annual_temperature >= 10) and not is_high_ratio_precipitation_to_potential_evapotranspiration:
+        climate_zone = ClimateZones.WarmTemperateDry
+
+    elif all([
+        mean_annual_temperature >= 0,
+        mean_annual_temperature < 10,
+        is_high_ratio_precipitation_to_potential_evapotranspiration
+    ]):
+        climate_zone = ClimateZones.CoolTemperateMoist
+
+    elif all([
+        mean_annual_temperature >= 0,
+        mean_annual_temperature < 10,
+        not is_high_ratio_precipitation_to_potential_evapotranspiration
+    ]):
+        climate_zone = ClimateZones.CoolTemperateDry
+
+    elif (mean_annual_temperature <= 0) and is_high_ratio_precipitation_to_potential_evapotranspiration:
+        climate_zone = ClimateZones.WarmTemperateMoist
+
+    elif (mean_annual_temperature <= 0) and not is_high_ratio_precipitation_to_potential_evapotranspiration:
+        climate_zone = ClimateZones.WarmTemperateDry
+
+    else:
+        raise ValueError("Unable to get data for methane conversion factor since climate zone is unknown")
+
+    return climate_zone

pyholos/common2.py

@@ -0,0 +1,157 @@
+from enum import Enum
+from pathlib import Path
+
+from geojson import FeatureCollection, load
+from pandas import DataFrame, read_csv
+from shapely.geometry import Point, shape
+
+
+class MapNamesGeneric(Enum):
+    @classmethod
+    def _get_name(cls, abbreviation: str) -> str:
+        for member in cls:
+            if member.value.abbreviation == abbreviation:
+                return member.value.name
+
+    @classmethod
+    def get_name(cls, abbreviation: str) -> str:
+        res = cls._get_name(abbreviation=abbreviation)
+        return res if res is not None else "NotApplicable"
+
+
+class NameSlc:
+    def __init__(
+            self,
+            name: str,
+            abbreviation: str
+    ):
+        self.name = name
+        self.abbreviation = abbreviation
+
+
+class CanadianProvince(MapNamesGeneric):
+    Alberta: NameSlc = NameSlc(name='Alberta', abbreviation='AB')
+    BritishColumbia: NameSlc = NameSlc(name='British Columbia', abbreviation="BC")
+    Manitoba: NameSlc = NameSlc(name='Manitoba', abbreviation="MB")
+    NewBrunswick: NameSlc = NameSlc(name='New Brunswick', abbreviation="NB")
+    NewfoundlandAndLabrador: NameSlc = NameSlc(name='Newfoundland and Labrador', abbreviation="NL")
+    NorthwestTerritories: NameSlc = NameSlc(name='Northwest Territories', abbreviation="NT")
+    NovaScotia: NameSlc = NameSlc(name='Nova Scotia', abbreviation="NS")
+    Nunavut: NameSlc = NameSlc(name='Nunavut', abbreviation="NU")
+    Ontario: NameSlc = NameSlc(name='Ontario', abbreviation="ON")
+    PrinceEdwardIsland: NameSlc = NameSlc(name='Prince Edward Island', abbreviation="PE")
+    Quebec: NameSlc = NameSlc(name='Quebec', abbreviation="QC")
+    Saskatchewan: NameSlc = NameSlc(name='Saskatchewan', abbreviation="SK")
+    Yukon: NameSlc = NameSlc(name='Yukon', abbreviation="YT")
+
+
+class SoilGreatGroupNamesSlc(MapNamesGeneric):
+    MelanicBrunisol: NameSlc = NameSlc(name='Melanic Brunisol', abbreviation="MB")
+    EutricBrunisol: NameSlc = NameSlc(name='Eutric Brunisol', abbreviation="EB")
+    SombricBrunisol: NameSlc = NameSlc(name='Sombric Brunisol', abbreviation="SB")
+    DystricBrunisol: NameSlc = NameSlc(name='Dystric Brunisol', abbreviation="DYB")
+    BrownChernozem: NameSlc = NameSlc(name='Brown Chernozem', abbreviation="BC")
+    DarkBrownChernozem: NameSlc = NameSlc(name='Dark Brown Chernozem', abbreviation="DBC")
+    BlackChernozem: NameSlc = NameSlc(name='Black Chernozem', abbreviation="BLC")
+    DarkGrayChernozem: NameSlc = NameSlc(name='Dark Gray Chernozem', abbreviation="DGC")
+    TurbicCryosol: NameSlc = NameSlc(name='Turbic Cryosol', abbreviation="TC")
+    StaticCryosol: NameSlc = NameSlc(name='Static Cryosol', abbreviation="SC")
+    OrganicCryosol: NameSlc = NameSlc(name='Organic Cryosol', abbreviation="OC")
+    HumicGleysol: NameSlc = NameSlc(name='Humic Gleysol', abbreviation="HG")
+    Gleysol: NameSlc = NameSlc(name='Gleysol', abbreviation="G")
+    LuvicGleysol: NameSlc = NameSlc(name='Luvic Gleysol', abbreviation="LG")
+    GrayBrownLuvisol: NameSlc = NameSlc(name='Gray Brown Luvisol', abbreviation="GBL")
+    GrayLuvisol: NameSlc = NameSlc(name='Gray Luvisol', abbreviation="GL")
+    Fibrisol: NameSlc = NameSlc(name='Fibrisol', abbreviation="F")
+    Mesisol: NameSlc = NameSlc(name='Mesisol', abbreviation="M")
+    Humisol: NameSlc = NameSlc(name='Humisol', abbreviation="H")
+    Folisol: NameSlc = NameSlc(name='Folisol', abbreviation="FO")
+    HumicPodzol: NameSlc = NameSlc(name='Humic Podzol', abbreviation="HP")
+    FerroHumicPodzol: NameSlc = NameSlc(name='Ferro-Humic Podzol', abbreviation="FHP")
+    HumoFerricPodzol: NameSlc = NameSlc(name='Humo-Ferric Podzol', abbreviation="HFP")
+    Regosol: NameSlc = NameSlc(name='Regosol', abbreviation="R")
+    HumicRegosol: NameSlc = NameSlc(name='Humic Regosol', abbreviation="HR")
+    Solonetz: NameSlc = NameSlc(name='Solonetz', abbreviation="SZ")
+    SolodizedSolonetz: NameSlc = NameSlc(name='Solodized Solonetz', abbreviation="SS")
+    Solod: NameSlc = NameSlc(name='Solod', abbreviation="SO")
+    VerticSolonetz: NameSlc = NameSlc(name='Vertic Solonetz', abbreviation="VSZ")
+    Vertisol: NameSlc = NameSlc(name='Vertisol', abbreviation="V")
+    HumicVertisol: NameSlc = NameSlc(name='Humic Vertisol', abbreviation="HV")
+
+    NotApplicable: NameSlc = NameSlc(name="NotApplicable", abbreviation='NA')
+    Unknown: NameSlc = NameSlc(name="NotApplicable", abbreviation='NA')
+
+
+class ParentMaterialTextureNamesSlc(MapNamesGeneric):
+    VeryCoarse: NameSlc = NameSlc(name='Very Coarse', abbreviation="VC")
+    Coarse: NameSlc = NameSlc(name='Coarse', abbreviation="C")
+    ModeratelyCoarse: NameSlc = NameSlc(name='Moderately Coarse', abbreviation="MC")
+    Medium: NameSlc = NameSlc(name='Medium', abbreviation="M")
+    ModeratelyFine: NameSlc = NameSlc(name='Moderately Fine', abbreviation="MF")
+    Fine: NameSlc = NameSlc(name='Fine', abbreviation="F")
+    VeryFine: NameSlc = NameSlc(name='Very Fine', abbreviation="VF")
+    CoarseSkeletal: NameSlc = NameSlc(name='Coarse Skeletal', abbreviation="CS")
+    MediumSkeletal: NameSlc = NameSlc(name='Medium Skeletal', abbreviation="MS")
+    FineSkeletal: NameSlc = NameSlc(name='Fine Skeletal', abbreviation="FS")
+    Fragmental: NameSlc = NameSlc(name='Fragmental', abbreviation="FR")
+    StratifiedMineral: NameSlc = NameSlc(name='Stratified (Mineral)', abbreviation="SM")
+    StratifiedMineralAndOrganic: NameSlc = NameSlc(name='Stratified (Mineral and Organic)', abbreviation="SU")
+    Fibric: NameSlc = NameSlc(name='Fibric', abbreviation="FI")
+    Mesic: NameSlc = NameSlc(name='Mesic', abbreviation="ME")
+    Humic: NameSlc = NameSlc(name='Humic', abbreviation="HU")
+    Undifferentiated: NameSlc = NameSlc(name='Undifferentiated', abbreviation="UD")
+
+
+def read_slc_csv(
+        path_file: Path,
+        **kwargs
+) -> DataFrame:
+    return read_csv(path_file, sep=',', decimal='.', **kwargs)
+
+
+def load_slc_data(path_slc_geojson_file: Path) -> FeatureCollection:
+    with path_slc_geojson_file.open(mode='r') as f:
+        return load(f)
+
+
+def get_slc_polygon_properties(
+        latitude: float | str,
+        longitude: float | str,
+        geojson_data: FeatureCollection
+) -> dict | None:
+    point = Point(longitude, latitude)
+
+    for feature in geojson_data['features']:
+        polygon = shape(feature['geometry'])
+        if polygon.contains(point):
+            return feature['properties']
+
+    return None
+
+
+def get_dominant_component_properties(
+        id_polygon: str,
+        slc_components_table: DataFrame
+) -> dict[str, str | int]:
+    return slc_components_table[slc_components_table['POLY_ID'] == id_polygon].sort_values(
+        by='PERCENT_', ascending=False).iloc[0].to_dict()
+
+
+def get_soil_layer_table(
+        id_soil: str,
+        slc_soil_layer_table: DataFrame
+) -> DataFrame:
+    return slc_soil_layer_table[slc_soil_layer_table['SOIL_ID'] == id_soil].sort_values(by='UDEPTH', ascending=True)
+
+
+def get_first_non_litter_layer(
+        soil_layer_table: DataFrame
+) -> dict:
+    return soil_layer_table[soil_layer_table['UDEPTH'] >= 0].iloc[0].to_dict()
+
+
+def get_soil_name_table(
+        soil_name_table: DataFrame,
+        id_soil: str
+) -> dict:
+    return soil_name_table.set_index('SOIL_ID').loc[id_soil].to_dict()