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

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_2.py

@@ -33,11 +33,137 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
-_LOOKUPS = {
+REQUIREMENTS = {
+    "Site": {
+        "siteType": "cropland",
+        "measurements": [
+            {
+                "@type": "Measurement",
+                "term.@id": "sandContent",
+                "value": "",
+                "depthUpper": "0",
+                "depthLower": "30",
+                "optional": {
+                    "dates": ""
+                }
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "temperatureMonthly",
+                "value": "",
+                "dates": ""
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "precipitationMonthly",
+                "value": "",
+                "dates": ""
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "potentialEvapotranspirationMonthly",
+                "value": "",
+                "dates": ""
+            }
+        ],
+        "related": {
+            "Cycle": [{
+                "endDate": "",
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueLeftOnField",
+                            "aboveGroundCropResidueIncorporated",
+                            "belowGroundCropResidue",
+                            "discardedCropLeftOnField",
+                            "discardedCropIncorporated"
+                        ],
+                        "value": "",
+                        "properties": [
+                            {
+                                "@type": "Property",
+                                "term.@id": "carbonContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "nitrogenContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "ligninContent",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ],
+                "inputs": [
+                    {
+                        "@type": "Input",
+                        "term.termType": ["organicFertiliser", "soilAmendment"],
+                        "value": "",
+                        "properties": [
+                            {
+                                "@type": "Property",
+                                "term.@id": "carbonContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "nitrogenContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "ligninContent",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ],
+                "practices": [
+                    {
+                        "@type": "Practice",
+                        "term.termType": "tillage",
+                        "value": ""
+                    },
+                    {
+                        "@type": "Practice",
+                        "term.termType": "waterRegime",
+                        "name": "irrigated",
+                        "value": "",
+                        "startDate": "",
+                        "endDate": ""
+                    }
+                ],
+                "optional": {
+                    "startDate": ""
+                }
+            }]
+        }
+    }
+}
+LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": "IPCC_LAND_USE_CATEGORY",
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY"
 }
+RETURNS = {
+    "Measurement": [{
+        "value": "",
+        "sd": "",
+        "min": "",
+        "max": "",
+        "statsDefinition": "simulated",
+        "observations": "",
+        "dates": "",
+        "depthUpper": "0",
+        "depthLower": "30",
+        "methodClassification": "tier 2 model"
+    }]
+}
 
 TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_2_MODEL.value
@@ -124,7 +250,7 @@ def _measurement(
     dict
         A valid HESTIA `Measurement` node, see: https://www.hestia.earth/schema/Measurement.
     """
-    measurement = _new_measurement(TERM_ID) | descriptive_stats_dict
+    measurement = _new_measurement(TERM_ID, MODEL) | descriptive_stats_dict
     measurement["dates"] = [f"{year}-12-31" for year in timestamps]
     measurement["depthUpper"] = DEPTH_UPPER
     measurement["depthLower"] = DEPTH_LOWER
@@ -1173,7 +1299,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 +1448,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 +1488,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 +1502,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 +1518,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 +1547,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 +1557,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 +1567,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 +1578,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 +1607,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 +1616,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 +1827,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 +1874,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/ipcc2019/organicCarbonPerHa_utils.py

@@ -1,13 +1,15 @@
 from enum import Enum
+from numpy import inf
 from numpy.typing import NDArray
 from typing import NamedTuple, Optional
 
 from hestia_earth.schema import MeasurementStatsDefinition, SiteSiteType
 
 from hestia_earth.models.utils.array_builders import (
-    repeat_single, plus_minus_uncertainty_to_normal_1d, truncated_normal_1d
+    repeat_single, truncated_normal_1d
 )
 from hestia_earth.models.utils.blank_node import cumulative_nodes_term_match, node_term_match
+from hestia_earth.models.utils.stats import calc_z_critical
 from hestia_earth.models.utils.term import get_cover_crop_property_terms, get_irrigated_terms
 
 STATS_DEFINITION = MeasurementStatsDefinition.SIMULATED.value
@@ -238,7 +240,9 @@ def sample_plus_minus_uncertainty(
     *, iterations: int, value: float, uncertainty: float, seed: Optional[int] = None, **_
 ) -> NDArray:
     """Randomly sample a model parameter with a plus/minus uncertainty distribution."""
-    return plus_minus_uncertainty_to_normal_1d(shape=(1, iterations), value=value, uncertainty=uncertainty, seed=seed)
+    n_sds = calc_z_critical(95)
+    sigma = (value * (uncertainty / 100)) / n_sds
+    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sigma, low=0, high=inf, seed=seed)
 
 
 def sample_plus_minus_error(
@@ -246,9 +250,7 @@ def sample_plus_minus_error(
 ) -> NDArray:
     """Randomly sample a model parameter with a truncated normal distribution described using plus/minus error."""
     sd = value * (error / 200)
-    low = value - (value * (error / 100))
-    high = value + (value * (error / 100))
-    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sd, low=low, high=high, seed=seed)
+    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sd, low=0, high=inf, seed=seed)
 
 
 def sample_constant(*, iterations: int, value: float, **_) -> NDArray:

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