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

hestia_earth/models/akagiEtAl2011/utils.py

@@ -2,7 +2,7 @@ from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, Ter
 
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.cropResidue import get_crop_residue_burnt_value
 from . import MODEL
 

hestia_earth/models/aware/scarcityWeightedWaterUse.py

@@ -1,4 +1,5 @@
 from hestia_earth.schema import SiteSiteType
+from hestia_earth.utils.model import find_term_match
 from hestia_earth.utils.lookup import download_lookup, _get_single_table_value, column_name
 from hestia_earth.utils.tools import safe_parse_float
 
@@ -6,7 +7,7 @@ from hestia_earth.models.log import logRequirements, debugMissingLookup, logShou
 from hestia_earth.models.utils import sum_values, multiply_values
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.impact_assessment import (
-    convert_value_from_cycle, emission_value, get_product, get_site, get_region_id
+    convert_value_from_cycle, get_product, get_site, get_region_id
 )
 from hestia_earth.models.utils.input import sum_input_impacts
 from hestia_earth.models.utils.lookup import get_region_lookup_value
@@ -64,8 +65,8 @@ def _get_factor_from_basinId(site: dict, aware_id: str):
     return safe_parse_float(value, default=None)
 
 
-def _get_factor_from_region(impact_assessment: dict, site: dict):
-    region_id = get_region_id(impact_assessment)
+def _get_factor_from_region(impact_assessment: dict, fresh_water: dict, site: dict):
+    region_id = get_region_id(impact_assessment, fresh_water)
     site_type = site.get('siteType')
     lookup_name = 'region-aware-factors.csv'
     lookup_suffix = 'unspecified' if not site_type else ('irri' if site_type in IRRIGATED_SITE_TYPES else 'non_irri')
@@ -77,23 +78,23 @@ def _get_factor_from_region(impact_assessment: dict, site: dict):
 def run(impact_assessment: dict):
     cycle = impact_assessment.get('cycle', {})
     product = get_product(impact_assessment)
-    fresh_water = emission_value(impact_assessment, 'freshwaterWithdrawalsDuringCycle')
+    fresh_water = find_term_match(impact_assessment.get('emissionsResourceUse', []), 'freshwaterWithdrawalsDuringCycle')
     site = get_site(impact_assessment)
     aware_id = site.get(AWARE_KEY)
     factor = (
         _get_factor_from_basinId(site, aware_id) if aware_id else None
-    ) or _get_factor_from_region(impact_assessment, site)
+    ) or _get_factor_from_region(impact_assessment, fresh_water, site)
     inputs_value = convert_value_from_cycle(
         impact_assessment, product, sum_input_impacts(cycle.get('inputs', []), TERM_ID), model=MODEL, term_id=TERM_ID
     )
 
     value = sum_values([
-        multiply_values([fresh_water, factor]),
+        multiply_values([fresh_water.get('value'), factor]),
         inputs_value
     ])
 
     logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
-                    fresh_water=fresh_water,
+                    fresh_water=fresh_water.get('value'),
                     aware_id=aware_id,
                     factor=factor,
                     inputs_value=inputs_value)

hestia_earth/models/cache_sites.py

@@ -132,10 +132,14 @@ def _run(sites: list, years: list = [], years_only: bool = False):
     rasters = list_rasters(years=years, years_only=years_only)
     vectors = [] if years_only else list_vectors(sites)
     filtered_data, sites_no_run = _group_sites(sites, not years_only)
-    return flatten([
-        _run_values(filtered_data.get(param_type), param_type, rasters, vectors, years)
-        for param_type in [e for e in ParamType] if len(filtered_data.get(param_type)) > 0
-    ] + _run_values(sites_no_run, years=years))
+    return flatten(
+        [
+            _run_values(filtered_data.get(param_type), param_type, rasters, vectors, years)
+            for param_type in [e for e in ParamType] if len(filtered_data.get(param_type)) > 0
+        ] + (
+            _run_values(sites_no_run, years=years) if sites_no_run else []
+        )
+    )
 
 
 def _run_by_years(sites: list, years: list, batch_size: int):

hestia_earth/models/chaudharyBrooks2018/damageToTerrestrialEcosystemsLandTransformation.py

