pyholos 0.0.1__py3-none-any.whl

pyholos/farm/farm_settings.py

@@ -0,0 +1,542 @@
+from pathlib import Path
+from typing import Any
+
+from pyholos.common import HolosVar
+from pyholos.core_constants import CoreConstants
+from pyholos.defaults import Defaults
+from pyholos.farm.enums import (CarbonModellingStrategies,
+                                ChosenClimateAcquisition,
+                                YieldAssignmentMethod)
+from pyholos.soil import set_soil_properties
+
+
+class FarmSettingsVar(HolosVar):
+    def __init__(
+            self,
+            name: str,
+            value: Any
+    ):
+        super().__init__(
+            name=name,
+            value=value)
+
+    def to_text(self):
+        return f'{self.name} = {self.value}'
+
+
+class ParamGeneric:
+    def __init__(self, title: str):
+        self.title = f'# {title}'
+
+    def to_list(self) -> list[str]:
+        return [self.title] + [getattr(self, v).to_text() for v in self.__dict__ if
+                               (not v.startswith(('title', '_', '__')) and not callable(v))]
+
+
+class ParamsGeneral(ParamGeneric):
+    def __init__(
+            self,
+            polygon_id: int,
+            latitude: float,
+            longitude: float,
+            carbon_concentration: float = 0.45,
+            emergence_day: int = 141,
+            ripening_day: int = 197,
+            variance: float | float = 300,
+            alfa: float = 0.7,
+            decomposition_minimum_temperature: float = -3.78,
+            decomposition_maximum_temperature: float = 30,
+            moisture_response_function_at_saturation: float = 0.42,
+            moisture_response_function_at_wilting_point: float = 0.18,
+            **kwargs
+    ):
+        super().__init__(title="General")
+
+        self.yield_assignment_method = FarmSettingsVar(
+            name="Yield Assignment Method", value=YieldAssignmentMethod.SmallAreaData.name)
+        self.polygon_number = FarmSettingsVar(name="Polygon Number", value=polygon_id)
+        self.latitude = FarmSettingsVar(name="Latitude", value=latitude)
+        self.Longitude = FarmSettingsVar(name="Longitude", value=longitude)
+        self.carbon_concentration = FarmSettingsVar(name="Carbon Concentration  (kg kg^-1)", value=carbon_concentration)
+        self.emergence_day = FarmSettingsVar(name="Emergence Day", value=emergence_day)
+        self.ripening_day = FarmSettingsVar(name="Ripening Day", value=ripening_day)
+        self.variance = FarmSettingsVar(name="Variance", value=variance)
+        self.alfa = FarmSettingsVar(name="Alfa", value=alfa)
+        self.decomposition_minimum_temperature = FarmSettingsVar(
+            name="Decomposition Minimum Temperature  (°C)", value=decomposition_minimum_temperature)
+        self.decomposition_maximum_temperature = FarmSettingsVar(
+            name="Decomposition Maximum Temperature  (°C) ", value=decomposition_maximum_temperature)
+        self.moisture_response_function_at_saturation = FarmSettingsVar(
+            name="Moisture Response Function At Saturation", value=moisture_response_function_at_saturation)
+        self.moisture_response_function_at_wilting_point = FarmSettingsVar(
+            name="Moisture Response Function At Wilting Point", value=moisture_response_function_at_wilting_point)
+
+        pass
+
+
+class ParamsAnnualCrops(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_returned_to_soil_for_annuals: int | float = 2,
+            percentage_of_straw_returned_to_soil_for_annuals: int | float = 100,
+            percentage_of_roots_returned_to_soil_for_annuals: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Annual Crops")
+
+        self.percentage_of_product_returned_to_soil_for_annuals = FarmSettingsVar(
+            name="Percentage Of Product Returned To Soil For Annuals",
+            value=percentage_of_product_returned_to_soil_for_annuals)
+        self.percentage_of_straw_returned_to_soil_for_annuals = FarmSettingsVar(
+            name="Percentage Of Straw Returned To Soil For Annuals",
+            value=percentage_of_straw_returned_to_soil_for_annuals)
+        self.percentage_of_roots_returned_to_soil_for_annuals = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Annuals",
+            value=percentage_of_roots_returned_to_soil_for_annuals)
+
+
+class ParamsSilageCrops(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_yield_returned_to_soil_for_silage_crops: int | float = 35,
+            percentage_of_roots_returned_to_soil_for_silage_crops: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Silage Crops")
+
+        self.percentage_of_product_yield_returned_to_soil_for_silage_crops = FarmSettingsVar(
+            name="Percentage Of Product Yield Returned To Soil For Silage Crops",
+            value=percentage_of_product_yield_returned_to_soil_for_silage_crops)
+        self.percentage_of_roots_returned_to_soil_for_silage_crops = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Silage Crops",
+            value=percentage_of_roots_returned_to_soil_for_silage_crops)
+
+
+class ParamsCoverCrops(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_yield_returned_to_soil_for_cover_crops: int | float = 100,
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_forage: int | float = 35,
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_produce: int | float = 0,
+            percentage_of_straw_returned_to_soil_for_cover_crops: int | float = 100,
+            percentage_of_roots_returned_to_soil_for_cover_crops: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Cover Crops")
+
+        self.percentage_of_product_yield_returned_to_soil_for_cover_crops = FarmSettingsVar(
+            name="Percentage Of Product Yield Returned To Soil For Cover Crops",
+            value=percentage_of_product_yield_returned_to_soil_for_cover_crops)
+        self.percentage_of_product_yield_returned_to_soil_for_cover_crops_forage = FarmSettingsVar(
+            name="Percentage Of Product Yield Returned To Soil For Cover Crops Forage",
+            value=percentage_of_product_yield_returned_to_soil_for_cover_crops_forage)
+        self.percentage_of_product_yield_returned_to_soil_for_cover_crops_produce = FarmSettingsVar(
+            name="Percentage Of Product Yield Returned To Soil For Cover Crops Produce",
+            value=percentage_of_product_yield_returned_to_soil_for_cover_crops_produce)
+        self.percentage_of_straw_returned_to_soil_for_cover_crops = FarmSettingsVar(
+            name="Percentage Of Straw Returned To Soil For Cover Crops",
+            value=percentage_of_straw_returned_to_soil_for_cover_crops)
+        self.percentage_of_roots_returned_to_soil_for_cover_crops = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Cover Crops",
+            value=percentage_of_roots_returned_to_soil_for_cover_crops)
+
+
+class ParamsRootCrops(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_returned_to_soil_for_root_crops: int | float = 0,
+            percentage_of_straw_returned_to_soil_for_root_crops: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Root Crops")
+
+        self.percentage_of_product_returned_to_soil_for_root_crops = FarmSettingsVar(
+            name="Percentage Of Product Returned To Soil For Root Crops",
+            value=percentage_of_product_returned_to_soil_for_root_crops)
+        self.percentage_of_straw_returned_to_soil_for_root_crops = FarmSettingsVar(
+            name="Percentage Of Straw Returned To Soil For Root Crops",
+            value=percentage_of_straw_returned_to_soil_for_root_crops)
+
+
+class ParamsPerennialCrops(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_returned_to_soil_for_perennials: int | float = 35,
+            percentage_of_roots_returned_to_soil_for_perennials: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Perennial Crops")
+
+        self.percentage_of_product_returned_to_soil_for_perennials = FarmSettingsVar(
+            name="Percentage Of Product Returned To Soil For Perennials",
+            value=percentage_of_product_returned_to_soil_for_perennials)
+        self.percentage_of_roots_returned_to_soil_for_perennials = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Perennials",
+            value=percentage_of_roots_returned_to_soil_for_perennials)
+
+
+class ParamsRangeland(ParamGeneric):
+    def __init__(
+            self,
+            percentage_of_product_returned_to_soil_for_rangeland_due_to_harvest_loss: int | float = 35,
+            percentage_of_roots_returned_to_soil_for_rangeland: int | float = 100,
+            **kwargs
+    ):
+        super().__init__(title="Rangeland")
+        self.percentage_of_product_returned_to_soil_for_rangeland_due_to_harvest_loss = FarmSettingsVar(
+            name="Percentage Of Product Returned To Soil For Rangeland Due To Harvest Loss",
+            value=percentage_of_product_returned_to_soil_for_rangeland_due_to_harvest_loss)
+        self.percentage_of_roots_returned_to_soil_for_rangeland = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Rangeland",
+            value=percentage_of_roots_returned_to_soil_for_rangeland)
+
+
+class ParamsFodderCorn(ParamGeneric):
+    def __init__(
+            self,
+            run_in_period_years: int,
+            percentage_of_product_returned_to_soil_for_fodder_corn: int | float = 35,
+            percentage_of_roots_returned_to_soil_for_fodder_corn: int | float = 100,
+            decomposition_rate_constant_young_pool: float = 0.8,
+            decomposition_rate_constant_old_pool: float = 0.00605,
+            old_pool_carbon_n: float = 0.1,
+            no_ratio: float = 0.1,
+            emission_factor_for_leaching_and_runoff: float = 0.011,
+            emission_factor_for_volatilization: float = 0.01,
+            fraction_of_n_lost_by_volatilization: float = 0.21,
+            microbe_death: float = 0.2,
+            denitrification: float = 0.5,
+            **kwargs
+    ):
+        super().__init__(title="Fodder Corn")
+        self.percentage_of_product_returned_to_soil_for_fodder_corn = FarmSettingsVar(
+            name="Percentage Of Product Returned To Soil For Fodder Corn",
+            value=percentage_of_product_returned_to_soil_for_fodder_corn)
+        self.percentage_of_roots_returned_to_soil_for_fodder_corn = FarmSettingsVar(
+            name="Percentage Of Roots Returned To Soil For Fodder Corn",
+            value=percentage_of_roots_returned_to_soil_for_fodder_corn)
+        self.decomposition_rate_constant_young_pool = FarmSettingsVar(
+            name="Decomposition Rate Constant Young Pool",
+            value=decomposition_rate_constant_young_pool)
+        self.decomposition_rate_constant_old_pool = FarmSettingsVar(
+            name="Decomposition Rate Constant Old Pool",
+            value=decomposition_rate_constant_old_pool)
+        self.old_pool_carbon_n = FarmSettingsVar(
+            name="Old Pool Carbon N",
+            value=old_pool_carbon_n)
+        self.no_ratio = FarmSettingsVar(
+            name="NO Ratio",
+            value=no_ratio)
+        self.emission_factor_for_leaching_and_runoff = FarmSettingsVar(
+            name="Emission Factor For Leaching And Runoff  (kg N2O-N (kg N)^-1)",
+            value=emission_factor_for_leaching_and_runoff)
+        self.emission_factor_for_volatilization = FarmSettingsVar(
+            name="Emission Factor For Volatilization  (kg N2O-N (kg N)^-1)",
+            value=emission_factor_for_volatilization)
+        self.fraction_of_n_lost_by_volatilization = FarmSettingsVar(
+            name="Fraction Of N Lost By Volatilization",
+            value=fraction_of_n_lost_by_volatilization)
+        self.microbe_death = FarmSettingsVar(
+            name="Microbe Death",
+            value=microbe_death)
+        self.denitrification = FarmSettingsVar(
+            name="Denitrification",
+            value=denitrification)
+        self.carbon_modelling_strategy = FarmSettingsVar(
+            name="Carbon modelling strategy",
+            value=CarbonModellingStrategies.ICBM.name)
+        self.run_in_period_years = FarmSettingsVar(
+            name="Run In Period Years",
+            value=run_in_period_years)
+
+
+class ParamsIcbm(ParamGeneric):
+    def __init__(
+            self,
+            humification_coefficient_above_ground: float = 0.125,
+            humification_coefficient_below_ground: float = 0.3,
+            humification_coefficient_manure: float = 0.31,
+            climate_filename: str = "climate.csv",
+            climate_data_acquisition: str = "NASA",
+            enable_carbon_modelling: bool = True,
+            **kwargs
+    ):
+        super().__init__(title="ICBM/Climate")
+        self.humification_coefficient_above_ground = FarmSettingsVar(
+            name="Humification Coefficient Above Ground",
+            value=humification_coefficient_above_ground)
+        self.humification_coefficient_below_ground = FarmSettingsVar(
+            name="Humification Coefficient Below Ground",
+            value=humification_coefficient_below_ground)
+        self.humification_coefficient_manure = FarmSettingsVar(
+            name="Humification Coefficient Manure",
+            value=humification_coefficient_manure)
+        self.climate_filename = FarmSettingsVar(
+            name="Climate filename",
+            value=climate_filename)
+        self.climate_data_acquisition = FarmSettingsVar(
+            name="Climate Data Acquisition",
+            value=climate_data_acquisition)
+        self.use_climate_parameter_instead_of_management_factor = FarmSettingsVar(
+            name="Use climate parameter instead of management factor",
+            value=True)
+        self.enable_carbon_modelling = FarmSettingsVar(
+            name="Enable Carbon Modelling",
+            value=enable_carbon_modelling)
+
+
+class MonthlyWeather(ParamGeneric):
+    def __init__(
+            self,
+            title: str,
+            variable_name: str,
+            variable_monthly_values: list[int | float],
+            months_of_growing_season: list[str] = ("may", "june", "july", "august", "september", "october"),
+            **kwargs
+    ):
+        super().__init__(title=title)
+
+        self._months_of_growing_season = months_of_growing_season
+        self._months = ["january", "february", "march", "april", "may", "june",
+                        "july", "august", "september", "october", "november", "december"]
+        for month, value in zip(self._months, variable_monthly_values):
+            setattr(self, month, FarmSettingsVar(name=f'{month.capitalize()} {variable_name}', value=value))
+
+    def calc_seasonal_sum(self) -> float:
+        return sum([getattr(self, month).value for month in self._months_of_growing_season])
+
+    def calc_seasonal_average(self) -> float:
+        return self.calc_seasonal_sum() / len(self._months_of_growing_season)
+
+    def calc_annual_sum(self) -> float:
+        return sum([getattr(self, month).value for month in self._months])
+
+    def calc_annual_average(self) -> float:
+        return sum([getattr(self, month).value for month in self._months]) / 12.
+
+
+class ParamsSoil(ParamGeneric):
+    def __init__(
+            self,
+            year: int,
+            **kwargs
+    ):
+        super().__init__(title="Soil Data")
+
+        self.province = FarmSettingsVar(name="Province", value=kwargs['province'])
+        self.year = FarmSettingsVar(name="Year Of Observation", value=year)
+        self.ecodistrict_id = FarmSettingsVar(name="Ecodistrict ID", value=kwargs['ecodistrict_id'])
+        self.soil_great_group = FarmSettingsVar(
+            name="Soil Great Group", value=kwargs['soil_great_group'])
+        self.soil_functional_category = FarmSettingsVar(
+            name="Soil functional category", value=kwargs['soil_functional_category'])
+        self.bulk_density = FarmSettingsVar(
+            name="Bulk Density", value=kwargs['bulk_density'])
+        self.soil_texture = FarmSettingsVar(
+            name="Soil Texture", value=kwargs['soil_texture'])
+        self.soil_ph = FarmSettingsVar(
+            name="Soil Ph", value=kwargs['soil_ph'])
+        self.top_layer_thickness = FarmSettingsVar(
+            name="Top Layer Thickness  (mm)", value=kwargs['top_layer_thickness'])
+        self.proportion_of_sand_in_soil = FarmSettingsVar(
+            name="Proportion Of Sand In Soil", value=kwargs['sand_proportion'])
+        self.proportion_of_clay_in_soil = FarmSettingsVar(
+            name="Proportion Of Clay In Soil", value=kwargs['clay_proportion'])
+        self.proportion_of_soil_organic_carbon = FarmSettingsVar(
+            name="Proportion Of Soil Organic Carbon", value=kwargs['organic_carbon_proportion'])
+
+
+class ParamsFarmSettings:
+    def __init__(
+            self,
+            year: int,
+            latitude: float,
+            longitude: float,
+            monthly_precipitation: list,
+            monthly_potential_evapotranspiration: list,
+            monthly_temperature: list,
+
+            run_in_period_years: int = Defaults.DefaultRunInPeriod,
+
+            carbon_concentration: float = CoreConstants.CarbonConcentration,
+            emergence_day: int = Defaults.EmergenceDay,
+            ripening_day: int = Defaults.RipeningDay,
+            variance: int | float = Defaults.Variance,
+            alfa: float = Defaults.Alfa,
+            decomposition_minimum_temperature: float = Defaults.DecompositionMinimumTemperature,
+            decomposition_maximum_temperature: float = Defaults.DecompositionMaximumTemperature,
+            moisture_response_function_at_saturation: float = Defaults.MoistureResponseFunctionAtSaturation,
+            moisture_response_function_at_wilting_point: float = Defaults.MoistureResponseFunctionAtWiltingPoint,
+
+            percentage_of_product_returned_to_soil_for_annuals: int | float = Defaults.PercentageOfProductReturnedToSoilForAnnuals,
+            percentage_of_straw_returned_to_soil_for_annuals: int | float = Defaults.PercentageOfStrawReturnedToSoilForAnnuals,
+            percentage_of_roots_returned_to_soil_for_annuals: int | float = Defaults.PercentageOfRootsReturnedToSoilForAnnuals,
+
+            percentage_of_product_yield_returned_to_soil_for_silage_crops: int | float = Defaults.PercentageOfProductYieldReturnedToSoilForSilageCrops,
+            percentage_of_roots_returned_to_soil_for_silage_crops: int | float = Defaults.PercentageOfRootsReturnedToSoilForSilageCrops,
+
+            percentage_of_product_yield_returned_to_soil_for_cover_crops: int | float = Defaults.PercentageOfProductYieldReturnedToSoilForCoverCrops,
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_forage: int | float = Defaults.PercentageOfProductYieldReturnedToSoilForCoverCropsForage,
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_produce: int | float = Defaults.PercentageOfProductYieldReturnedToSoilForCoverCropsProduce,
+            percentage_of_straw_returned_to_soil_for_cover_crops: int | float = Defaults.PercentageOfStrawReturnedToSoilForCoverCrops,
+            percentage_of_roots_returned_to_soil_for_cover_crops: int | float = Defaults.PercentageOfRootsReturnedToSoilForCoverCrops,
+
+            percentage_of_product_returned_to_soil_for_root_crops: int | float = Defaults.PercentageOfProductReturnedToSoilForRootCrops,
+            percentage_of_straw_returned_to_soil_for_root_crops: int | float = Defaults.PercentageOfStrawReturnedToSoilForRootCrops,
+
+            percentage_of_product_returned_to_soil_for_perennials: int | float = Defaults.PercentageOfProductReturnedToSoilForPerennials,
+            percentage_of_roots_returned_to_soil_for_perennials: int | float = Defaults.PercentageOfRootsReturnedToSoilForPerennials,
+
+            percentage_of_product_returned_to_soil_for_rangeland_due_to_harvest_loss: int | float = Defaults.PercentageOfProductReturnedToSoilForRangelandDueToHarvestLoss,
+            percentage_of_roots_returned_to_soil_for_rangeland: int | float = Defaults.PercentageOfRootsReturnedToSoilForRangeland,
+
+            percentage_of_product_returned_to_soil_for_fodder_corn: int | float = Defaults.PercentageOfProductReturnedToSoilForFodderCorn,
+            percentage_of_roots_returned_to_soil_for_fodder_corn: int | float = Defaults.PercentageOfRootsReturnedToSoilForFodderCorn,
+            decomposition_rate_constant_young_pool: float = Defaults.DecompositionRateConstantYoungPool,
+            decomposition_rate_constant_old_pool: float = Defaults.DecompositionRateConstantOldPool,
+            old_pool_carbon_n: float = Defaults.OldPoolCarbonN,
+            no_ratio: float = Defaults.NORatio,
+            emission_factor_for_leaching_and_runoff: float = Defaults.EmissionFactorForLeachingAndRunoff,
+            emission_factor_for_volatilization: float = Defaults.EmissionFactorForVolatilization,
+            fraction_of_n_lost_by_volatilization: float = Defaults.FractionOfNLostByVolatilization,
+            microbe_death: float = Defaults.MicrobeDeath,
+            denitrification: float = Defaults.Denitrification,
+
+            humification_coefficient_above_ground: float = Defaults.HumificationCoefficientAboveGround,
+            humification_coefficient_below_ground: float = Defaults.HumificationCoefficientBelowGround,
+            humification_coefficient_manure: float = Defaults.HumificationCoefficientManure,
+            climate_filename: str = "climate.csv",
+            climate_data_acquisition: str = ChosenClimateAcquisition.NASA.name,
+            enable_carbon_modelling: bool = True,
+    ):
+        """
+
+        Args:
+            year: year of observation
+            latitude: (decimal degrees) latitude of the farm centroid
+            longitude: (decimal degrees) longitude of the farm centroid
+            monthly_precipitation: (mm) precipitation sum for each month of the year
+            monthly_potential_evapotranspiration: (mm) potential precipitation sum for each month of the year
+            monthly_temperature: (mm) air temperature average for each month of the year
+            run_in_period_years: number of simulated years for carbon modelling
+            carbon_concentration: (kg kg-1) carbon concentration in soil
+
+            emergence_day:
+            ripening_day:
+            variance:
+            alfa:
+            decomposition_minimum_temperature:
+            decomposition_maximum_temperature:
+            moisture_response_function_at_saturation:
+            moisture_response_function_at_wilting_point:
+
+            percentage_of_product_returned_to_soil_for_annuals: [0, 100] product returned to soil for annuals
+            percentage_of_straw_returned_to_soil_for_annuals: [0, 100] straw returned to soil for annuals
+            percentage_of_roots_returned_to_soil_for_annuals: [0, 100] roots returned to soil for annuals
+            percentage_of_product_yield_returned_to_soil_for_silage_crops: [0, 100] product returned to soil for silage corn
+            percentage_of_roots_returned_to_soil_for_silage_crops: [0, 100] roots returned to soil for silage corn
+            percentage_of_product_yield_returned_to_soil_for_cover_crops: [0, 100] product returned to soil for cover crops
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_forage: [0, 100] product returned to soil for cover crops forage
+            percentage_of_product_yield_returned_to_soil_for_cover_crops_produce: [0, 100] product returned to soil for cover crops produce
+            percentage_of_straw_returned_to_soil_for_cover_crops: [0, 100] straw returned to soil for cover crops
+            percentage_of_roots_returned_to_soil_for_cover_crops: [0, 100] roots returned to soil for cover crops
+            percentage_of_product_returned_to_soil_for_root_crops: [0, 100] product returned to soil for root crops
+            percentage_of_straw_returned_to_soil_for_root_crops: [0, 100] straw returned to soil for root crops
+            percentage_of_product_returned_to_soil_for_perennials: [0, 100] product returned to soil for perennials
+            percentage_of_roots_returned_to_soil_for_perennials: [0, 100] roots returned to soil for perennials
+            percentage_of_product_returned_to_soil_for_rangeland_due_to_harvest_loss: [0, 100] product returned to soil for rangeland
+            percentage_of_roots_returned_to_soil_for_rangeland: [0, 100] product returned to soil for rangeland
+            percentage_of_product_returned_to_soil_for_fodder_corn: [0, 100] product returned to soil for fodder corn
+            percentage_of_roots_returned_to_soil_for_fodder_corn: [0, 100] roots returned to soil for fodder corn
+
+            decomposition_rate_constant_young_pool: (?) Decomposition Rate Constant Young Pool
+            decomposition_rate_constant_old_pool:
+            old_pool_carbon_n:
+            no_ratio:
+
+            emission_factor_for_leaching_and_runoff: (kg(N2O-N) kg(N)-1) emission factor for leaching and runoff
+            emission_factor_for_volatilization: (kg(N2O-N) kg(N)-1) emission factor for volatilization
+
+            fraction_of_n_lost_by_volatilization: (?) Fraction Of N Lost By Volatilization
+            microbe_death:
+            denitrification:
+
+            humification_coefficient_above_ground:
+            humification_coefficient_below_ground:
+            humification_coefficient_manure:
+
+            climate_filename: name of the file containing the climate data (e.g. "climate.csv")
+            climate_data_acquisition: name of the provider of climate data (e.g. "NASA")
+            enable_carbon_modelling: whether to enable carbon modelling with ICBM (default to True)
+
+        Notes:
+            The carbon modelling strategy can be one of ["IPCCTier2", "ICBM"]. In this first version, this parameter is forced to "ICBM".
+
+        """
+
+        kwargs = {k: v for k, v in locals().items() if all([not k.startswith(('_', '__', 'self')), not callable(k)])}
+
+        soil_properties = set_soil_properties(
+            latitude=latitude,
+            longitude=longitude)
+
+        self.params_general = ParamsGeneral(
+            polygon_id=soil_properties.pop('id_polygon'),
+            **kwargs)
+
+        # Annual Crops
+        self.params_annual_crops = ParamsAnnualCrops(**kwargs)
+
+        # Silage Crops
+        self.params_silage_crops = ParamsSilageCrops(**kwargs)
+
+        # Cover Crops
+        self.params_cover_crops = ParamsCoverCrops(**kwargs)
+
+        # Root crops
+        self.params_root_crops = ParamsRootCrops(**kwargs)
+
+        # Perennial Crops
+        self.params_perennial_crops = ParamsPerennialCrops(**kwargs)
+
+        # Rangeland
+        self.params_rangeland = ParamsRangeland(**kwargs)
+
+        # Fodder Corn
+        self.params_fodder_corn = ParamsFodderCorn(**kwargs)
+
+        # ICBM/Climate
+        self.params_icbm = ParamsIcbm(**kwargs)
+
+        # Precipitation Data (mm)
+        self.params_weather_precipitation = MonthlyWeather(
+            title="Precipitation Data (mm)",
+            variable_name="Precipitation",
+            variable_monthly_values=[int(round(v, 0)) for v in monthly_precipitation])
+
+        # Precipitation Data (mm)
+        self.params_weather_potential_evapotranspiration = MonthlyWeather(
+            title="Evapotranspiration Data (mm year^-1)",
+            variable_name="Potential Evapotranspiration",
+            variable_monthly_values=[int(round(v, 0)) for v in monthly_potential_evapotranspiration])
+
+        # Temperature Data (°C)
+        self.params_weather_temperature = MonthlyWeather(
+            title="Temperature Data (°C)",
+            variable_name="Mean Temperature",
+            variable_monthly_values=[round(v, 2) for v in monthly_temperature])
+
+        # Soil Data
+        self.params_soil = ParamsSoil(
+            year=year,
+            **soil_properties)
+
+    def get_params(self) -> list[ParamGeneric]:
+        return [getattr(self, v) for v in self.__dict__ if all([not v.startswith(('_', '__')), not callable(v)])]
+
+    def write(self, path_dir_farm: Path):
+        sections = self.get_params()
+        res = [x for y in [v.to_list() + [''] for v in sections[:-1]] for x in y] + sections[-1].to_list()
+        with (path_dir_farm / 'Farm.settings').open(mode='w', encoding='utf-8') as f:
+            f.writelines('\n'.join(res))
+        pass

