hestia-earth-models 0.65.10__tar.gz → 0.65.11__tar.gz

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia_earth_models
-Version: 0.65.10
+Version: 0.65.11
 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

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/hestia/landCover.py

@@ -82,7 +82,8 @@ LOOKUPS = {
         "Permanent meadows and pastures"
     ],
     "crop": ["cropGroupingFaostatArea", "IPCC_LAND_USE_CATEGORY"],
-    "landCover": ["cropGroupingFaostatProduction", "FAOSTAT_LAND_AREA_CATEGORY"]
+    "landCover": ["cropGroupingFaostatProduction", "FAOSTAT_LAND_AREA_CATEGORY"],
+    "property": "CALCULATE_TOTAL_LAND_COVER_SHARE_SEPARATELY"
 }
 MODEL_KEY = 'landCover'
 
@@ -120,6 +121,13 @@ def site_area_sum_to_100(dict_of_percentages: dict):
          math.isclose(sum(dict_of_percentages.values()), 0.0, rel_tol=0.01))
 
 
+def _should_group_landCover(term: dict):
+    return any(
+        bool(get_lookup_value(lookup_term=prop.get("term", {}), column="CALCULATE_TOTAL_LAND_COVER_SHARE_SEPARATELY"))
+        for prop in term.get("properties", [])
+    )
+
+
 def get_changes(country_id: str, end_year: int) -> dict:
     """
     For each entry in ALL_LAND_USE_TERMS, creates a key: value in output dictionary, also TOTAL
@@ -714,8 +722,7 @@ def _no_prior_land_cover_data(nodes: list, end_date: str) -> bool:
     return len(previous_nodes) == 0
 
 
-def _should_run(site: dict) -> tuple[bool, dict]:
-    management_nodes = filter_list_term_type(site.get("management", []), TermTermType.LANDCOVER)
+def _should_run(site: dict, management_nodes: list) -> tuple[bool, dict]:
     summarised_nodes = _collect_land_use_types(management_nodes)
     allowed_land_use_types = [ANNUAL_CROPLAND, PERMANENT_CROPLAND, PERMANENT_PASTURE]
     relevant_nodes = sorted(
@@ -751,8 +758,11 @@ def _should_run(site: dict) -> tuple[bool, dict]:
 
 
 def run(site: dict) -> list:
-    should_run, site_area = _should_run(site)
-    management_nodes = filter_list_term_type(site.get("management", []), TermTermType.LANDCOVER)
+    management_nodes = [
+        node for node in filter_list_term_type(site.get("management", []), TermTermType.LANDCOVER)
+        if not _should_group_landCover(node)
+    ]
+    should_run, site_area = _should_run(site=site, management_nodes=management_nodes)
     return _run_make_management_nodes(
         existing_nodes=management_nodes,
         percentage_transformed_from=site_area,

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/hestia/resourceUse_utils.py

@@ -8,7 +8,7 @@ from dateutil.relativedelta import relativedelta
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.tools import to_precision
 
-from hestia_earth.models.log import logRequirements, logShouldRun
+from hestia_earth.models.log import logRequirements, logShouldRun, debugValues
 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
@@ -78,11 +78,15 @@ def should_run(
         node for node in impact_assessment.get("emissionsResourceUse", [])
         if node.get("term", {}).get("@id", "") == _RESOURCE_USE_TERM_ID and node.get("value", -1) >= 0
     ]
-
     filtered_management_nodes = [
         node for node in site.get("management", [])
         if node.get("value", -1) >= 0 and node.get("term", {}).get("termType", "") == TermTermType.LANDCOVER.value
     ]
+    land_occupation_during_cycle_found = any(
+        node.get("term", {}).get("@id") in
+        {node.get("landCover", {}).get("@id") for node in relevant_emission_resource_use}
+        for node in filtered_management_nodes
+    )
     current_node_index = next(
         (i for i, node in enumerate(filtered_management_nodes)
          if _str_dates_match(node.get("endDate", ""), impact_assessment.get("endDate", ""))),
@@ -96,19 +100,18 @@ def should_run(
         historic_date_offset=historic_date_offset
     )
 
-    logRequirements(
-        log_node=impact_assessment,
-        model=MODEL,
-        term_id=term_id,
-        site=site
-    )
+    logRequirements(impact_assessment, model=MODEL, term=term_id,
+                    closest_date=closest_date_str,
+                    land_occupation_during_cycle_found=land_occupation_during_cycle_found,
+                    land_cover_term_id=(current_node or {}).get('term', {}).get('@id'))
 
     should_run_result = all([
-        relevant_emission_resource_use != [],
+        relevant_emission_resource_use,
+        land_occupation_during_cycle_found,
         current_node,
         close_date_found
     ])
-    logShouldRun(site, MODEL, term=term_id, should_run=should_run_result)
+    logShouldRun(impact_assessment, MODEL, term=term_id, should_run=should_run_result)
 
     return should_run_result, current_node, closest_date_str
 
@@ -126,6 +129,7 @@ def _get_land_occupation_for_land_use_type(impact_assessment: dict, ipcc_land_us
 
 def _calculate_indicator_value(
     impact_assessment: dict,
+    term_id: str,
     management_nodes: list,
     ipcc_land_use_category: str,
     previous_land_cover_id: str,
@@ -143,6 +147,13 @@ def _calculate_indicator_value(
         node.get("value", 0) for node in management_nodes
         if node.get("term", {}).get("@id", "") == previous_land_cover_id
     )
+
+    debugValues(impact_assessment, model=MODEL, term=term_id,
+                ipcc_land_use_category=ipcc_land_use_category,
+                land_occupation_for_cycle=land_occupation_for_cycle,
+                historical_land_use=historical_land_use,
+                historic_date_offset=historic_date_offset)
+
     return ((land_occupation_for_cycle * historical_land_use) / 100) / historic_date_offset
 
 
@@ -164,6 +175,7 @@ def _run_calculate_transformation(
             previous_land_cover_id=previous_land_cover_id,
             value=_calculate_indicator_value(
                 impact_assessment=impact_assessment,
+                term_id=term_id,
                 management_nodes=[
                     node for node in site.get("management", [])
                     if _str_dates_match(node.get("endDate", ""), closest_date_str)
@@ -191,10 +203,10 @@ def run_resource_use(
         historic_date_offset=historic_date_offset
     )
     return _run_calculate_transformation(
+        impact_assessment=impact_assessment,
+        site=site,
         term_id=term_id,
         current_node=current_node,
         closest_date_str=closest_date_str,
-        site=site,
-        impact_assessment=impact_assessment,
         historic_date_offset=historic_date_offset
     ) if _should_run else []

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/hestia/utils.py

@@ -43,6 +43,5 @@ def crop_ipcc_land_use_category(
     return get_lookup_value(
         lookup_term={"@id": crop_term_id, "type": "Term", "termType": lookup_term_type},
         column='IPCC_LAND_USE_CATEGORY',
-        model=MODEL,
-        term={"@id": crop_term_id, "type": "Term", "termType": lookup_term_type}
+        model=MODEL
     )

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/ipcc2019/animal/pastureGrass.py

@@ -233,7 +233,7 @@ def _run_practice(animal: dict, values: dict, meanDE: float, meanECHHV: float, R
             'weightAtOneYear',
             'weightAtSlaughter'
         ])
-        has_positive_feed_values = all([NEm_feed > 0, NEg_feed > 0])
+        has_positive_feed_values = all([NEm_feed >= 0, NEg_feed >= 0])
 
         logRequirements(animal, model=MODEL, term=input_term_id, model_key=MODEL_KEY,
                         feed_logs=log_as_table(log_feed),

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/ipcc2019/pastureGrass.py

@@ -212,7 +212,7 @@ def _run_practice(cycle: dict, meanDE: float, meanECHHV: float, REM: float, REG:
             'weightAtOneYear',
             'weightAtSlaughter'
         ])
-        has_positive_feed_values = all([NEm_feed > 0, NEg_feed > 0])
+        has_positive_feed_values = all([NEm_feed >= 0, NEg_feed >= 0])
 
         logRequirements(cycle, model=MODEL, term=input_term_id, model_key=MODEL_KEY,
                         feed_logs=log_as_table(log_feed),

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/mocking/search-results.json

@@ -2022,13 +2022,13 @@
         "@type": "Term",
         "name": "Other natural vegetation",
         "@id": "otherNaturalVegetation",
-        "_score": 43.05355
+        "_score": 43.053535
       },
       {
         "@type": "Term",
         "name": "Agri-food processor",
         "@id": "agriFoodProcessor",
-        "_score": 42.06176
+        "_score": 42.061752
       },
       {
         "@type": "Term",
@@ -2046,7 +2046,7 @@
         "@type": "Term",
         "name": "Permanent pasture",
         "@id": "permanentPasture",
-        "_score": 28.69685
+        "_score": 28.696854
       },
       {
         "@type": "Term",
@@ -2070,7 +2070,7 @@
         "@type": "Term",
         "name": "Forest",
         "@id": "forest",
-        "_score": 20.619314
+        "_score": 20.619322
       },
       {
         "@type": "Term",
@@ -2082,7 +2082,7 @@
         "@type": "Term",
         "name": "Other land",
         "@id": "otherLand",
-        "_score": 19.758362
+        "_score": 19.758368
       },
       {
         "@type": "Term",

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/pooreNemecek2018/freshwaterWithdrawalsDuringCycle.py

@@ -18,7 +18,6 @@ REQUIREMENTS = {
             "@type": "Cycle",
             "products": [{
                 "@type": "Product",
-                "primary": "True",
                 "value": "> 0",
                 "economicValueShare": "> 0"
             }],

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/pooreNemecek2018/landOccupationDuringCycle.py

@@ -2,7 +2,8 @@ from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.impact_assessment import get_product, get_site
 from hestia_earth.models.utils.cycle import land_occupation_per_kg
-from hestia_earth.models.utils.site import get_land_cover_term_id
+from hestia_earth.models.utils.site import get_land_cover_term_id as get_landCover_term_id_from_site_type
+from hestia_earth.models.utils.crop import get_landCover_term_id
 from . import MODEL
 
 REQUIREMENTS = {
@@ -16,7 +17,6 @@ REQUIREMENTS = {
                     "cycleDuration": "",
                     "products": [{
                         "@type": "Product",
-                        "primary": "True",
                         "value": "> 0",
                         "economicValueShare": "> 0"
                     }],
@@ -46,8 +46,8 @@ RETURNS = {
 TERM_ID = 'landOccupationDuringCycle'
 
 
-def _indicator(term_id: str, value: float, land_covert_term_id: str):
-    indicator = _new_indicator(term_id, MODEL, land_covert_term_id)
+def _indicator(term_id: str, value: float, land_cover_term_id: str):
+    indicator = _new_indicator(term_id, MODEL, land_cover_term_id)
     indicator['value'] = value
     return indicator
 
@@ -56,18 +56,21 @@ def _should_run(impact_assessment: dict):
     product = get_product(impact_assessment)
     cycle = impact_assessment.get('cycle', {})
     site = get_site(impact_assessment)
-    land_covert_term_id = get_land_cover_term_id(site.get('siteType'))
+    land_cover_from_product = get_landCover_term_id(product.get('term', {}))
+    land_cover_from_site = get_landCover_term_id_from_site_type(site.get('siteType'))
+    land_cover_term_id = land_cover_from_product or land_cover_from_site
     land_occupation_m2_kg = land_occupation_per_kg(MODEL, TERM_ID, cycle, site, product)
 
     logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
                     land_occupation_kg=land_occupation_m2_kg,
-                    land_covert_term_id=land_covert_term_id)
+                    land_cover_from_product=land_cover_from_product,
+                    land_cover_from_site=land_cover_from_site)
 
-    should_run = all([land_covert_term_id, land_occupation_m2_kg is not None])
+    should_run = all([land_cover_term_id, land_occupation_m2_kg is not None])
     logShouldRun(impact_assessment, MODEL, TERM_ID, should_run)
-    return should_run, land_occupation_m2_kg, land_covert_term_id
+    return should_run, land_occupation_m2_kg, land_cover_term_id
 
 
 def run(impact_assessment: dict):
-    should_run, land_occupation_kg, land_covert_term_id = _should_run(impact_assessment)
-    return [_indicator(TERM_ID, land_occupation_kg, land_covert_term_id)] if should_run else []
+    should_run, land_occupation_kg, land_cover_term_id = _should_run(impact_assessment)
+    return [_indicator(TERM_ID, land_occupation_kg, land_cover_term_id)] if should_run else []

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/site/management.py

@@ -31,11 +31,11 @@ from hestia_earth.models.utils import _include, _omit, group_by
 from hestia_earth.models.utils.management import _new_management
 from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.blank_node import condense_nodes, DatestrFormat, _gapfill_datestr, DatestrGapfillMode
+from hestia_earth.models.utils.crop import get_landCover_term_id
 from hestia_earth.models.utils.site import (
     related_cycles, get_land_cover_term_id as get_landCover_term_id_from_site_type
 )
 from . import MODEL
-from ..utils.crop import get_landCover_term_id
 
 REQUIREMENTS = {
     "Site": {

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/utils/blank_node.py

@@ -73,7 +73,7 @@ def lookups_logs(model: str, blank_nodes: list, lookups_per_termType: dict, **lo
 
         def _reduce_lookups_logs(logs: dict, column: str):
             lookup_value = get_lookup_value(term, column, model=model, **log_args)
-            return logs | {column: lookup_value}
+            return logs | {column: str(lookup_value).replace(':', '-')}
 
         return reduce(_reduce_lookups_logs, lookups, {'id': term_id})
 

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/utils/crop.py

@@ -67,6 +67,6 @@ def get_landCover_term_id(lookup_term: dict, **log_args) -> str:
     value = get_lookup_value(lookup_term, 'landCoverTermId', **log_args)
     return (
         lookup_term.get("@id") if lookup_term.get("termType") == TermTermType.LANDCOVER.value else
-        value.split(';')[0] if value else
+        value.split(';')[0] if isinstance(value, str) else
         None
     )

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth/models/utils/cycle.py

@@ -291,7 +291,7 @@ def _land_occupation_per_kg(model: str, term_id: str, cycle: dict, product: dict
     return value
 
 
-def land_occupation_per_kg(model: str, term_id: str, cycle: dict, site: dict, primary_product: dict):
+def land_occupation_per_kg(model: str, term_id: str, cycle: dict, site: dict, product: dict):
     """
     Get the land occupation of the cycle per kg in meter square.
 