@@ -1,8 +1,10 @@
+from hestia_earth.utils.model import find_term_match
+
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
 from hestia_earth.models.utils import sum_values, multiply_values
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.impact_assessment import (
-    convert_value_from_cycle, emission_value, get_product, get_site
+    convert_value_from_cycle, get_product, get_site
 )
 from hestia_earth.models.utils.input import sum_input_impacts
 from .utils import get_region_factor
@@ -56,26 +58,27 @@ def _indicator(value: float):
     return indicator
 
 
-def _value(impact_assessment: dict, term_id: str):
-    value = emission_value(impact_assessment, term_id)
-    debugValues(impact_assessment, model=MODEL, term=TERM_ID, node=term_id, value=value, coefficient=1)
-    return value
-
-
 def _run(impact_assessment: dict):
     cycle = impact_assessment.get('cycle', {})
     product = get_product(impact_assessment)
-    landTransformation = _value(impact_assessment, _TRANSFORMATION_TERM_ID)
-    region_factor = get_region_factor(TERM_ID, impact_assessment, _LOOKUP_SUFFIX, 'medium_intensity')
+    landTransformation = find_term_match(impact_assessment.get('emissionsResourceUse', []), _TRANSFORMATION_TERM_ID)
+    debugValues(impact_assessment, model=MODEL, term=TERM_ID,
+                node=_TRANSFORMATION_TERM_ID,
+                value=landTransformation.get('value'),
+                coefficient=1)
+
+    region_factor = get_region_factor(
+        TERM_ID, impact_assessment, _LOOKUP_SUFFIX, 'medium_intensity', blank_node=landTransformation
+    )
     inputs_value = convert_value_from_cycle(
         impact_assessment, product, sum_input_impacts(cycle.get('inputs', []), TERM_ID), model=MODEL, term_id=TERM_ID
     )
     logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
-                    landTransformation=landTransformation,
+                    landTransformation=landTransformation.get('value'),
                     region_factor=region_factor,
                     inputs_value=inputs_value)
     value = sum_values([
-        multiply_values([landTransformation, region_factor]),
+        multiply_values([landTransformation.get('value'), region_factor]),
         inputs_value
     ])
     return _indicator(value) if value is not None else None

hestia_earth/models/chaudharyBrooks2018/utils.py

