pyholos 0.0.1__py3-none-any.whl

pyholos/defaults.py

@@ -0,0 +1,116 @@
+from pyholos.core_constants import CoreConstants
+
+
+class Defaults:
+    EmissionFactorForLeachingAndRunoff = 0.011  # Updated to IPCC 2019 value
+    """(kg(N2O-N) kg(N)-1) emission factor for leaching and runoff"""
+
+    PercentageOfProductReturnedToSoilForPerennials = 35
+    """(%) percentage of the perennial crops biomass returned to soil after harvest"""
+
+    PercentageOfRootsReturnedToSoilForPerennials = 100
+    """(%) percentage of the perennial crops root biomass returned to soil after harvest"""
+
+    PercentageOfProductReturnedToSoilForAnnuals = 2
+    """(%) percentage of the annual crops biomass returned to soil after harvest"""
+
+    PercentageOfRootsReturnedToSoilForAnnuals = 100
+    """(%) percentage of the annual crops root biomass returned to soil after harvest"""
+
+    PercentageOfStrawReturnedToSoilForAnnuals = 100
+    """(%) percentage of the annual crops straw biomass returned to soil after harvest"""
+
+    PercentageOfProductReturnedToSoilForRootCrops = 0
+    """(%) percentage of the root crops biomass returned to soil after harvest"""
+
+    PercentageOfStrawReturnedToSoilForRootCrops = 100
+    """(%) percentage of the root crops straw biomass returned to soil after harvest"""
+
+    PercentageOfProductYieldReturnedToSoilForSilageCrops = 35
+    """(%) percentage of the silage crops biomass returned to soil after harvest"""
+
+    PercentageOfRootsReturnedToSoilForSilageCrops = 100
+    """(%) percentage of the annual crops root biomass returned to soil after harvest"""
+
+    PercentageOfProductYieldReturnedToSoilForCoverCrops = 100
+    """(%) percentage of the cover crops biomass returned to soil after harvest"""
+
+    PercentageOfProductYieldReturnedToSoilForCoverCropsForage = 35
+    """(%) percentage of the cover crops forage biomass returned to soil after harvest"""
+
+    PercentageOfProductYieldReturnedToSoilForCoverCropsProduce = 0
+    """(%) percentage of the cover crops produce biomass returned to soil after harvest"""
+
+    PercentageOfStrawReturnedToSoilForCoverCrops = 100
+    """(%) percentage of the cover crops straw biomass returned to soil after harvest"""
+
+    PercentageOfRootsReturnedToSoilForCoverCrops = 100
+    """(%) percentage of the cover crops root biomass returned to soil after harvest"""
+
+    PercentageOfProductReturnedToSoilForRangelandDueToHarvestLoss = 35
+    """(%) percentage of the rangeland product biomass returned to soil due to harvest loss"""
+
+    PercentageOfProductReturnedToSoilForRangelandDueToGrazingLoss = CoreConstants.ValueNotDetermined
+    """(%) percentage of the rangeland product biomass returned to soil due to grazing loss"""
+
+    PercentageOfRootsReturnedToSoilForRangeland = 100
+    """(%) percentage of the rangeland root biomass returned to soil after harvest"""
+
+    PercentageOfProductReturnedToSoilForFodderCorn = 35
+    """(%) percentage of the fodder corn product biomass returned to soil after harvest"""
+
+    PercentageOfRootsReturnedToSoilForFodderCorn = 100
+    """(%) percentage of the fodder corn root biomass returned to soil after harvest"""
+
+    DecompositionRateConstantYoungPool = 0.8
+    DecompositionRateConstantOldPool = 0.00605
+    OldPoolCarbonN = 0.1
+    NORatio = 0.1
+    EmissionFactorForVolatilization = 0.01
+    FractionOfNLostByVolatilization = 0.21
+    MicrobeDeath = 0.2
+    Denitrification = 0.5
+
+    HumificationCoefficientAboveGround = 0.125
+    HumificationCoefficientBelowGround = 0.3
+    HumificationCoefficientManure = 0.31
+
+    DefaultRunInPeriod = 15
+
+    CarbonConcentration = CoreConstants.CarbonConcentration
+
+    # for annual crops
+    EmergenceDay = 141
+    """(julian day) day of plant emergence for annual crops"""
+
+    RipeningDay = 197
+    """(julian day) day of plant ripening for annual crops"""
+
+    Variance = 300
+    """width of distribution function for annual crops"""
+
+    # for perennial crops
+    EmergenceDayForPerennials = 75
+    """(julian day) day of plant emergence for perennial crops"""
+
+    RipeningDayForPerennials = 300
+    """(julian day) day of plant ripening for perennial crops"""
+
+    VarianceForPerennials = 1500
+    """width of distribution function for perennial crops"""
+
+    # for all crops
+    Alfa = 0.7
+    """(-) minimum water storage fraction of wilting_point"""
+
+    DecompositionMinimumTemperature = -3.78
+    """(degree Celsius) maximum cardinal temperature for decomposition"""
+
+    DecompositionMaximumTemperature = 30
+    """(degree Celsius) minimum cardinal temperature for decomposition"""
+
+    MoistureResponseFunctionAtWiltingPoint = 0.18
+    """(mm3/mm3) soil volumetric water content at reference wilting point"""
+
+    MoistureResponseFunctionAtSaturation = 0.42
+    """(mm3/mm3) soil volumetric water content at reference saturation"""

