hestia-earth-models 0.65.0__tar.gz → 0.65.2__tar.gz

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
+Copyright (c) 2019-2025 Harmonised Environmental Storage and Tracking of the Impacts of Agriculture (HESTIA) Project
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: hestia_earth_models
-Version: 0.65.0
+Version: 0.65.2
 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: GPL
+License: MIT
 Platform: UNKNOWN
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3.6

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/ecoinventV3/__init__.py

@@ -134,9 +134,10 @@ def _run_input(cycle: dict):
         logRequirements(cycle, model=MODEL, term=input_term_id,
                         has_ecoinvent_mappings=has_mappings,
                         ecoinvent_mappings=';'.join([v[0] for v in mappings]),
-                        has_no_gap_filled_background_emissions=has_no_gap_filled_background_emissions)
+                        has_no_gap_filled_background_emissions=has_no_gap_filled_background_emissions,
+                        input_value=input_value)
 
-        should_run = all([has_mappings, has_no_gap_filled_background_emissions])
+        should_run = all([has_mappings, has_no_gap_filled_background_emissions, input_value])
         logShouldRun(cycle, MODEL, input_term_id, should_run, methodTier=TIER)
         grouped_emissions = reduce(_add_emission(cycle, input), mappings, {}) if should_run else {}
         return [

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/ecoinventV3/utils.py

@@ -1,5 +1,5 @@
 from hestia_earth.utils.model import find_term_match
-from hestia_earth.utils.tools import list_sum, flatten, non_empty_list
+from hestia_earth.utils.tools import flatten, non_empty_list
 
 from hestia_earth.models.utils.term import get_lookup_value
 
@@ -12,7 +12,6 @@ def _animal_inputs(animal: dict):
 def _should_run_input(products: list):
     def should_run(input: dict):
         return all([
-            list_sum(input.get('value', [])) > 0,
             # make sure Input is not a Product as well or we might double-count emissions
             find_term_match(products, input.get('term', {}).get('@id'), None) is None,
             # ignore inputs which are flagged as Product of the Cycle

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/ecoinventV3AndEmberClimate/__init__.py

@@ -122,9 +122,10 @@ def _run_input(cycle: dict):
 
         logRequirements(cycle, model=MODEL, term=input_term_id,
                         has_ecoinvent_mappings=has_mappings,
-                        ecoinvent_mappings=';'.join([v[0] for v in mappings]))
+                        ecoinvent_mappings=';'.join([v[0] for v in mappings]),
+                        input_value=input_value)
 
-        should_run = all([electricity_complete, has_mappings])
+        should_run = all([electricity_complete, has_mappings, input_value])
         logShouldRun(cycle, MODEL, input_term_id, should_run, methodTier=TIER)
 
         grouped_emissions = reduce(_add_emission(cycle, input), mappings, {}) if should_run else {}

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/environmentalFootprintV3/soilQualityIndexLandTransformation.py

@@ -67,8 +67,10 @@ def _indicator(value: float):
 
 
 def _run(transformations: List[dict]):
-    values = [(transformation['factor-from'] + transformation['factor-to']) * transformation['area'] for transformation
-              in transformations]
+    values = [
+        (transformation.get('factor-from', 0) + transformation.get('factor-to', 0)) * transformation.get('area', 0) * 20
+        for transformation in transformations
+    ]
     return _indicator(list_sum(values))
 
 
@@ -76,7 +78,7 @@ def _should_run(impact_assessment: dict) -> Tuple[bool, list]:
     resource_uses = filter_list_term_type(impact_assessment.get('emissionsResourceUse', []), TermTermType.RESOURCEUSE)
     found_transformations = [
         {
-            'area': _node_value(transformation_indicator) * 20,
+            'area': _node_value(transformation_indicator),
             'land-cover-id-from': transformation_indicator.get('previousLandCover', {}).get("@id"),
             'land-cover-id-to': transformation_indicator.get('landCover', {}).get("@id"),
             'indicator-id': transformation_indicator.get('term', {}).get('@id', ''),
@@ -91,7 +93,7 @@ def _should_run(impact_assessment: dict) -> Tuple[bool, list]:
 
     found_transformations_with_coefficient = [
         transformation | {
-            "using-fallback-country-region-world-CFs": transformation['lookup-country'] != transformation['country-id'],
+            'using-fallback-country-region-world-CFs': transformation['lookup-country'] != transformation['country-id'],
             'factor-from': get_coefficient_factor(
                 lookup_name=from_lookup_file,
                 country_id=transformation['lookup-country'],

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/faostat2018/utils.py

@@ -150,7 +150,7 @@ def should_run_landTransformationFromCropland(term_id: str, impact: dict):
         if all([
             i.get('term', {}).get('@id') == term_id,
             i.get('previousLandCover', {}).get('@id') == 'cropland',
-            i.get('value', -1) > 0
+            (i.get('value') or -1) > 0
         ])
     ]
     has_cropland = bool(indicators)

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/hestia/seed_emissions.py

@@ -19,6 +19,7 @@ from hestia_earth.utils.tools import non_empty_list, flatten, list_sum, safe_par
 from hestia_earth.utils.emission import cycle_emissions_in_system_boundary
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
+from hestia_earth.models.utils import _omit
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.site import valid_site_type
 from hestia_earth.models.utils.cycle import cycle_end_year
@@ -190,7 +191,7 @@ def _should_run(cycle: dict):
         {
             'product': product.get('term', {}).get('@id'),
             'seed-id': get_lookup_value(
-                product.get('term', {}), 'correspondingSeedTermIds', model=MODEL, key=MODEL_KEY),
+                product.get('term', {}), 'correspondingSeedTermIds', model=MODEL, key=MODEL_KEY) or None,
             'economicValueShare': _evs(product),
             'yield': _yield(country_id, end_year, product),
             'landCover-id': get_landCover_term_id(product.get('term', {}), model=MODEL, key=MODEL_KEY)
@@ -210,20 +211,27 @@ def _should_run(cycle: dict):
     seed_term_ids = list(set(flatten([v.get('seed-id').split(';') for v in valid_crop_products if v.get('seed-id')])))
 
     seed_inputs = [
-        i
-        for i in cycle.get('inputs', [])
-        if all([
-            i.get('term', {}).get('termType') == TermTermType.SEED.value,
-            i.get('term', {}).get('@id') in seed_term_ids,
-            list_sum(i.get('value'), 0) > 0,
-            not i.get('impactAssessment'),
-            # ignore inputs which are flagged as Product of the Cycle
-            not i.get('fromCycle', False),
-            not i.get('producedInCycle', False)
-        ])
+        {
+            'input': i,
+            'is-corresponding-seed': i.get('term', {}).get('@id') in seed_term_ids,
+            'input-value': i.get('value'),
+            'has-linked-impact-assessment': bool(i.get('impactAssessment')),
+            'is-fromCycle': i.get('fromCycle', False),
+            'is-producedInCycle': i.get('producedInCycle', False),
+        }
+        for i in filter_list_term_type(cycle.get('inputs', []), TermTermType.SEED)
     ]
     # sum up seed inputs with the same id
-    seed_inputs = _group_seed_inputs(seed_inputs)
+    grouped_seed_inputs = _group_seed_inputs([
+        v.get('input') for v in seed_inputs
+        if all([
+            v.get('is-corresponding-seed', False),
+            list_sum(v.get('input-value') or [-1]) > 0,
+            not v.get('has-linked-impact-assessment'),
+            not v.get('is-fromCycle'),
+            not v.get('is-producedInCycle'),
+        ])
+    ])
 
     crop_land_cover_ids = list(set([p.get('landCover-id') for p in valid_crop_products]))
     total_economicValueShare = list_sum([p.get('economicValueShare') for p in valid_crop_products])
@@ -243,12 +251,12 @@ def _should_run(cycle: dict):
         is_product_complete,
         total_economicValueShare,
         total_yield,
-        bool(seed_inputs),
+        bool(grouped_seed_inputs),
         bool(emissions)
     ])
 
     for seed_input in seed_inputs:
-        term_id = seed_input.get('term', {}).get('@id')
+        term_id = seed_input.get('input').get('term', {}).get('@id')
 
         logRequirements(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                         site_type_valid=site_type_valid,
@@ -260,11 +268,12 @@ def _should_run(cycle: dict):
                         end_year=end_year,
                         country_id=country_id,
                         emissions=log_as_table(emissions),
-                        emissions_per_group=log_as_table(emissions_per_group))
+                        emissions_per_group=log_as_table(emissions_per_group),
+                        **_omit(seed_input, 'input'))
 
         logShouldRun(cycle, MODEL, term_id, should_run, key=MODEL_KEY)
 
-    return should_run, total_economicValueShare, total_yield, seed_inputs, grouped_emissions
+    return should_run, total_economicValueShare, total_yield, grouped_seed_inputs, grouped_emissions
 
 
 def run(cycle: dict):

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/linkedImpactAssessment/freshwaterWithdrawalsInputsProduction.py

@@ -17,7 +17,10 @@ REQUIREMENTS = {
                     "@type": "ImpactAssessment",
                     "emissionsResourceUse": [{
                         "@type": "Indicator",
-                        "term.@id": "freshwaterWithdrawalsDuringCycle",
+                        "term.@id": [
+                            "freshwaterWithdrawalsDuringCycle",
+                            "freshwaterWithdrawalsInputsProduction"
+                        ],
                         "value": "> 0"
                     }]
                 }

hestia_earth_models-0.65.2/hestia_earth/models/linkedImpactAssessment/landOccupationInputsProduction.py

@@ -0,0 +1,40 @@
+from .utils import run_inputs_production
+
+REQUIREMENTS = {
+    "ImpactAssessment": {
+        "product": {"@type": "Term"},
+        "cycle": {
+            "@type": "Cycle",
+            "products": [{
+                "@type": "Product",
+                "primary": "True",
+                "value": "> 0",
+                "economicValueShare": "> 0"
+            }],
+            "inputs": [{
+                "@type": "Input",
+                "impactAssessment": {
+                    "@type": "ImpactAssessment",
+                    "emissionsResourceUse": [{
+                        "@type": "Indicator",
+                        "term.@id": [
+                            "landOccupationDuringCycle",
+                            "landOccupationInputsProduction"
+                        ],
+                        "value": "> 0"
+                    }]
+                }
+            }]
+        }
+    }
+}
+RETURNS = {
+    "Indicator": [{
+        "value": "",
+        "landCover": ""
+    }]
+}
+TERM_ID = 'landOccupationInputsProduction'
+
+
+def run(impact_assessment: dict): return run_inputs_production(impact_assessment, TERM_ID)

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/linkedImpactAssessment/landTransformation100YearAverageInputsProduction.py

@@ -30,7 +30,9 @@ REQUIREMENTS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": "",
+        "previousLandCover": ""
     }]
 }
 TERM_ID = 'landTransformation100YearAverageInputsProduction'

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/linkedImpactAssessment/landTransformation20YearAverageInputsProduction.py