@@ -13,10 +13,12 @@ def _lookup_value(term_id: str, lookup_name: str, col_match: str, col_val: str,
     return value
 
 
-def get_region_factor(term_id: str, impact_assessment: dict, lookup_suffix: str, group_key: str = None):
+def get_region_factor(
+    term_id: str, impact_assessment: dict, lookup_suffix: str, group_key: str = None, blank_node: dict = None
+):
     site = get_site(impact_assessment)
     ecoregion = site.get('ecoregion')
-    country_id = get_country_id(impact_assessment)
+    country_id = get_country_id(impact_assessment, blank_node=blank_node)
     site_type = site.get('siteType')
 
     lookup_prefix = 'ecoregion' if ecoregion else 'region' if country_id else None

hestia_earth/models/cycle/completeness/electricityFuel.py

@@ -2,7 +2,7 @@ from hestia_earth.schema import TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 
 from hestia_earth.models.log import logRequirements, log_as_table
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.completeness import _is_term_type_complete
 from . import MODEL
 

hestia_earth/models/cycle/completeness/freshForage.py

@@ -4,7 +4,7 @@ from hestia_earth.utils.tools import list_sum
 
 from hestia_earth.models.log import logRequirements
 from hestia_earth.models.utils import is_from_model
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from . import MODEL
 
 REQUIREMENTS = {

hestia_earth/models/cycle/input/hestiaAggregatedData.py

@@ -4,8 +4,7 @@ from hestia_earth.utils.tools import non_empty_list
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
 from hestia_earth.models.utils.crop import valid_site_type
-from hestia_earth.models.utils.blank_node import get_lookup_value
-from hestia_earth.models.utils.term import get_generic_crop, download_term
+from hestia_earth.models.utils.term import get_lookup_value, get_generic_crop, download_term
 from hestia_earth.models.utils.aggregated import (
     should_link_input_to_impact, link_inputs_to_impact, find_closest_impact, aggregated_end_date
 )

hestia_earth/models/cycle/product/economicValueShare.py

@@ -2,7 +2,7 @@ from hestia_earth.utils.model import find_term_match
 from hestia_earth.utils.tools import list_sum
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.cycle import unique_currencies
 from .utils import lookup_share
 from .. import MODEL

hestia_earth/models/environmentalFootprintV3_1/environmentalFootprintSingleOverallScore.py

@@ -4,7 +4,7 @@ from hestia_earth.utils.tools import list_sum
 from typing import List, Optional, Tuple
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table, debugValues
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.lookup import _node_value
 from . import MODEL

hestia_earth/models/environmentalFootprintV3_1/soilQualityIndexLandOccupation.py

@@ -60,17 +60,17 @@ def _should_run(impact_assessment: dict) -> Tuple[bool, list]:
     ]
 
     found_land_occupation_indicators = [{
-        'area-by-year': _node_value(land_occupation_indicator),
-        'area-unit': land_occupation_indicator.get('term', {}).get("units"),
-        'land-cover-id': land_occupation_indicator.get('landCover', {}).get("@id"),
-        'country-id': get_country_id(impact_assessment),
-        'area-by-year-is-valid': _node_value(land_occupation_indicator) is not None and _node_value(
-            land_occupation_indicator) > 0,
-        'area-unit-is-valid': land_occupation_indicator.get('term', {}).get("units") == "m2*year",
-        'used-country': fallback_country(get_country_id(impact_assessment), [LOOKUP]),
-        'pef-grouping': get_pef_grouping(land_occupation_indicator.get('landCover', {}).get("@id"))
-
-    } for land_occupation_indicator in land_occupation_indicators]
+        'area-by-year': _node_value(indicator),
+        'area-unit': indicator.get('term', {}).get("units"),
+        'land-cover-id': indicator.get('landCover', {}).get("@id"),
+        'country-id': get_country_id(impact_assessment, blank_node=indicator),
+        'area-by-year-is-valid': _node_value(indicator) is not None and _node_value(
+            indicator) > 0,
+        'area-unit-is-valid': indicator.get('term', {}).get("units") == "m2*year",
+        'used-country': fallback_country(get_country_id(impact_assessment, blank_node=indicator), [LOOKUP]),
+        'pef-grouping': get_pef_grouping(indicator.get('landCover', {}).get("@id"))
+
+    } for indicator in land_occupation_indicators]
 
     found_indicators_with_coefficient = [
         indicator | {

hestia_earth/models/environmentalFootprintV3_1/soilQualityIndexLandTransformation.py

@@ -92,21 +92,24 @@ def _should_run(impact_assessment: dict) -> Tuple[bool, list]:
 
     found_transformations = [
         {
-            'value': _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', ''),
+            'value': _node_value(indicator),
+            'land-cover-id-from': indicator.get('previousLandCover', {}).get("@id"),
+            'land-cover-id-to': indicator.get('landCover', {}).get("@id"),
+            'indicator-id': indicator.get('term', {}).get('@id', ''),
             'good-land-cover-term': all([
-                bool(transformation_indicator.get('landCover')),
-                bool(transformation_indicator.get('previousLandCover'))
+                bool(indicator.get('landCover')),
+                bool(indicator.get('previousLandCover'))
             ]),
-            'country-id': get_country_id(impact_assessment),
+            'country-id': get_country_id(impact_assessment, blank_node=indicator),
             'value-is-valid': (
-                _node_value(transformation_indicator) is not None and
-                _node_value(transformation_indicator) >= 0
+                _node_value(indicator) is not None and
+                _node_value(indicator) >= 0
             ),
-            'lookup-country': fallback_country(get_country_id(impact_assessment), [from_lookup_file, to_lookup_file]),
-        } for transformation_indicator in resource_uses
+            'lookup-country': fallback_country(
+                get_country_id(impact_assessment, blank_node=indicator),
+                [from_lookup_file, to_lookup_file]
+            ),
+        } for indicator in resource_uses
     ]
 
     found_transformations_with_coefficient = [

hestia_earth/models/faostat2018/utils.py

@@ -1,9 +1,9 @@
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.api import download_hestia
 from hestia_earth.utils.lookup import download_lookup, get_table_value, column_name, extract_grouped_data_closest_date
-from hestia_earth.utils.tools import safe_parse_float, flatten
+from hestia_earth.utils.tools import safe_parse_float, flatten, non_empty_list
 
-from hestia_earth.models.log import logger, debugMissingLookup, logRequirements, logShouldRun, debugValues
+from hestia_earth.models.log import logger, debugMissingLookup, logRequirements, logShouldRun, debugValues, log_as_table
 from hestia_earth.models.utils.animalProduct import (
     FAO_LOOKUP_COLUMN, FAO_EQUIVALENT_LOOKUP_COLUMN, get_animalProduct_lookup_value
 )
@@ -152,24 +152,37 @@ def should_run_landTransformationFromCropland(term_id: str, impact: dict):
     return should_run, indicators
 
 
+def _map_indicator_value(impact: dict, start_year: int, end_year: int):
+    def mapper(indicator: dict):
+        country_id = get_country_id(impact, blank_node=indicator)
+        total, permanent, temporary = get_cropland_ratio(country_id, start_year, end_year)
+        return {
+            'landCover-id': indicator.get('landCover', {}).get('@id'),
+            'value': indicator.get('value'),
+            'country-id': country_id,
+            'diff-total-area': total,
+            'diff-temporary-area': temporary,
+            'diff-permanent-area': permanent
+        } if total is not None else None
+    return mapper
+
+
 def run_landTransformationFromCropland(term_id: str, impact: dict, indicators: list, years: int):
-    country_id = get_country_id(impact)
     end_year = impact_end_year(impact)
-    total, permanent, temporary = get_cropland_ratio(country_id, end_year - years, end_year)
+
+    values = non_empty_list(map(_map_indicator_value(impact, end_year - years, end_year), indicators))
 
     debugValues(impact, model=MODEL, term_id=term_id,
-                diff_temporary_area=temporary,
-                diff_permanent_area=permanent,
-                diff_total_area=total)
+                indicators_used=log_as_table(values))
 
     return flatten([
         [
-            _new_indicator(term_id, MODEL, indicator.get('landCover', {}).get('@id'), 'annualCropland') | {
-                'value': indicator.get('value') * temporary / total
+            _new_indicator(term_id, MODEL, value.get('landCover-id'), 'annualCropland') | {
+                'value': value.get('value') * value.get('diff-temporary-area') / value.get('diff-total-area')
             },
-            _new_indicator(term_id, MODEL, indicator.get('landCover', {}).get('@id'), 'permanentCropland') | {
-                'value': indicator.get('value') * permanent / total
+            _new_indicator(term_id, MODEL, value.get('landCover-id'), 'permanentCropland') | {
+                'value': value.get('value') * value.get('diff-permanent-area') / value.get('diff-total-area')
             }
         ]
-        for indicator in indicators
-    ]) if total is not None else []
+        for value in values
+    ])

hestia_earth/models/geospatialDatabase/utils.py

@@ -101,10 +101,12 @@ def _get_region_area_size(site: dict):
 
 
 def get_area_size(site: dict):
-    return None if has_coordinates(site) else (
-        # fallback if `boundary` provided but no `boundaryArea` was computed
-        site.get('boundaryArea') or _get_boundary_area_size(site.get('boundary'))
-    ) if has_boundary(site) else _get_region_area_size(site)
+    return _cached_value(site, CACHE_AREA_SIZE) or (
+        None if has_coordinates(site) else (
+            # fallback if `boundary` provided but no `boundaryArea` was computed
+            site.get('boundaryArea') or _get_boundary_area_size(site.get('boundary'))
+        ) if has_boundary(site) else _get_region_area_size(site)
+    )
 
 
 def _is_below_max_size(term: str, site: dict) -> bool:

hestia_earth/models/hestia/default_emissions.py

@@ -6,7 +6,7 @@ from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils import _omit
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.background_emissions import no_gap_filled_background_emissions
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.input import unique_background_inputs
 from . import MODEL
 

hestia_earth/models/hestia/default_resourceUse.py

@@ -6,7 +6,7 @@ from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils import _omit
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.background_emissions import no_gap_filled_background_emissions
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.input import unique_background_inputs
 from . import MODEL
 

hestia_earth/models/hestia/excretaKgMass.py

@@ -3,7 +3,7 @@ from hestia_earth.utils.model import filter_list_term_type, find_term_match
 from hestia_earth.utils.tools import non_empty_list, list_sum
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
-from hestia_earth.models.utils import get_kg_term_id, get_kg_N_term_id, get_kg_VS_term_id
+from hestia_earth.models.utils import get_kg_term_id, get_kg_N_term_id, get_kg_VS_term_id, _filter_list_term_unit
 from hestia_earth.models.utils.term import download_term
 from hestia_earth.models.utils.constant import Units
 from hestia_earth.models.utils.product import _new_product, convert_product_to_unit
@@ -31,12 +31,12 @@ RETURNS = {
 MODEL_KEY = 'excretaKgMass'
 
 UNITS = [
-    Units.KG_N.value,
-    Units.KG_VS.value
+    Units.KG_N,
+    Units.KG_VS
 ]
 
 
-def _product(value: float, term_id: str):
+def _product(term_id: str, value: float = None):
     product = _new_product(term_id, value, MODEL)
     return product
 
@@ -80,17 +80,15 @@ def _run_product(cycle: dict, product_term_id: str):
     # use existing product if exist, else create new one
     existing_product = find_term_match(cycle.get('products', []), product_term_id)
 
-    return (existing_product | _product(value, product_term_id)) if value else None
+    return (existing_product | _product(product_term_id, value)) if value else _product(product_term_id)
 
 
 def _should_run(cycle: dict):
     node_type = cycle.get('type', cycle.get('@type'))
     excreta_products = filter_list_term_type(cycle.get('products', []), TermTermType.EXCRETA)
     kg_term_ids = list(set([
-        get_kg_term_id(p.get('term', {}).get('@id')) for p in excreta_products if all([
-            p.get('term', {}).get('units') in UNITS,
-            p.get('value', [])
-        ])
+        get_kg_term_id(p.get('term', {}).get('@id'))
+        for p in _filter_list_term_unit(excreta_products, UNITS)
     ]))
     gap_fill_term_ids = [
         term_id for term_id in kg_term_ids if not find_term_match(excreta_products, term_id).get('value', [])

hestia_earth/models/hestia/seed_emissions.py

@@ -14,7 +14,7 @@ from hestia_earth.models.utils.site import valid_site_type
 from hestia_earth.models.utils.cycle import cycle_end_year
 from hestia_earth.models.utils.crop import get_crop_grouping_faostat_production, get_landCover_term_id
 from hestia_earth.models.utils.completeness import _is_term_type_complete
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.lookup import get_region_lookup_value
 from . import MODEL
 

hestia_earth/models/hestia/stockingDensityAnimalHousingAverage.py

@@ -3,7 +3,7 @@ from hestia_earth.utils.model import filter_list_term_type
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
 from hestia_earth.models.utils import weighted_average
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.practice import _new_practice
 from . import MODEL
 

hestia_earth/models/hestia/waterSalinity.py

@@ -5,7 +5,7 @@ from hestia_earth.utils.tools import safe_parse_float
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
 from hestia_earth.models.utils.measurement import _new_measurement
 from hestia_earth.models.utils.site import related_cycles
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from . import MODEL
 
 REQUIREMENTS = {

hestia_earth/models/ipcc2019/ch4ToAirAquacultureSystems.py

@@ -3,7 +3,7 @@ from hestia_earth.utils.model import find_term_match
 from hestia_earth.utils.tools import safe_parse_float, non_empty_list
 
 from hestia_earth.models.log import logRequirements, logShouldRun
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.emission import _new_emission
 from . import MODEL
 

hestia_earth/models/ipcc2019/n2OToAirCropResidueBurningDirect.py

@@ -2,7 +2,7 @@ from hestia_earth.schema import EmissionMethodTier
 
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
-from hestia_earth.models.utils.blank_node import get_lookup_value
+from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.cropResidue import get_crop_residue_burnt_value
 from . import MODEL