hestia-earth-models 0.69.1__py3-none-any.whl → 0.70.0__py3-none-any.whl

hestia_earth/models/ipcc2019/nonCo2EmissionsToAirNaturalVegetationBurning.py

@@ -24,6 +24,7 @@ from .biomass_utils import BiomassCategory, get_valid_management_nodes, summaris
 REQUIREMENTS = {
     "Cycle": {
         "site": {
+            "@type": "Site",
             "management": [
                 {
                     "@type": "Management",

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_1.py

@@ -31,7 +31,7 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
-_LOOKUPS = {
+LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": [
         "IPCC_LAND_USE_CATEGORY",
@@ -992,8 +992,8 @@ def _check_soil_category(
     bool
         `True` if the soil category matches, `False` otherwise.
     """
-    SOIL_TYPE_LOOKUP = _LOOKUPS["soilType"]
-    USDA_SOIL_TYPE_LOOKUP = _LOOKUPS["usdaSoilType"]
+    SOIL_TYPE_LOOKUP = LOOKUPS["soilType"]
+    USDA_SOIL_TYPE_LOOKUP = LOOKUPS["usdaSoilType"]
 
     target_lookup_values = IPCC_SOIL_CATEGORY_TO_SOIL_TYPE_LOOKUP_VALUE.get(key, None)
 
@@ -1183,7 +1183,7 @@ def _check_ipcc_land_use_category(*, key: IpccLandUseCategory, land_cover_nodes:
     bool
         `True` if the conditions match the specified land use category, `False` otherwise.
     """
-    LOOKUP = _LOOKUPS["landCover"][0]
+    LOOKUP = LOOKUPS["landCover"][0]
     target_lookup_values = IPCC_LAND_USE_CATEGORY_TO_LAND_COVER_LOOKUP_VALUE.get(key, None)
     valid_lookup = cumulative_nodes_lookup_match(
         land_cover_nodes,
@@ -1340,7 +1340,7 @@ def _check_tillage_ipcc_management_category(
     bool
         `True` if the conditions match the specified management category, `False` otherwise.
     """
-    LOOKUP = _LOOKUPS["tillage"]
+    LOOKUP = LOOKUPS["tillage"]
     target_lookup_values = IPCC_MANAGEMENT_CATEGORY_TO_TILLAGE_MANAGEMENT_LOOKUP_VALUE.get(key, None)
     return cumulative_nodes_lookup_match(
         tillage_nodes,
@@ -1798,9 +1798,9 @@ def _get_carbon_input_kwargs(
         The carbon input keyword arguments.
     """
 
-    PRACTICE_INCREASING_C_INPUT_LOOKUP = _LOOKUPS["landUseManagement"]
-    LOW_RESIDUE_PRODUCING_CROP_LOOKUP = _LOOKUPS["landCover"][1]
-    N_FIXING_CROP_LOOKUP = _LOOKUPS["landCover"][2]
+    PRACTICE_INCREASING_C_INPUT_LOOKUP = LOOKUPS["landUseManagement"]
+    LOW_RESIDUE_PRODUCING_CROP_LOOKUP = LOOKUPS["landCover"][1]
+    N_FIXING_CROP_LOOKUP = LOOKUPS["landCover"][2]
 
     # To prevent double counting already explicitly checked practices.
     EXCLUDED_PRACTICE_TERM_IDS = {

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_2.py

@@ -33,7 +33,7 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
-_LOOKUPS = {
+LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": "IPCC_LAND_USE_CATEGORY",
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY"
@@ -1173,7 +1173,7 @@ def _compile_inventory(
     TODO: implement long-term average climate data and annual climate data as back ups for monthly data
     TODO: implement randomisation for `irrigationMonthly` if `startDate` and `endDate` are not provided
     """
-    grouped_cycles = group_nodes_by_year(cycles)
+    grouped_cycles = group_nodes_by_year(cycles, include_spillovers=True)
     grouped_measurements = group_nodes_by_year(measurement_nodes, mode=GroupNodesByYearMode.DATES)
 
     grouped_climate_data = _get_grouped_climate_measurements(grouped_measurements)
@@ -1322,9 +1322,23 @@ def _get_carbon_sources(cycle: dict) -> list[CarbonSource]:
         A formatted list of `CarbonSource`s.
     """
     inputs_and_products = cycle.get("inputs", []) + cycle.get("products", [])
+
+    group_fac = cycle.get('fraction_of_group_duration')
+    node_fac = cycle.get('fraction_of_node_duration')
+
+    scaling_fac = group_fac if round(group_fac * 100) >= round(node_fac * 100) else 1
+
+    kwargs = {
+        "cycle": cycle,
+        "scaling_factor": scaling_fac
+    }
+
     return non_empty_list([
         next(
-            (_func(node, cycle) for validator, _func in _CARBON_SOURCE_DECISION_TREE.items() if validator(node)),
+            (
+                _func(node, **kwargs) for validator, _func in _CARBON_SOURCE_DECISION_TREE.items()
+                if validator(node)
+            ),
             None
         ) for node in inputs_and_products
     ])
@@ -1348,7 +1362,9 @@ def _should_run_carbon_source_ag_residue(node: dict) -> bool:
     return node.get("term", {}).get("@id") == _ABOVE_GROUND_CROP_RESIDUE_TOTAL_TERM_ID
 
 
-def _calc_carbon_source_ag_crop_residue(node: dict, cycle: dict) -> Union[CarbonSource, None]:
+def _calc_carbon_source_ag_crop_residue(
+    node: dict, *, cycle: dict, scaling_factor: float, **_
+) -> Union[CarbonSource, None]:
     """
     Extract and format the carbon source data for above-ground crop residues.
 
@@ -1360,6 +1376,11 @@ def _calc_carbon_source_ag_crop_residue(node: dict, cycle: dict) -> Union[Carbon
     ----------
     node : dict
         A HESTIA [Product](https://www.hestia.earth/schema/Product) node with `term.termType` == `landCover`.
+    cycle : dict
+        The HESTIA [Cycle](https://www.hestia.earth/schema/Cycle) that produces the crop residue.
+    scaling_factor : float
+        The scaling factor for the mass of carbon input, calculated by estimating how much the cycle overlaps
+        with the current inventory year.
 
     Returns
     -------
@@ -1371,7 +1392,7 @@ def _calc_carbon_source_ag_crop_residue(node: dict, cycle: dict) -> Union[Carbon
         get_node_value(practice) for practice in cycle.get("practices", [])
         if node_term_match(practice, _CROP_RESIDUE_MANAGEMENT_TERM_IDS)
     ])
-    mass = value * max(residue_left_on_field, _MIN_RESIDUE_LEFT_ON_FIELD) / 100
+    mass = value * max(residue_left_on_field, _MIN_RESIDUE_LEFT_ON_FIELD) * scaling_factor / 100
 
     carbon_content, nitrogen_content, lignin_content, dry_matter = _retrieve_carbon_source_properties(node)
 
@@ -1400,7 +1421,7 @@ def _should_run_carbon_source_cover_crop(node: dict) -> bool:
     bool
         Whether the node satisfies the critera.
     """
-    LOOKUP = _LOOKUPS["landCover"]
+    LOOKUP = LOOKUPS["landCover"]
     TARGET_LOOKUP_VALUES = IPCC_LAND_USE_CATEGORY_TO_LAND_COVER_LOOKUP_VALUE[IpccLandUseCategory.ANNUAL_CROPS]
 
     return (
@@ -1410,7 +1431,7 @@ def _should_run_carbon_source_cover_crop(node: dict) -> bool:
     )
 
 
-def _calc_carbon_source_cover_crop(node: dict, *_) -> Union[CarbonSource, None]:
+def _calc_carbon_source_cover_crop(node: dict, *, scaling_factor: float, **_) -> Union[CarbonSource, None]:
     """
     Extract and format the carbon source data for an annual cover crop.
 
@@ -1420,6 +1441,9 @@ def _calc_carbon_source_cover_crop(node: dict, *_) -> Union[CarbonSource, None]:
     ----------
     node : dict
         A HESTIA [Product](https://www.hestia.earth/schema/Product) node with `term.termType` == `landCover`.
+    scaling_factor : float
+        The scaling factor for the mass of carbon input, calculated by estimating how much the cycle overlaps
+        with the current inventory year.
 
     Returns
     -------
@@ -1428,7 +1452,7 @@ def _calc_carbon_source_cover_crop(node: dict, *_) -> Union[CarbonSource, None]:
     """
     value = get_node_value(node)
     carbon_source = CarbonSource(
-        _DEFAULT_COVER_CROP_BIOMASS * value / 100,
+        _DEFAULT_COVER_CROP_BIOMASS * value * scaling_factor / 100,
         _Parameter.DEFAULT_CARBON_CONTENT.value.get("value"),
         _Parameter.DEFAULT_NITROGEN_CONTENT.value.get("value"),
         _Parameter.DEFAULT_NITROGEN_CONTENT.value.get("value")
@@ -1457,7 +1481,7 @@ def _should_run_carbon_source(node: dict) -> bool:
     ])
 
 
-def _calc_carbon_source(node: dict, *_) -> Union[CarbonSource, None]:
+def _calc_carbon_source(node: dict, *, scaling_factor: float, **_) -> Union[CarbonSource, None]:
     """
     Extract and format the carbon source data for an input or product.
 
@@ -1466,13 +1490,17 @@ def _calc_carbon_source(node: dict, *_) -> Union[CarbonSource, None]:
     node : dict
         A HESTIA [Input](https://www.hestia.earth/schema/Input) or [Product](https://www.hestia.earth/schema/Product)
         node.
+    scaling_factor : float
+        The scaling factor for the mass of carbon input, calculated by estimating how much the cycle overlaps
+        with the current inventory year.
+
 
     Returns
     -------
     CarbonSource | None
         The carbon source data of the cover crop, or `None` if carbon source data incomplete.
     """
-    mass = get_node_value(node)
+    mass = get_node_value(node) * scaling_factor
     carbon_content, nitrogen_content, lignin_content, dry_matter = _retrieve_carbon_source_properties(node)
 
     carbon_source = CarbonSource(
@@ -1673,7 +1701,7 @@ def _check_cycle_tillage_management_category(
     bool
         Whether or not the cycle meets the requirements for the category.
     """
-    LOOKUP = _LOOKUPS["tillage"]
+    LOOKUP = LOOKUPS["tillage"]
     target_lookup_values = IPCC_MANAGEMENT_CATEGORY_TO_TILLAGE_MANAGEMENT_LOOKUP_VALUE.get(key, None)
 
     practices = cycle.get("practices", [])
@@ -1720,7 +1748,7 @@ def _get_grouped_is_paddy_rice(grouped_cycles: dict) -> dict:
 
 
 def _check_is_paddy_rice(cycles: list[dict]) -> bool:
-    LOOKUP = _LOOKUPS["crop"]
+    LOOKUP = LOOKUPS["crop"]
     TARGET_LOOKUP_VALUES = IPCC_LAND_USE_CATEGORY_TO_LAND_COVER_LOOKUP_VALUE.get(
         IpccLandUseCategory.PADDY_RICE_CULTIVATION, None
     )

hestia_earth/models/koble2014/cropResidueManagement.py

@@ -39,7 +39,7 @@ def _run_practice(cycle: dict, ratio: float, practice: dict):
                     rescale_ratio=ratio,
                     value_before_rescale=value)
     logShouldRun(cycle, MODEL, term.get('@id'), True)
-    return _practice(term, round(value * ratio, 2))
+    return _practice(term, round(value * ratio, 7))
 
 
 def _run(cycle: dict):

hestia_earth/models/koble2014/residueBurnt.py

@@ -45,7 +45,7 @@ def _get_default_percent(cycle: dict, term: dict, country_id: str):
 def _run(cycle: dict, remaining_value: float, primary_product: dict, country_id: str):
     term = primary_product.get('term', {})
     value = _get_default_percent(cycle, term, country_id)
-    return [] if value is None else [_practice(TERM_ID, min(round(value * 100, 2), remaining_value))]
+    return [] if value is None else [_practice(TERM_ID, min(round(value * 100, 7), remaining_value))]
 
 
 def run(cycle: dict):

hestia_earth/models/koble2014/residueRemoved.py

@@ -43,7 +43,7 @@ def _get_default_percent(cycle: dict, term: dict, country_id: str):
 def _run(cycle: dict, remaining_value: float, primary_product: dict, country_id: str):
     term = primary_product.get('term', {})
     value = _get_default_percent(cycle, term, country_id)
-    return [] if value is None else [_practice(TERM_ID, min(round(value * 100, 2), remaining_value))]
+    return [] if value is None else [_practice(TERM_ID, min(round(value * 100, 7), remaining_value))]
 
 
 def run(cycle: dict):

hestia_earth/models/koble2014/utils.py

@@ -43,7 +43,7 @@ def _should_run(term_id: str, cycle: dict, require_country: bool = False):
             not is_from_model(p)
         ])
     ]
-    has_provided_cropResidue_products = len(provided_cropResidue_products) > 0
+    no_provided_cropResidue_products = len(provided_cropResidue_products) == 0
 
     country_id = cycle.get('site', {}).get('country', {}).get('@id')
 
@@ -53,13 +53,13 @@ def _should_run(term_id: str, cycle: dict, require_country: bool = False):
                     has_remaining_value=has_remaining_value,
                     crop_residue_values=residue_values,
                     country_id=country_id,
-                    has_provided_cropResidue_products=has_provided_cropResidue_products,
+                    no_provided_cropResidue_products=no_provided_cropResidue_products,
                     provided_cropResidue_product_ids=log_blank_nodes_id(provided_cropResidue_products))
 
     should_run = all([
         has_primary_product, crop_residue_incomplete, has_remaining_value,
         not require_country or country_id,
-        not has_provided_cropResidue_products
+        no_provided_cropResidue_products
     ])
     logShouldRun(cycle, MODEL, term_id, should_run)
     return should_run, remaining_value, primary_product, country_id