@@ -30,7 +30,9 @@ REQUIREMENTS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": "",
+        "previousLandCover": ""
     }]
 }
 TERM_ID = 'landTransformation20YearAverageInputsProduction'

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/linkedImpactAssessment/utils.py

@@ -23,7 +23,9 @@ def _run_indicators(product: dict, term_id: str):
             for value in values
         ])
         value = convert_value_from_cycle(product, sum_values(values_from_cycle), model=MODEL, term_id=term_id)
-        return _indicator(term_id, value) | _include(indicator, ['landCover', 'previousLandCover'])
+        return (
+            _indicator(term_id, value) | _include(indicator, ['landCover', 'previousLandCover'])
+        ) if value is not None else None
     return run
 
 
@@ -80,17 +82,22 @@ def _run_inputs_production(impact_assessment: dict, product: dict, term_id: str)
     should_run = all([has_indicators])
     logShouldRun(impact_assessment, MODEL, term_id, should_run)
 
-    return flatten(map(_run_indicators(product, term_id), grouped_indicators.values()))
+    return non_empty_list(flatten(map(_run_indicators(product, term_id), grouped_indicators.values())))
 
 
 def _should_run_inputs_production(impact_assessment: dict, term_id: str):
-    product = get_product(impact_assessment)
-    product_id = (product or {}).get('term', {}).get('@id')
+    product = get_product(impact_assessment) or {}
+    product_id = product.get('term', {}).get('@id')
+
+    product_value = list_sum(product.get('value', []), default=None)
+    economic_value = product.get('economicValueShare')
 
     logRequirements(impact_assessment, model=MODEL, term=term_id,
-                    product=product_id)
+                    product_id=product_id,
+                    product_value=product_value,
+                    product_economicValueShare=economic_value)
 