pyholos/launching.py

@@ -0,0 +1,86 @@
+import subprocess
+from pathlib import Path, PureWindowsPath
+
+from pyholos.config import PATH_HOLOS_CLI
+from pyholos.utils import print_holos_msg
+
+
+def set_cmd(
+        path_dir_farms: Path,
+        path_dir_outputs: Path = None,
+        name_farm_json: str = None,
+        name_dir_farms_json: str = None,
+        name_settings: str = None,
+        id_slc_polygon: int = None,
+) -> list[str]:
+    cmd = [
+        'cmd', '/c',
+        str(PureWindowsPath(PATH_HOLOS_CLI)),
+        str(PureWindowsPath(path_dir_farms)),
+        '-u',
+        'metric'
+    ]
+
+    if path_dir_outputs is not None:
+        cmd += ['-o', path_dir_outputs]
+
+    if name_farm_json is not None:
+        cmd += ['-i', name_farm_json]
+
+    if name_dir_farms_json is not None:
+        cmd += ['-f', name_dir_farms_json]
+
+    if name_settings is not None:
+        if any([name_farm_json is not None, name_dir_farms_json is not None]):
+            cmd += ['-s', name_settings]
+
+    if id_slc_polygon is not None:
+        cmd += ['-p', str(int(id_slc_polygon))]
+
+    return cmd
+
+
+def launch_holos(
+        path_dir_farms: Path,
+        path_dir_outputs: Path = None,
+        name_farm_json: str = None,
+        name_dir_farms_json: str = None,
+        name_settings: str = None,
+        id_slc_polygon: int = None,
+        is_print_holos_messages: bool = False
+) -> None:
+    cmd = set_cmd(
+        path_dir_farms=path_dir_farms,
+        path_dir_outputs=path_dir_outputs,
+        name_farm_json=name_farm_json,
+        name_dir_farms_json=name_dir_farms_json,
+        name_settings=name_settings,
+        id_slc_polygon=id_slc_polygon
+    )
+
+    process = subprocess.Popen(
+        cmd,
+        stdin=subprocess.PIPE,
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        text=True)
+
+    for msg in _get_cli_messages(p=process):
+        print_holos_msg(is_print_message=is_print_holos_messages, holos_message=msg)
+
+        if msg.startswith("Do you have farms that you would like to import from the Holos GUI? (yes/no)"):
+            process.stdin.write('no\n')
+            process.stdin.flush()
+        if "press enter to exit" in msg:
+            process.stdin.write('\n')
+            process.stdin.flush()
+    pass
+
+
+def _get_cli_messages(p: subprocess.Popen) -> str:
+    while True:
+        # returns None while subprocess is running
+        return_code = p.poll()
+        yield p.stdout.readline()
+        if return_code is not None:
+            break