pyholos/farm/enums.py

@@ -0,0 +1,54 @@
+from enum import StrEnum, auto
+
+
+class YieldAssignmentMethod(StrEnum):
+    """Used to lookup default yields for a particular year and crop type.
+
+    Holos source code:
+        https://github.com/holos-aafc/Holos/blob/768b3d8fe2565dad0ba01fb8490974f1047a114f/H.Core/Enumerations/YieldAssignmentMethod.cs#L6
+    """
+    Average = auto()
+    """Takes the average of the yields from the crop view items of the field component"""
+
+    Custom = auto()
+    """Uses the values entered for each year (by the user on the details screen)"""
+
+    CARValue = auto()
+    """Uses CAR region values"""
+
+    InputFile = auto()
+    """Reads a yield input file from the user"""
+
+    InputFileThenAverage = auto()
+    """Reads a yield input file from the user and the use the average of all crops in rotation"""
+
+    SmallAreaData = auto()
+    """Use Small Area Data (SAD) yields (https://open.canada.ca/data/en/dataset/65f1cde1-95e0-4a1d-9a1a-c45b2f83a351)"""
+
+
+class CarbonModellingStrategies(StrEnum):
+    """
+    Holos source code:
+        https://github.com/holos-aafc/Holos/blob/768b3d8fe2565dad0ba01fb8490974f1047a114f/H.Core/Enumerations/CarbonModellingStrategies.cs#L11
+    """
+    IPCCTier2 = auto()
+    ICBM = auto()
+
+
+class ChosenClimateAcquisition(StrEnum):
+    """
+    Holos source code:
+        https://github.com/holos-aafc/Holos/blob/768b3d8fe2565dad0ba01fb8490974f1047a114f/H.Core/Models/Farm.cs#L36C1-L58C10
+    """
+    SLC = auto()
+    """Uses the 'old' default (non-daily) temperatures where normals were used to extract daily values.
+    This is deprecated in favor of NASA climate data"""
+
+    Custom = auto()
+    """Used with the CLI where the user can specify default monthly values in a climate settings file"""
+
+    NASA = auto()
+    """Daily climate data is downloaded from NASA website API"""
+
+    InputFile = auto()
+    """Used with the CLI where the user can specify default daily values in a custom CSV file"""

pyholos/farm/farm.py