-    should_run = all([product])
+    should_run = all([product, product_value, economic_value])
     logShouldRun(impact_assessment, MODEL, term_id, should_run)
     return should_run, product
 

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth/models/mocking/search-results.json

@@ -1298,11 +1298,11 @@
       },
       {
         "@type": "Term",
-        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
+        "@id": "residueRemoved"
       },
       {
         "@type": "Term",
-        "@id": "residueRemoved"
+        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
       },
       {
         "@type": "Term",
@@ -1398,10 +1398,6 @@
       }
     },
     "results": [
-      {
-        "@type": "Term",
-        "@id": "digestibleEnergyRuminants"
-      },
       {
         "@type": "Term",
         "@id": "digestibleEnergySalmonids"
@@ -1412,12 +1408,16 @@
       },
       {
         "@type": "Term",
-        "@id": "digestibleEnergyPoultry"
+        "@id": "digestibleEnergyRuminants"
       },
       {
         "@type": "Term",
         "@id": "digestibleEnergyRabbits"
       },
+      {
+        "@type": "Term",
+        "@id": "digestibleEnergyPoultry"
+      },
       {
         "@type": "Term",
         "@id": "digestibleEnergyAquaticSpecies"
@@ -1493,11 +1493,11 @@
     "results": [
       {
         "@type": "Term",
-        "@id": "energyDigestibilityPoultry"
+        "@id": "energyDigestibilityRabbits"
       },
       {
         "@type": "Term",
-        "@id": "energyDigestibilityRabbits"
+        "@id": "energyDigestibilityPoultry"
       },
       {
         "@type": "Term",
@@ -1505,19 +1505,19 @@
       },
       {
         "@type": "Term",
-        "@id": "energyDigestibilityRuminants"
+        "@id": "energyDigestibilitySalmonids"
       },
       {
         "@type": "Term",
-        "@id": "energyDigestibilitySalmonids"
+        "@id": "energyDigestibilityRuminants"
       },
       {
         "@type": "Term",
-        "@id": "energyDigestibilityAquaticSpecies"
+        "@id": "energyDigestibilityOtherAnimals"
       },
       {
         "@type": "Term",
-        "@id": "energyDigestibilityOtherAnimals"
+        "@id": "energyDigestibilityAquaticSpecies"
       }
     ]
   },
@@ -1768,7 +1768,7 @@
         "@type": "Term",
         "name": "Generic crop, seed",
         "@id": "genericCropSeed",
-        "_score": 24.87239
+        "_score": 24.912773
       }
     ]
   },