@@ -305,7 +305,7 @@ def land_occupation_per_kg(model: str, term_id: str, cycle: dict, site: dict, pr
         The `Cycle` as defined in the HESTIA Schema.
     site : dict
         The `Site` as defined in the HESTIA Schema.
-    primary_product : dict
+    product : dict
         The primary `Product` of the `Cycle`.
 
     Returns
@@ -325,7 +325,7 @@ def land_occupation_per_kg(model: str, term_id: str, cycle: dict, site: dict, pr
         SiteSiteType.RIVER_OR_STREAM.value,
         SiteSiteType.SEA_OR_OCEAN.value
     ] else (
-        _land_occupation_per_kg(model, term_id, cycle, primary_product, value) if value is not None else None
+        _land_occupation_per_kg(model, term_id, cycle, product, value) if value is not None else None
     )
 
 

hestia_earth_models-0.65.11/hestia_earth/models/version.py

@@ -0,0 +1 @@
+VERSION = '0.65.11'

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/hestia_earth_models.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.65.10
+Version: 0.65.11
 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

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/tests/models/hestia/test_landCover.py

@@ -197,7 +197,8 @@ def test_get_sums_of_crop_expansion():
         "gbr_example",
         "malaysia",
         "prior_landCover",
-        "nigeria_cassava"
+        "nigeria_cassava",
+        "cover_crops",
     ]
 )
 @patch(f"{CLASS_PATH}._new_management", side_effect=fake_new_management)

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/tests/models/hestia/test_landTransformation20YearAverageDuringCycle.py