@@ -0,0 +1,101 @@
+from pathlib import Path
+
+from pandas import DataFrame
+
+from pyholos.components.common import convert_province_name
+from pyholos.farm.farm_inputs import (BeefCattleInput, DairyCattleInput,
+                                      FieldsInput, SheepFlockInput,
+                                      WeatherSummary)
+from pyholos.farm.farm_settings import ParamsFarmSettings
+from pyholos.soil import (convert_soil_functional_category_name,
+                          convert_soil_texture_name)
+
+
+class Farm:
+    def __init__(
+            self,
+            farm_settings: ParamsFarmSettings,
+            beef_cattle_data: BeefCattleInput = None,
+            dairy_cattle_data: DairyCattleInput = None,
+            sheep_flock_data: SheepFlockInput = None,
+            fields_data: FieldsInput = None,
+    ):
+        self.farm_settings = farm_settings
+        self.beef = beef_cattle_data
+        self.dairy = dairy_cattle_data
+        self.sheep = sheep_flock_data
+        self.fields = fields_data
+        self.other_livestock = None
+        self.poultry = None
+        self.shelterbelts = None
+        self.swine = None
+
+    @staticmethod
+    def _set_dir_name(entry: str) -> str:
+        return ' '.join([s.capitalize() for s in entry.split('_')])
+
+    def write_files(
+            self,
+            path_dir_farm: Path
+    ):
+        path_dir_farm.mkdir(parents=True, exist_ok=True)
+        self.farm_settings.write(path_dir_farm=path_dir_farm)
+        for k, v in self.__dict__.items():
+            if (v is not None) and (not isinstance(v, ParamsFarmSettings)):
+                path_dir = path_dir_farm / self._set_dir_name(entry=k)
+                path_dir.mkdir(parents=True, exist_ok=True)
+                dfs = [DataFrame.from_records([v.to_dict() for v in component]) for component in v]
+                for df in dfs:
+                    name_output_file = df['Name'].unique()[0]
+                    df.to_csv(path_dir / f'{name_output_file}.csv', index=False)
+
+
+def create_farm(
+        latitude: float,
+        longitude: float,
+        weather_summary: WeatherSummary,
+        beef_cattle_data: BeefCattleInput = None,
+        dairy_cattle_data: DairyCattleInput = None,
+        sheep_flock_data: SheepFlockInput = None,
+        fields_data: FieldsInput = None,
+) -> Farm:
+    farm = Farm(
+        farm_settings=ParamsFarmSettings(
+            latitude=latitude,
+            longitude=longitude,
+            year=weather_summary.year,
+            monthly_precipitation=weather_summary.monthly_precipitation,
+            monthly_potential_evapotranspiration=weather_summary.monthly_potential_evapotranspiration,
+            monthly_temperature=weather_summary.monthly_temperature)
+    )
+
+    params_soil = farm.farm_settings.params_soil
+
+    province = convert_province_name(name=params_soil.province.value)
+    soil_texture = convert_soil_texture_name(name=params_soil.soil_texture.value)
+
+    if beef_cattle_data is not None:
+        farm.beef = beef_cattle_data.create_components(
+            province=province,
+            soil_texture=soil_texture)
+
+    if dairy_cattle_data is not None:
+        farm.dairy = dairy_cattle_data.create_components(
+            province=province,
+            soil_texture=soil_texture)
+
+    if sheep_flock_data is not None:
+        farm.sheep = sheep_flock_data.create_components(
+            province=province,
+            soil_texture=soil_texture)
+
+    if fields_data is not None:
+        farm.fields = fields_data.create_components(
+            province=province,
+            clay_content=params_soil.proportion_of_clay_in_soil.value,
+            sand_content=params_soil.proportion_of_sand_in_soil.value,
+            organic_carbon_percentage=params_soil.proportion_of_soil_organic_carbon.value,
+            soil_top_layer_thickness=params_soil.top_layer_thickness.value,
+            soil_functional_category=convert_soil_functional_category_name(params_soil.soil_functional_category.value))
+
+    return farm