@@ -2004,157 +2004,157 @@
         "@type": "Term",
         "name": "Glass or high accessible cover",
         "@id": "glassOrHighAccessibleCover",
-        "_score": 59.580826
+        "_score": 59.591824
       },
       {
         "@type": "Term",
         "name": "Sea or ocean",
         "@id": "seaOrOcean",
-        "_score": 49.219673
+        "_score": 49.211555
       },
       {
         "@type": "Term",
         "name": "River or stream",
         "@id": "riverOrStream",
-        "_score": 48.07742
+        "_score": 48.1141
       },
       {
         "@type": "Term",
         "name": "Other natural vegetation",
         "@id": "otherNaturalVegetation",
-        "_score": 42.030323
+        "_score": 41.84881
       },
       {
         "@type": "Term",
         "name": "Food retailer",
         "@id": "foodRetailer",
-        "_score": 40.473133
+        "_score": 40.49202
       },
       {
         "@type": "Term",
         "name": "Agri-food processor",
         "@id": "agriFoodProcessor",
-        "_score": 40.11944
+        "_score": 40.30419
       },
       {
         "@type": "Term",
         "name": "Natural forest",
         "@id": "naturalForest",
-        "_score": 31.730024
+        "_score": 31.557312
       },
       {
         "@type": "Term",
         "name": "Permanent pasture",
         "@id": "permanentPasture",
-        "_score": 28.174412
+        "_score": 28.212002
       },
       {
         "@type": "Term",
         "name": "Animal housing",
         "@id": "animalHousing",
-        "_score": 27.288857
+        "_score": 27.554867
       },
       {
         "@type": "Term",
         "name": "High intensity grazing pasture",
         "@id": "highIntensityGrazingPasture",
-        "_score": 24.550583
+        "_score": 24.59872
       },
       {
         "@type": "Term",
         "name": "Root or tuber crop plant",
         "@id": "rootOrTuberCropPlant",
-        "_score": 23.820816
+        "_score": 23.863335
       },
       {
         "@type": "Term",
         "name": "Forest",
         "@id": "forest",
-        "_score": 20.620052
+        "_score": 20.173904
       },
       {
         "@type": "Term",
-        "name": "Plantation forest",
-        "@id": "plantationForest",
-        "_score": 19.783655
+        "name": "Permanent cropland",
+        "@id": "permanentCropland",
+        "_score": 19.640331
       },
       {
         "@type": "Term",
         "name": "Other land",
         "@id": "otherLand",
-        "_score": 19.563587
+        "_score": 19.463047
       },
       {
         "@type": "Term",
-        "name": "Permanent cropland",
-        "@id": "permanentCropland",
-        "_score": 19.553766
+        "name": "Plantation forest",
+        "@id": "plantationForest",
+        "_score": 19.282543
       },
       {
         "@type": "Term",
         "name": "Lake",
         "@id": "lake",
-        "_score": 18.19668
+        "_score": 18.21026
       },
       {
         "@type": "Term",
         "name": "Red sea plume alga",
         "@id": "redSeaPlumeAlga",
-        "_score": 17.590275
+        "_score": 17.605654
       },
       {
         "@type": "Term",
         "name": "Sea kale plant",
         "@id": "seaKalePlant",
-        "_score": 17.506668
+        "_score": 17.513813
       },
       {
         "@type": "Term",
         "name": "Improved pasture",
         "@id": "improvedPasture",
-        "_score": 17.359146
+        "_score": 17.43089
       },
       {
         "@type": "Term",
         "name": "Native pasture",
         "@id": "nativePasture",
-        "_score": 17.330988
+        "_score": 17.387138
       },
       {
         "@type": "Term",
         "name": "Nominally managed pasture",
         "@id": "nominallyManagedPasture",
-        "_score": 16.30069
+        "_score": 16.351063
       },
       {
         "@type": "Term",
         "name": "Severely degraded pasture",
         "@id": "severelyDegradedPasture",
-        "_score": 15.709078
+        "_score": 15.72388
       },
       {
         "@type": "Term",
         "name": "Pond",
         "@id": "pond",
-        "_score": 15.644154
+        "_score": 15.666466
       },
       {
         "@type": "Term",
         "name": "River tamarind tree",
         "@id": "riverTamarindTree",
-        "_score": 15.328306
+        "_score": 15.338312
       },
       {
         "@type": "Term",
         "name": "Cropland",
         "@id": "cropland",
-        "_score": 10.521658
+        "_score": 10.534372
       },
       {
         "@type": "Term",
         "name": "Annual cropland",
         "@id": "annualCropland",
-        "_score": 10.00343
+        "_score": 10.017572
       }
     ]
   },
