hestia-earth-models 0.72.2__py3-none-any.whl → 0.73.1__py3-none-any.whl

hestia_earth/models/utils/impact_assessment.py

@@ -1,6 +1,6 @@
 from typing import Optional
 from hestia_earth.schema import TermTermType
-from hestia_earth.utils.model import find_term_match, filter_list_term_type
+from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.tools import list_sum, safe_parse_date
 
 from hestia_earth.models.log import debugValues
@@ -50,7 +50,7 @@ def get_site(impact_assessment: dict) -> dict:
     return impact_assessment.get('site') or impact_assessment.get('cycle', {}).get('site') or {}
 
 
-def get_region_id(impact_assessment: dict) -> str:
+def get_region_id(impact_assessment: dict, blank_node: dict = None) -> str:
     """
     Get the country or region @id of the ImpactAssessment.
     Note: level 1 GADM region will be returned only, even if the region is of level > 1.
@@ -59,18 +59,29 @@ def get_region_id(impact_assessment: dict) -> str:
     ----------
     impact_assessment : dict
         The `ImpactAssessment`.
+    blank_node : dict
+        If getting a value for a specific `emissionsResourceUse`, will try to get country from it.
 
     Returns
     -------
     str
         The `@id` of the `region`.
     """
-    site = get_site(impact_assessment)
-    term_id = site.get('region', site.get('country', impact_assessment.get('country', {}))).get('@id')
-    return term_id if not term_id.startswith('GADM') else region_level_1_id(term_id)
-
-
-def get_country_id(impact_assessment: dict) -> str:
+    term_id: str = (
+        (blank_node or {}).get('region') or
+        (blank_node or {}).get('country') or
+        impact_assessment.get('country') or
+        get_site(impact_assessment).get('region') or
+        get_site(impact_assessment).get('country') or
+        {}
+    ).get('@id')
+    return (
+        term_id if not term_id.startswith('GADM-') else
+        region_level_1_id(term_id)
+    ) if term_id else None
+
+
+def get_country_id(impact_assessment: dict, blank_node: dict = None) -> str:
     """
     Get the country or @id of the ImpactAssessment.
 
@@ -78,13 +89,21 @@ def get_country_id(impact_assessment: dict) -> str:
     ----------
     impact_assessment : dict
         The `ImpactAssessment`.
+    blank_node : dict
+        If getting a value for a specific `emissionsResourceUse`, will try to get country from it.
 
     Returns
     -------
     str
         The `@id` of the `country`.
     """
