hestia-earth-models 0.74.15__tar.gz → 0.74.17__tar.gz

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/PKG-INFO

@@ -1,17 +1,34 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: hestia_earth_models
-Version: 0.74.15
+Version: 0.74.17
 Summary: HESTIA's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.).
 Home-page: https://gitlab.com/hestia-earth/hestia-engine-models
 Author: HESTIA Team
 Author-email: guillaumeroyer.mail@gmail.com
 License: MIT
-Platform: UNKNOWN
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3.6
 Description-Content-Type: text/markdown
-Provides-Extra: spatial
 License-File: LICENSE
+Requires-Dist: hestia-earth-schema<34.0.0,>=33.5.0
+Requires-Dist: hestia-earth-utils>=0.15.16
+Requires-Dist: CurrencyConverter==0.16.8
+Requires-Dist: haversine>=2.7.0
+Requires-Dist: pydash
+Requires-Dist: area
+Provides-Extra: spatial
+Requires-Dist: hestia-earth-earth-engine>=0.5.0; extra == "spatial"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
 
 # HESTIA Engine Models
 
@@ -87,5 +104,3 @@ ecoinvent is a consistent, transparent, and well validated life cycle inventory
 We use ecoinvent data to ascertain the environmental impacts of activities that occur outside of our system boundary, for example data on the environmental impacts of extracting oil and producing diesel, or the impacts of manufacturing plastics.
 
 The `ecoinventV3` model requires a valid [license](https://ecoinvent.org/offerings/licences/) to run. We are currently working on a way to enable users of this code with a valid ecoinvent licence to run these models themselves, but for now, these models are only available on the public platform.
-
-

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/cache_nodes.py

@@ -144,14 +144,17 @@ def _cache_sites(nodes: list, batch_size: int = _CACHE_BATCH_SIZE):
     return list(nodes_mapping.values())
 
 
-def run(nodes: list):
-    init_gee()
-
+def cache_nodes(nodes: list):
     # cache sites data
-    cached_nodes = _cache_sites(nodes)
+    nodes = _cache_sites(nodes)
 
     # cache related nodes
-    cached_nodes = _cache_related_nodes(cached_nodes) if _ENABLE_CACHE_RELATED_NODES else cached_nodes
+    nodes = _cache_related_nodes(nodes) if _ENABLE_CACHE_RELATED_NODES else nodes
 
     # cache sources
-    return _cache_sources(cached_nodes)
+    return _cache_sources(nodes)
+
+
+def run(nodes: list):
+    init_gee()
+    return cache_nodes(nodes)

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/config/ImpactAssessment.json

@@ -133,17 +133,6 @@
           "replaceThreshold": ["value", 0.01]
         },
         "stage": 1
-      },
-      {
-        "key": "emissionsResourceUse",
-        "model": "linkedImpactAssessment",
-        "value": "landTransformation100YearAverageInputsProduction",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "mergeArgs": {
-          "replaceThreshold": ["value", 0.01]
-        },
-        "stage": 1
       }
     ],
     [
@@ -158,17 +147,6 @@
         },
         "stage": 1
       },
-      {
-        "key": "emissionsResourceUse",
-        "model": "hestia",
-        "value": "landTransformation100YearAverageDuringCycle",
-        "runStrategy": "always",
-        "mergeStrategy": "list",
-        "mergeArgs": {
-          "replaceThreshold": ["value", 0.01]
-        },
-        "stage": 1
-      },
       {
         "key": "emissionsResourceUse",
         "model": "cml2001Baseline",

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/cycle/completeness/material.py

@@ -9,7 +9,7 @@ REQUIREMENTS = {
         "inputs": [{"@type": "Input", "value": "", "term.@id": "machineryInfrastructureDepreciatedAmountPerCycle"}],
         "site": {
             "@type": "Site",
-            "siteType": ["cropland", "glass or high accessible cover"]
+            "siteType": ["cropland"]
         }
     }
 }
@@ -20,8 +20,7 @@ RETURNS = {
 }
 MODEL_KEY = 'material'
 ALLOWED_SITE_TYPES = [
-    SiteSiteType.CROPLAND.value,
-    SiteSiteType.GLASS_OR_HIGH_ACCESSIBLE_COVER.value
+    SiteSiteType.CROPLAND.value
 ]
 
 

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/hestia/resourceUse_utils.py

