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

hestia_earth/models/ipcc2019/co2ToAirSoilOrganicCarbonStockChange.py

@@ -11,6 +11,7 @@ from . import MODEL
 REQUIREMENTS = {
     "Cycle": {
         "site": {
+            "@type": "Site",
             "measurements": [
                 {
                     "@type": "Measurement",
@@ -38,7 +39,7 @@ RETURNS = {
         "statsDefinition": "simulated",
         "observations": "",
         "methodTier": "",
-        "depth": "30"
+        "depth": 30
     }]
 }
 TERM_ID = 'co2ToAirSoilOrganicCarbonStockChangeLandUseChange,co2ToAirSoilOrganicCarbonStockChangeManagementChange'

hestia_earth/models/ipcc2019/co2ToAirUreaHydrolysis.py

@@ -1,5 +1,5 @@
 from hestia_earth.schema import EmissionMethodTier
-from hestia_earth.utils.tools import list_sum, safe_parse_float
+from hestia_earth.utils.tools import list_sum, safe_parse_float, non_empty_list
 from hestia_earth.utils.model import find_term_match
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
@@ -68,14 +68,21 @@ def _should_run(cycle: dict):
     uan_share = get_country_breakdown(MODEL, TERM_ID, country_id, LOOKUPS['inorganicFertiliser'][1])
     urea_unspecified_as_n = list_sum(find_term_match(inputs, UNSPECIFIED_TERM_ID).get('value', []))
 
-    urea_values = [{'id': id, 'values': _get_urea_values(cycle, inputs, id)} for id in term_ids] + ([
-        {'id': 'ureaKgN', 'values': [urea_unspecified_as_n * urea_share]},
-        {'id': 'ureaAmmoniumNitrateKgN', 'values': [urea_unspecified_as_n * uan_share]}
-    ] if all([
-        urea_share,
-        uan_share,
-        urea_unspecified_as_n > 0
-    ]) else [])
+    urea_values = [
+        {
+            'id': id,
+            'values': _get_urea_values(cycle, inputs, id)
+        } for id in term_ids
+    ] + non_empty_list([
+        {
+            'id': 'ureaKgN',
+            'values': [urea_unspecified_as_n * urea_share]
+        } if urea_share is not None else None,
+        {
+            'id': 'ureaAmmoniumNitrateKgN',
+            'values': [urea_unspecified_as_n * uan_share]
+        } if urea_share is not None else None
+    ] if urea_unspecified_as_n > 0 else [])
     has_urea_value = any([len(data.get('values')) > 0 for data in urea_values])
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,

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",
@@ -155,8 +156,6 @@ _Inventory = dict[int, _InventoryYear]
 {year (int): data (_InventoryYear)}
 """
 
-_EmissionInventory = dict[_EmissionTermId, npt.NDArray]
-
 
 _BIOMASS_CATEGORY_TO_FUEL_CATEGORY = {
     BiomassCategory.FOREST: {
@@ -517,9 +516,9 @@ def _sum_cycle_emissions(term_id: _EmissionTermId, cycle_id: str, inventory: _In
     return reduce(add_cycle_emissions, inventory.keys(), np.array(0))
 
 
-def _compile_run_data(
+def _compile_inventory(
     cycle: dict, site: dict, land_cover_nodes: list[dict], eco_climate_zone: EcoClimateZone
-) -> tuple[_EmissionInventory, _Inventory, dict]:
+):
     """
     Compile the run data for the model, collating data from `site.management` and related cycles. An annualised
     inventory of land cover change and natural vegetation burning events is constructed. Emissions from burning events
@@ -538,18 +537,12 @@ def _compile_run_data(
 
     Returns
     -------
-    emission_inventory : _EmissionInventory
-        A dictionary of emissions relevant to the cycle the model is run on, in the format:
-        ```
-        {
-            emission_term_id (str): value (NDArray),
-            ...
-        }
-        ```
+    should_run : bool
+        Whether the model should be run.
     inventory : _Inventory
-        An inventory of model data
+        An inventory of model data.
     logs : dict
-        Data from the compilation process that should be logged.
+        Data about the inventory compilation to be logged.
     """
     cycle_id = cycle.get("@id")
     related_cycles_ = related_cycles(site, cycles_mapping={cycle_id: cycle})
@@ -585,9 +578,15 @@ def _compile_run_data(
         Returns
         -------
         inventory : dict
-            An inventory of model data, updated to include the new model year.
+            An inventory of model data, updated to include the input year.
         """
-        land_cover_nodes = next((nodes for year_, nodes in land_cover_grouped.items() if year_ >= year), [])  # Backfill
+        land_cover_nodes = land_cover_grouped.get(
+            next(
+                (k for k in sorted(land_cover_grouped) if k >= year),  # backfill if possible
+                min(land_cover_grouped, key=lambda k: abs(k - year))   # else forward-fill
+            ),
+            []
+        )
 
         biomass_category_summary = summarise_land_cover_nodes(land_cover_nodes)
         prev_biomass_category_summary = inventory.get(year-1, {}).get("biomass_category_summary", {})
@@ -655,17 +654,17 @@ def _compile_run_data(
 
     inventory = reduce(build_inventory_year, range(min_year, max_year+1), dict())
 
-    emission_inventory = {
-        term_id: value for term_id in EMISSION_TERM_IDS
-        if np.all((value := _sum_cycle_emissions(term_id, cycle_id, inventory)) > 0)
-    }
+    n_land_cover_years = len(land_cover_grouped)
 
     logs = {
+        "n_land_cover_years": n_land_cover_years,
         "percent_burned": percent_burned,
         "seed": seed,
     }
 
-    return emission_inventory, inventory, logs
+    should_run = bool(inventory and n_land_cover_years > 1)
+
+    return should_run, inventory, logs
 
 
 def _format_bool(value: Optional[bool]) -> str:
@@ -830,23 +829,16 @@ def _format_inventory(term_id: _EmissionTermId, cycle_id: str, inventory: dict)
     ) if inventory else "None"
 
 
-def _should_run_emission(
-    term_id: _EmissionTermId, cycle: dict, emission_inventory: _EmissionInventory, inventory: dict, logs: dict
-):
+def _log_emission_data(should_run: bool, term_id: _EmissionTermId, cycle: dict, inventory: dict, logs: dict):
     """
-    Determine, based on the compiled data, whether the model should run for a specifc emission term id. Format and log
-    the model logs and inventory.
+    Format and log the model logs and inventory.
     """
-    should_run = term_id in emission_inventory
-
     formatted_logs = _format_logs(logs)
     formatted_inventory = _format_inventory(term_id, cycle.get("@id"), inventory)
 
     logRequirements(cycle, model=MODEL, term=term_id, **formatted_logs, inventory=formatted_inventory)
     logShouldRun(cycle, MODEL, term_id, should_run)
 
-    return should_run
-
 
 def _should_run(cycle: dict):
     """
@@ -860,8 +852,8 @@ def _should_run(cycle: dict):
 
     Returns
     -------
-    tuple[bool, dict]
-        should_run, emission_inventory
+    tuple[bool, _Inventory]
+        should_run, inventory
     """
     site = _get_site(cycle)
 
@@ -872,7 +864,7 @@ def _should_run(cycle: dict):
 
     has_valid_site_type = all([site_type, site_type not in _EXCLUDED_SITE_TYPES])
     has_valid_eco_climate_zone = all([eco_climate_zone, eco_climate_zone not in _EXCLUDED_ECO_CLIMATE_ZONES])
-    has_land_cover_nodes = len(land_cover_nodes) > 0
+    has_land_cover_nodes = len(land_cover_nodes) > 1
 
     should_compile_inventory = all([
         has_valid_site_type,
@@ -880,9 +872,9 @@ def _should_run(cycle: dict):
         has_land_cover_nodes
     ])
 
-    emission_inventory, inventory, compilation_logs = (
-        _compile_run_data(cycle, site, land_cover_nodes, eco_climate_zone)
-        if should_compile_inventory else ({}, {}, {})
+    should_run, inventory, compilation_logs = (
+        _compile_inventory(cycle, site, land_cover_nodes, eco_climate_zone)
+        if should_compile_inventory else (False, {}, {})
     )
 
     logs = {
@@ -896,21 +888,18 @@ def _should_run(cycle: dict):
         **compilation_logs
     }
 
-    should_run = all([
-        any([
-            _should_run_emission(term_id, cycle, emission_inventory, inventory, logs) for term_id in EMISSION_TERM_IDS
-        ])
-    ])
+    for term_id in EMISSION_TERM_IDS:
+        _log_emission_data(should_run, term_id, cycle, inventory, logs)
 
-    return should_run, emission_inventory
+    return should_run, inventory
 
 
-def _run_emission(term_id: _EmissionTermId, emissions: dict[_EmissionTermId, npt.NDArray]) -> list[dict]:
+def _run_emission(term_id: _EmissionTermId, cycle_id: str, inventory: _Inventory) -> list[dict]:
     """
-    Retrieve the pre-computed emissions and format them as a HESTIA
+    Retrieve the sum relevant emissions and format them as a HESTIA
     [Emission node](https://www.hestia.earth/schema/Emission).
     """
-    emission = emissions[term_id]
+    emission = _sum_cycle_emissions(term_id, cycle_id, inventory)
     descriptive_stats = calc_descriptive_stats(emission, STATS_DEFINITION, decimals=3)
     return _emission(term_id, **descriptive_stats)
 
@@ -931,5 +920,5 @@ def run(cycle: dict):
         `ch4ToAirNaturalVegetationBurning` **OR** `coToAirNaturalVegetationBurning` **OR**
         `n2OToAirNaturalVegetationBurningDirect` **OR** `noxToAirNaturalVegetationBurning`.
     """
-    should_run, emission_inventory = _should_run(cycle)
-    return [_run_emission(term_id, emission_inventory) for term_id in emission_inventory] if should_run else []
+    should_run, inventory = _should_run(cycle)
+    return [_run_emission(term_id, cycle.get("@id"), inventory) for term_id in EMISSION_TERM_IDS] if should_run else []

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_1.py

@@ -31,7 +31,78 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
-_LOOKUPS = {
+REQUIREMENTS = {
+    "Site": {
+        "management": [
+            {"@type": "Management", "value": "", "term.termType": "landCover"}
+        ],
+        "measurements": [
+            {
+                "@type": "Measurement",
+                "value": ["1", "2", "3", "4", "7", "8", "9", "10", "11", "12"],
+                "term.@id": "ecoClimateZone"
+            }
+        ],
+        "optional": {
+            "measurements": [
+                {"@type": "Measurement", "value": "", "term.termType": ["soilType", "usdaSoilType"]}
+            ],
+            "management": [
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "cropResidueManagement",
+                    "name": ["burnt", "removed"]
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "landUseManagement"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.termType": "tillage"},
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "waterRegime",
+                    "name": ["deep water", "irrigated"]
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "amendmentIncreasingSoilCarbonUsed"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.@id": "animalManureUsed"},
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "inorganicNitrogenFertiliserUsed"
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "organicFertiliserUsed"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.@id": "shortBareFallow"}
+            ]
+        },
+        "none": {
+            "siteType": ["glass or high accessible cover"]
+        }
+    }
+}
+LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": [
         "IPCC_LAND_USE_CATEGORY",
@@ -43,6 +114,20 @@ _LOOKUPS = {
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY",
     "usdaSoilType": "IPCC_SOIL_CATEGORY"
 }
+RETURNS = {
+    "Measurement": [{
+        "value": "",
+        "sd": "",
+        "min": "",
+        "max": "",
+        "statsDefinition": "simulated",
+        "observations": "",
+        "dates": "",
+        "depthUpper": "0",
+        "depthLower": "30",
+        "methodClassification": "tier 1 model"
+    }]
+}
 
 TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_1_MODEL.value
@@ -108,7 +193,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
@@ -992,8 +1077,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 +1268,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 +1425,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 +1883,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 = {