-    return impact_assessment.get('country', get_site(impact_assessment).get('country', {})).get('@id')
+    term_id = (
+        (blank_node or {}).get('country') or
+        impact_assessment.get('country') or
+        get_site(impact_assessment).get('country') or
+        {}
+    ).get('@id')
+    return term_id if term_id else None
 
 
 def impact_emission_lookup_value(
@@ -170,7 +189,7 @@ def impact_country_value(
         lookup_col=country_id,
         blank_nodes=blank_nodes,
         grouped_key=group_key,
-        default_no_values=None,
+        default_no_values=default_no_values,
         factor_value_func=_term_factor_value
     )
 
@@ -251,10 +270,6 @@ def impact_endpoint_value(model: str, term_id: str, impact: dict, lookup_col: st
     )
 
 
-def emission_value(impact_assessment: dict, term_id: str):
-    return find_term_match(impact_assessment.get('emissionsResourceUse', []), term_id).get('value')
-
-
 def convert_value_from_cycle(
     log_node: dict, product: dict, value: float, default=None, model: str = None, term_id: str = None
 ):

hestia_earth/models/utils/inorganicFertiliser.py

@@ -31,12 +31,12 @@ def get_NH3_emission_factor(term_id: str, soilPh: float, temperature: float):
     soilPh_key = _get_soilPh_lookup_key(soilPh)
     temperature_key = _get_temperature_lookup_key(temperature)
     data = get_term_lookup(term_id, f"NH3_emissions_factor_{soilPh_key}")
-    return safe_parse_float(extract_grouped_data(data, temperature_key), None)
+    return safe_parse_float(extract_grouped_data(data, temperature_key), default=None)
 
 
 def get_country_breakdown(model: str, term_id: str, country_id: str, col_name: str):
     value = get_region_lookup_value(BREAKDOWN_LOOKUP, country_id, col_name, model=model, term=term_id)
-    return safe_parse_float(value, None)
+    return safe_parse_float(value, default=None)
 
 
 def get_cycle_inputs(cycle: dict):

hestia_earth/models/utils/input.py

@@ -4,7 +4,7 @@ from hestia_earth.utils.tools import list_sum, non_empty_list, list_average, fla
 from hestia_earth.utils.lookup import download_lookup, get_table_value, column_name
 
 from hestia_earth.models.log import logger
-from . import _filter_list_term_unit, _load_calculated_node
+from . import _filter_list_term_unit, _load_calculated_node, group_by
 from .constant import Units
 from .blank_node import get_total_value, get_total_value_converted, get_lookup_value
 from .term import download_term
@@ -148,3 +148,36 @@ def total_excreta(inputs: list, units=Units.KG_N):
 def get_total_irrigation_m3(cycle: dict):
     irrigation_inputs = filter_list_term_type(cycle.get('inputs', []), TermTermType.WATER)
     return sum([list_average(i.get('value')) for i in irrigation_inputs if len(i.get('value', [])) > 0])
+
+
+def _group_inputs(inputs: list):
+    grouped_inputs = group_by(inputs, ['input.term.@id'])
+    return [
+        inputs[0] | {'value': list_sum(flatten([v.get('input-value') for v in inputs]))}
+        for inputs in grouped_inputs.values()
+    ]
+
+
+def _input_data(input: dict):
+    return {
+        'input': input,
+        'input-value': list_sum(input.get('value'), default=None),
+        'has-linked-impact-assessment': bool(input.get('impactAssessment')),
+        'is-fromCycle': input.get('fromCycle', False),
+        'is-producedInCycle': input.get('producedInCycle', False)
+    }
+
+
+def unique_background_inputs(cycle: dict):
+    inputs = non_empty_list(map(_input_data, cycle.get('inputs', [])))
+
+    # sum up inputs with the same id
+    return _group_inputs([
+        v for v in inputs
+        if all([
+            v.get('input-value') or -1 > 0,
+            not v.get('has-linked-impact-assessment'),
+            not v.get('is-fromCycle'),
+            not v.get('is-producedInCycle')
+        ])
+    ])

hestia_earth/models/utils/liveAnimal.py

@@ -33,8 +33,8 @@ def get_default_digestibility(model: str, term_id: str, cycle: dict):
         lookup_col = column_name(product_id)
         value = get_table_value(lookup, 'termid', system_id, lookup_col)
         debugMissingLookup(lookup_name, 'termid', term_id, lookup_col, value, model=model, term=term_id)
-        min = safe_parse_float(extract_grouped_data(value, 'min'), None)
-        max = safe_parse_float(extract_grouped_data(value, 'max'), None)
+        min = safe_parse_float(extract_grouped_data(value, 'min'), default=None)
+        max = safe_parse_float(extract_grouped_data(value, 'max'), default=None)
         if min and max:
             return mean([min, max])
 

hestia_earth/models/utils/lookup.py

@@ -28,7 +28,7 @@ def _factor_value(model: str, term_id: str, lookup_name: str, lookup_col: str, g
         coefficient = safe_parse_float(
             extract_grouped_data(coefficient, grouped_data_key),
             default=None
-        ) if ':' in str(coefficient) else safe_parse_float(coefficient, None)
+        ) if ':' in str(coefficient) else safe_parse_float(coefficient, default=None)
         if value is not None and coefficient is not None:
             if model:
                 debugValues(data, model=model, term=term_id,
@@ -44,7 +44,11 @@ def _term_factor_value(model: str, term_id: str, lookup_name: str, lookup_term_i
     def get_value(data: dict):
         node_term_id = data.get('term', {}).get('@id')
         value = _node_value(data)
-        coefficient = get_region_lookup_value(lookup_name, lookup_term_id, node_term_id, model=model, term=term_id)
+        # when getting data for a `region`, we can try to get the `region` on the node first, in case it is set
+        region_term_id = (
+            (data.get('region') or data.get('country') or {'@id': lookup_term_id}).get('@id')
+        ) if lookup_term_id.startswith('GADM-') else lookup_term_id
+        coefficient = get_region_lookup_value(lookup_name, region_term_id, node_term_id, model=model, term=term_id)
         coefficient = safe_parse_float(
             extract_grouped_data(coefficient, group_key) if group_key else coefficient,
             default=None

hestia_earth/models/utils/measurement.py

@@ -32,17 +32,17 @@ def _new_measurement(term, method=None):
     return include_method(node, term_id=method)
 
 
-def measurement_value(measurement: dict, is_larger_unit: bool = False) -> float:
+def measurement_value(measurement: dict, is_larger_unit: bool = False, default=None) -> float:
     term = measurement.get('term', {})
     reducer = get_lookup_value(term, 'arrayTreatmentLargerUnitOfTime' if is_larger_unit else 'arrayTreatment') or 'mean'
     value = non_empty_list(measurement.get('value', []))
     is_value_valid = value is not None and isinstance(value, list) and len(value) > 0
-    return MEASUREMENT_REDUCE.get(reducer, lambda v: v[0])(value) if is_value_valid else 0
+    return MEASUREMENT_REDUCE.get(reducer, lambda v: v[0])(value) if is_value_valid else default
 
 
 def most_relevant_measurement_value(measurements: list, term_id: str, date: str, default=None):
     measurement = most_relevant_blank_node_by_id(measurements, term_id, date)
-    return measurement_value(measurement) if measurement else default
+    return measurement_value(measurement, default=default) if measurement else default
 
 
 def _group_measurement_key(measurement: dict, include_dates: bool = True):
@@ -167,7 +167,7 @@ def most_relevant_measurement_value_by_depth_and_date(
 
     def depth_distance(depth_string):
         split = depth_string.split('_')
-        upper, lower = safe_parse_float(split[0]), safe_parse_float(split[2])  # "a_to_b"
+        upper, lower = safe_parse_float(split[0], default=0), safe_parse_float(split[2], default=0)  # "a_to_b"
         return abs(upper - depth_upper) + abs(lower - depth_lower)
 
     nearest_key = min(grouped_measurements.keys(), key=depth_distance)

hestia_earth/models/utils/productivity.py

@@ -17,5 +17,5 @@ PRODUCTIVITY_KEY = {
 
 
 def get_productivity(country: dict, default: PRODUCTIVITY = PRODUCTIVITY.HIGH):
-    hdi = safe_parse_float(get_lookup_value(country, 'hdi'), None)
+    hdi = safe_parse_float(get_lookup_value(country, 'hdi'), default=None)
     return next((key for key in PRODUCTIVITY_KEY if hdi and PRODUCTIVITY_KEY[key](hdi)), default)

hestia_earth/models/utils/property.py

@@ -132,9 +132,11 @@ def get_node_property_value_converted(model: str, node: dict, prop_id: str, defa
 
 def _get_nitrogen_content(node: dict):
     return safe_parse_float(
-        get_node_property(node, 'nitrogenContent').get('value', 0)) if node else 0
+        get_node_property(node, 'nitrogenContent').get('value', 0), default=0
+    ) if node else 0
 
 
 def _get_nitrogen_tan_content(node: dict):
     return safe_parse_float(
-        get_node_property(node, 'totalAmmoniacalNitrogenContentAsN').get('value', 0)) if node else 0
+        get_node_property(node, 'totalAmmoniacalNitrogenContentAsN').get('value', 0), default=0
+    ) if node else 0

hestia_earth/models/utils/site.py

@@ -1,5 +1,5 @@
 from typing import Optional
-
+from functools import lru_cache
 from hestia_earth.schema import SchemaType, SiteSiteType, TermTermType
 from hestia_earth.utils.api import find_related
 from hestia_earth.utils.tools import non_empty_list, flatten, safe_parse_date
@@ -130,6 +130,7 @@ def region_factor(model: str, region_id: str, term_id: str, termType: TermTermTy
     return get_region_lookup_value(f"region-{termType.value}.csv", region_id, term_id, model=model, term=term_id)
 
 
+@lru_cache()
 def get_land_cover_term_id(site_type: str):
     land_cover_terms = get_land_cover_siteTypes()
     term = next((

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.72.2'
+VERSION = '0.73.1'

{hestia_earth_models-0.72.2.dist-info → hestia_earth_models-0.73.1.dist-info}/METADATA

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