@@ -1,10 +1,12 @@
 from datetime import datetime
 from dateutil.relativedelta import relativedelta
 from hestia_earth.schema import TermTermType
-from hestia_earth.utils.tools import list_sum
+from hestia_earth.utils.tools import list_sum, flatten
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
-from hestia_earth.models.utils.blank_node import _gapfill_datestr, DatestrGapfillMode, DatestrFormat, _str_dates_match
+from hestia_earth.models.utils.blank_node import (
+    _gapfill_datestr, DatestrGapfillMode, DatestrFormat, _str_dates_match
+)
 from hestia_earth.models.utils.impact_assessment import get_site
 from hestia_earth.models.utils.indicator import _new_indicator
 from .utils import LAND_USE_TERMS_FOR_TRANSFORMATION, crop_ipcc_land_use_category
@@ -42,7 +44,17 @@ def _find_closest_node_date(
     return filtered_dates[min(filtered_dates.keys())] if filtered_dates else ""
 
 
-def should_run(impact_assessment: dict, term_id: str, historic_date_offset: int) -> tuple[bool, dict, str, str]:
+def _get_current_nodes(management_nodes: list, ia_date_str: str) -> list:
+    return [
+        node for node in management_nodes
+        if (
+                node.get("startDate") and node.get("endDate")
+                and node.get("startDate") <= ia_date_str <= node.get("endDate")
+        )
+    ]
+
+
+def should_run(impact_assessment: dict, term_id: str, historic_date_offset: int) -> tuple[bool, list]:
     cycle = impact_assessment.get('cycle', {})
     has_otherSites = len(cycle.get('otherSites') or []) != 0
 
@@ -64,26 +76,45 @@ def should_run(impact_assessment: dict, term_id: str, historic_date_offset: int)
         node_date_field=match_date
     )
     closest_start_date, closest_end_date = (closest_date, None) if match_date == "startDate" else (None, closest_date)
-    current_node_index = next(
-        (i for i, node in enumerate(filtered_management_nodes)
-         if _str_dates_match(
-            date_str_one=node.get(match_date, ""),
-            date_str_two=impact_assessment.get(match_date, ""),
-            mode=match_mode
-        )),
-        None
-    )
-    current_node = filtered_management_nodes.pop(current_node_index) if current_node_index is not None else None
-    landCover_term_id = (current_node or {}).get('term', {}).get('@id')
-
     prior_management_nodes = [
         node for node in filtered_management_nodes
         if _str_dates_match(node.get("endDate", ""), closest_end_date) or
         _str_dates_match(node.get("startDate", ""), closest_start_date)
     ]
 
-    ipcc_land_use_category = crop_ipcc_land_use_category(landCover_term_id)
+    current_nodes = _get_current_nodes(
+        management_nodes=filtered_management_nodes,
+        ia_date_str=_gapfill_datestr(impact_assessment.get(match_date, ""), mode=match_mode)[:10],
+    )
 