@@ -4772,15 +4772,15 @@
       },
       {
         "@type": "Term",
-        "@id": "milkYieldPerSheepRaw"
+        "@id": "milkYieldPerCowRaw"
       },
       {
         "@type": "Term",
-        "@id": "milkYieldPerGoatRaw"
+        "@id": "milkYieldPerSheepRaw"
       },
       {
         "@type": "Term",
-        "@id": "milkYieldPerCowRaw"
+        "@id": "milkYieldPerGoatRaw"
       },
       {
         "@type": "Term",
@@ -5026,11 +5026,11 @@
       },
       {
         "@type": "Term",
-        "@id": "ureaFormaldehydeKgN"
+        "@id": "ureaCalciumNitrateKgN"
       },
       {
         "@type": "Term",
-        "@id": "ureaCalciumNitrateKgN"
+        "@id": "ureaFormaldehydeKgN"
       },
       {
         "@type": "Term",
@@ -5112,11 +5112,11 @@
     "results": [
       {
         "@type": "Term",
-        "@id": "woolSheepGreasy"
+        "@id": "woolGoatGreasy"
       },
       {
         "@type": "Term",
-        "@id": "woolGoatGreasy"
+        "@id": "woolSheepGreasy"
       }
     ]
   }

hestia_earth_models-0.65.2/hestia_earth/models/version.py

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

{hestia_earth_models-0.65.0 → hestia_earth_models-0.65.2}/hestia_earth_models.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.65.0
+Version: 0.65.2
 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: GPL
+License: MIT
 Platform: UNKNOWN
 Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3.6