@@ -14,7 +14,8 @@ fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 @pytest.mark.parametrize(
     "subfolder",
     [
-        "maize_brazil"
+        "maize_brazil",
+        "orange_iran"
     ]
 )
 @patch("hestia_earth.models.hestia.resourceUse_utils._new_indicator", side_effect=fake_new_indicator)

{hestia_earth_models-0.65.10 → hestia_earth_models-0.65.11}/tests/models/pooreNemecek2018/test_landOccupationDuringCycle.py

@@ -9,7 +9,7 @@ class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
 
-@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
+@patch(f"{class_path}.get_landCover_term_id", return_value='cropland')
 @patch(f"{class_path}.land_occupation_per_kg", return_value=None)
 def test_should_run(mock_land_occupation, *args):
     # with a cycle and functionalUnit = 1 ha => no run
@@ -23,7 +23,6 @@ def test_should_run(mock_land_occupation, *args):
     assert should_run is True
 
 
-@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run(*args):
     with open(f"{fixtures_folder}/impact-assessment.jsonld", encoding='utf-8') as f:
@@ -36,7 +35,6 @@ def test_run(*args):
     assert value == expected
 
 
-@patch(f"{class_path}.get_land_cover_term_id", return_value='cropland')
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run_with_plantation(*args):
     with open(f"{fixtures_folder}/with-orchard-crop/impact-assessment.jsonld", encoding='utf-8') as f:

hestia_earth_models-0.65.11/tests/models/utils/test_crop.py

@@ -0,0 +1,27 @@
+import pytest
+from hestia_earth.schema import SiteSiteType, TermTermType
+
+from hestia_earth.models.utils.crop import valid_site_type, get_landCover_term_id
+
+class_path = 'hestia_earth.models.utils.crop'
+
+
+def test_valid_site_type():
+    site = {'siteType': SiteSiteType.CROPLAND.value}
+    cycle = {'site': site}
+    assert valid_site_type(cycle) is True
+
+    cycle['site']['siteType'] = SiteSiteType.PERMANENT_PASTURE.value
+    assert not valid_site_type(cycle)
+    assert not valid_site_type(site, True) is True
+
+
+@pytest.mark.parametrize(
+    'term,expected',
+    [
+        ({'termType': TermTermType.CROP.value, '@id': 'wheatGrain'}, 'wheatPlant'),
+        ({'termType': TermTermType.SEED.value, '@id': 'saplings'}, None),
+    ]
+)
+def test_get_landCover_term_id(term: dict, expected: str):
+    assert get_landCover_term_id(term) == expected, term.get('@id')

hestia_earth_models-0.65.10/hestia_earth/models/version.py

@@ -1 +0,0 @@
-VERSION = '0.65.10'

hestia_earth_models-0.65.10/tests/models/utils/test_crop.py

@@ -1,15 +0,0 @@
-from hestia_earth.schema import SiteSiteType
-
-from hestia_earth.models.utils.crop import valid_site_type
-
-class_path = 'hestia_earth.models.utils.crop'
-
-
-def test_valid_site_type():
-    site = {'siteType': SiteSiteType.CROPLAND.value}
-    cycle = {'site': site}
-    assert valid_site_type(cycle) is True
-
-    cycle['site']['siteType'] = SiteSiteType.PERMANENT_PASTURE.value
-    assert not valid_site_type(cycle)
-    assert not valid_site_type(site, True) is True