+    should_run_node_results = [
+        should_run_node(
+            current_node=node,
+            closest_end_date=closest_end_date,
+            closest_start_date=closest_start_date,
+            has_otherSites=has_otherSites,
+            impact_assessment=impact_assessment,
+            prior_management_nodes=prior_management_nodes,
+            term_id=term_id
+        )
+        for node in current_nodes
+    ]
+    should_run_result = all([n[0] for n in should_run_node_results])
+    logShouldRun(impact_assessment, MODEL, term=term_id, should_run=should_run_result)
+    return should_run_result, flatten([n[1] for n in should_run_node_results])
+
+
+def should_run_node(
+    current_node,
+    closest_end_date,
+    closest_start_date,
+    has_otherSites: bool,
+    impact_assessment: dict,
+    prior_management_nodes: list,
+    term_id: str
+) -> tuple[bool, list]:
+    landCover_term_id = (current_node or {}).get('term', {}).get('@id')
+    ipcc_land_use_category = crop_ipcc_land_use_category(landCover_term_id)
     total_landOccupationDuringCycle = list_sum([
         node.get("value") for node in impact_assessment.get("emissionsResourceUse", [])
         if node.get("term", {}).get("@id", "") == _RESOURCE_USE_TERM_ID
@@ -112,15 +143,13 @@ def should_run(impact_assessment: dict, term_id: str, historic_date_offset: int)
                     ipcc_land_use_category=ipcc_land_use_category,
                     indicators=log_as_table(indicators))
 
-    should_run_result = all([
+    should_run_node_result = all([
         not has_otherSites,
         ipcc_land_use_category,
         total_landOccupationDuringCycle is not None,
         valid_indicators
     ])
-    logShouldRun(impact_assessment, MODEL, term=term_id, should_run=should_run_result)
-
-    return should_run_result, valid_indicators
+    return should_run_node_result, valid_indicators
 
 
 def run_resource_use(

hestia_earth_models-0.74.17/hestia_earth/models/ipcc2019/burning_utils.py

@@ -0,0 +1,37 @@
+from enum import Enum
+
+
+class FuelCategory(Enum):
+    """
+    Natural vegetation fuel categories from IPCC (2019).
+    """
+    BOREAL_FOREST = "boreal-forest"
+    DRAINED_EXTRATROPICAL_ORGANIC_SOILS_WILDFIRE = "drained-extratropical-organic-soils-wildfire"
+    DRAINED_TROPICAL_ORGANIC_SOILS_WILDFIRE = "drained-tropical-organic-soils-wildfire"
+    EUCALYPT_FOREST = "eucalypt-forest"
+    NATURAL_TROPICAL_FOREST = "natural-tropical-forest"  # mean of primary and secondary tropical forest
+    PEATLAND_VEGETATION = "peatland-vegetation"
+    PRIMARY_TROPICAL_FOREST = "primary-tropical-forest"
+    SAVANNA_GRASSLAND_EARLY_DRY_SEASON_BURNS = "savanna-grassland-early-dry-season-burns"
+    SAVANNA_GRASSLAND_MID_TO_LATE_DRY_SEASON_BURNS = "savanna-grassland-mid-to-late-dry-season-burns"
+    SAVANNA_WOODLAND_EARLY_DRY_SEASON_BURNS = "savanna-woodland-early-dry-season-burns"
+    SAVANNA_WOODLAND_MID_TO_LATE_DRY_SEASON_BURNS = "savanna-woodland-mid-to-late-dry-season-burns"
+    SECONDARY_TROPICAL_FOREST = "secondary-tropical-forest"
+    SHRUBLAND = "shrubland"
+    TEMPERATE_FOREST = "temperate-forest"
+    TERTIARY_TROPICAL_FOREST = "tertiary-tropical-forest"
+    TROPICAL_ORGANIC_SOILS_PRESCRIBED_FIRE = "tropical-organic-soils-prescribed-fire"
+    TUNDRA = "tundra"
+    UNDRAINED_EXTRATROPICAL_ORGANIC_SOILS_WILDFIRE = "undrained-extratropical-organic-soils-wildfire"
+    UNKNOWN_TROPICAL_FOREST = "unknown-tropical-forest"  # mean of primary, secondary and tertiary tropical forest
+
+
+class EmissionCategory(Enum):
+    """
+    Natural vegetation burning emission categories from IPCC (2019).
+    """
+    AGRICULTURAL_RESIDUES = "agricultural-residues"
+    BIOFUEL_BURNING = "biofuel-burning"
+    OTHER_FOREST = "other-forest"
+    SAVANNA_AND_GRASSLAND = "savanna-and-grassland"
+    TROPICAL_FOREST = "tropical-forest"

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/ipcc2019/co2ToAirAboveGroundBiomassStockChange.py

@@ -1,6 +1,5 @@
 from hestia_earth.schema import EmissionMethodTier, MeasurementMethodClassification
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .biomass_utils import detect_land_cover_change, get_valid_management_nodes, summarise_land_cover_nodes
@@ -42,8 +41,10 @@ RETURNS = {
 }
 TERM_ID = 'co2ToAirAboveGroundBiomassStockChangeLandUseChange,co2ToAirAboveGroundBiomassStockChangeManagementChange'
 
-_LU_EMISSION_TERM_ID = "co2ToAirAboveGroundBiomassStockChangeLandUseChange"
-_MG_EMISSION_TERM_ID = "co2ToAirAboveGroundBiomassStockChangeManagementChange"
+_TERM_IDS = TERM_ID.split(",")
+
+_LU_EMISSION_TERM_ID = _TERM_IDS[0]
+_MG_EMISSION_TERM_ID = _TERM_IDS[1]
 
 _CARBON_STOCK_TERM_ID = 'aboveGroundBiomass'
 
@@ -122,23 +123,17 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
-        measurements_mandatory=False,  # Model can allocate zero emissions to LUC with enough landCover data
+        _LU_EMISSION_TERM_ID,
+        _MG_EMISSION_TERM_ID,
+        measurements_required=False,  # Model can allocate zero emissions to LUC with enough landCover data
         measurement_method_ranking=_MEASUREMENT_METHOD_RANKING,
         get_valid_management_nodes_func=get_valid_management_nodes,
         summarise_land_use_func=summarise_land_cover_nodes,
         detect_land_use_change_func=detect_land_cover_change,
     )
 
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=_LU_EMISSION_TERM_ID,
-        management_change_emission_term_id=_MG_EMISSION_TERM_ID
-    )
-
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    for term_id in [_LU_EMISSION_TERM_ID, _MG_EMISSION_TERM_ID]:
-        logRequirements(cycle, model=MODEL, term=term_id, **logs)
-        logShouldRun(cycle, MODEL, term_id, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/ipcc2019/co2ToAirBelowGroundBiomassStockChange.py

@@ -1,6 +1,5 @@
 from hestia_earth.schema import EmissionMethodTier
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .biomass_utils import detect_land_cover_change, get_valid_management_nodes, summarise_land_cover_nodes
@@ -43,8 +42,10 @@ RETURNS = {
 }
 TERM_ID = 'co2ToAirBelowGroundBiomassStockChangeLandUseChange,co2ToAirBelowGroundBiomassStockChangeManagementChange'
 
-_LU_EMISSION_TERM_ID = "co2ToAirBelowGroundBiomassStockChangeLandUseChange"
-_MG_EMISSION_TERM_ID = "co2ToAirBelowGroundBiomassStockChangeManagementChange"
+_TERM_IDS = TERM_ID.split(",")
+
+_LU_EMISSION_TERM_ID = _TERM_IDS[0]
+_MG_EMISSION_TERM_ID = _TERM_IDS[1]
 
 _DEPTH_UPPER = 0
 _DEPTH_LOWER = 30
@@ -114,24 +115,18 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
+        _LU_EMISSION_TERM_ID,
+        _MG_EMISSION_TERM_ID,
         depth_upper=_DEPTH_UPPER,
         depth_lower=_DEPTH_LOWER,
-        measurements_mandatory=False,  # Model can allocate zero emissions to LUC with enough landCover data
+        measurements_required=False,  # Model can allocate zero emissions to LUC with enough landCover data
         get_valid_management_nodes_func=get_valid_management_nodes,
         summarise_land_use_func=summarise_land_cover_nodes,
-        detect_land_use_change_func=detect_land_cover_change
-    )
-
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=_LU_EMISSION_TERM_ID,
-        management_change_emission_term_id=_MG_EMISSION_TERM_ID
+        detect_land_use_change_func=detect_land_cover_change,
     )
 
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    for term_id in [_LU_EMISSION_TERM_ID, _MG_EMISSION_TERM_ID]:
-        logRequirements(cycle, model=MODEL, term=term_id, **logs)
-        logShouldRun(cycle, MODEL, term_id, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []

{hestia_earth_models-0.74.15 → hestia_earth_models-0.74.17}/hestia_earth/models/ipcc2019/co2ToAirBiocharStockChange.py

@@ -1,7 +1,6 @@
 from hestia_earth.schema import EmissionMethodTier
 from hestia_earth.utils.date import YEAR
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .co2ToAirCarbonStockChange_utils import create_run_function, create_should_run_function
@@ -116,25 +115,16 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
+        land_use_change_emission_term_id=None,  # All emissions allocated to management change
+        management_change_emission_term_id=TERM_ID,
         depth_upper=_DEPTH_UPPER,
         depth_lower=_DEPTH_LOWER,
-        transition_period=_TRANSITION_PERIOD_DAYS
+        transition_period=_TRANSITION_PERIOD_DAYS,
+        exclude_from_logs=_EXCLUDE_FROM_LOGS
     )
 
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=None,  # All emissions allocated to management change
-        management_change_emission_term_id=TERM_ID
-    )
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
-
-    logRequirements(
-        cycle,
-        model=MODEL,
-        term=TERM_ID,
-        **{k: v for k, v in logs.items() if k not in _EXCLUDE_FROM_LOGS}
-    )
-    logShouldRun(cycle, MODEL, TERM_ID, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []