hestia-earth-models 0.63.0__py3-none-any.whl → 0.64.1__py3-none-any.whl

hestia_earth/models/geospatialDatabase/sandContent.py

@@ -1,4 +1,5 @@
 from hestia_earth.schema import MeasurementMethodClassification
+from hestia_earth.utils.tools import non_empty_list
 
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.blank_node import has_original_by_ids
@@ -29,37 +30,63 @@ REQUIREMENTS = {
 RETURNS = {
     "Measurement": [{
         "value": "",
-        "depthUpper": "0",
-        "depthLower": "30",
+        "depthUpper": "",
+        "depthLower": "",
         "methodClassification": "geospatial dataset"
     }]
 }
 TERM_ID = 'sandContent'
-EE_PARAMS = {
-    'collection': 'T_SAND',
-    'ee_type': 'raster',
-    'reducer': 'mean'
-}
-BIBLIO_TITLE = 'Harmonized World Soil Database Version 1.2. Food and Agriculture Organization of the United Nations (FAO).'  # noqa: E501
+EE_PARAMS = [
+    {
+        'collection': 'T_SAND_v2_depth_1',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 0,
+        'depthLower': 20
+    },
+    {
+        'collection': 'T_SAND_v2_depth_2',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 20,
+        'depthLower': 40
+    },
+    {
+        'collection': 'T_SAND_v2_depth_3',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 40,
+        'depthLower': 60
+    },
+    {
+        'collection': 'T_SAND_v2_depth_4',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 60,
+        'depthLower': 80
+    }
+]
+BIBLIO_TITLE = 'Harmonized World Soil Database Version 2.0.'
 
 
-def _measurement(site: dict, value: int):
+def _measurement(site: dict, value: int, depthUpper: int, depthLower: int):
     measurement = _new_measurement(TERM_ID)
     measurement['value'] = [value]
-    measurement['depthUpper'] = 0
-    measurement['depthLower'] = 30
+    measurement['depthUpper'] = depthUpper
+    measurement['depthLower'] = depthLower
     measurement['methodClassification'] = MeasurementMethodClassification.GEOSPATIAL_DATASET.value
     return measurement | get_source(site, BIBLIO_TITLE)
 
 
-def _download(site: dict):
-    value = download(TERM_ID, site, EE_PARAMS)
-    return None if value is None else round(value, 2)
+def _run_depths(site: dict, params: dict):
+    value = download(TERM_ID, site, params)
+    return None if value is None else (
+        _measurement(site, round(value, 2), params.get('depthUpper'), params.get('depthLower'))
+    )
 
 
 def _run(site: dict):
-    value = _download(site)
-    return [_measurement(site, value)] if value is not None else []
+    return non_empty_list([_run_depths(site, params) for params in EE_PARAMS])
 
 
 def _should_run(site: dict):

hestia_earth/models/geospatialDatabase/siltContent.py

@@ -1,12 +1,30 @@
 from hestia_earth.schema import MeasurementMethodClassification
+from hestia_earth.utils.model import find_term_match
+from hestia_earth.utils.tools import non_empty_list, flatten
 
-from hestia_earth.models.log import logRequirements, logShouldRun, log_blank_nodes_id
-from hestia_earth.models.utils.measurement import _new_measurement, measurement_value
+from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
+from hestia_earth.models.utils.measurement import _new_measurement, measurement_value, group_measurements_by_depth
 from hestia_earth.models.utils.source import get_source
 from . import MODEL, clayContent, sandContent
 
 REQUIREMENTS = {
     "Site": {
+        "measurements": [
+            {
+                "@type": "Measurement",
+                "term.@id": "clayContent",
+                "value": ">= 0",
+                "depthUpper": ">= 0",
+                "depthLower": ">= 0"
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "sandContent",
+                "value": ">= 0",
+                "depthUpper": ">= 0",
+                "depthLower": ">= 0"
+            }
+        ],
         "or": [
             {"latitude": "", "longitude": ""},
             {"boundary": {}},
@@ -17,8 +35,8 @@ REQUIREMENTS = {
 RETURNS = {
     "Measurement": [{
         "value": "",
-        "depthUpper": "0",
-        "depthLower": "30",
+        "depthUpper": "",
+        "depthLower": "",
         "methodClassification": "geospatial dataset"
     }]
 }
@@ -27,39 +45,61 @@ OTHER_TERM_IDS = [
     clayContent.TERM_ID,
     sandContent.TERM_ID
 ]
-BIBLIO_TITLE = 'Harmonized World Soil Database Version 1.2. Food and Agriculture Organization of the United Nations (FAO).'  # noqa: E501
+BIBLIO_TITLE = 'Harmonized World Soil Database Version 2.0.'
 
 
-def _measurement(site: dict, value: int):
+def _measurement(site: dict, value: int, depthUpper: int, depthLower: int):
     measurement = _new_measurement(TERM_ID)
     measurement['value'] = [value]
-    measurement['depthUpper'] = 0
-    measurement['depthLower'] = 30
+    measurement['depthUpper'] = depthUpper
+    measurement['depthLower'] = depthLower
     measurement['methodClassification'] = MeasurementMethodClassification.GEOSPATIAL_DATASET.value
     return measurement | get_source(site, BIBLIO_TITLE)
 
 
 def _run(site: dict, measurements: list):
     value = 100 - sum([measurement_value(m) for m in measurements])
-    return [_measurement(site, value)]
+    return [_measurement(site, value, measurements[0].get('depthUpper'), measurements[0].get('depthLower'))]
 
 
 def _should_run(site: dict):
-    measurements = [
-        m for m in site.get('measurements', [])
-        if m.get('term', {}).get('@id') in OTHER_TERM_IDS and len(m.get('value', [])) > 0
+    grouped_measurements = group_measurements_by_depth(site.get('measurements', []), include_dates=False)
+    relevant_measurements = [
+        [
+            m for m in measurements if all([
+                m.get('term', {}).get('@id') in OTHER_TERM_IDS,
+                len(m.get('value', [])) > 0,
+                m.get('depthUpper', -1) >= 0,
+                m.get('depthLower', -1) >= 0
+            ])
+        ]
+        for measurements in grouped_measurements.values()
+    ]
+    valid_measurements = [
+        values for values in relevant_measurements if len(values) == len(OTHER_TERM_IDS)
     ]
-    has_all_measurements = len(measurements) == len(OTHER_TERM_IDS)
+
+    has_valid_measurements = len(valid_measurements) > 0
 
     logRequirements(site, model=MODEL, term=TERM_ID,
-                    has_all_measurements=has_all_measurements,
-                    measurement_ids=log_blank_nodes_id(measurements))
+                    has_valid_measurements=has_valid_measurements,
+                    measurements=log_as_table([
+                        {
+                            'depths': '-'.join(non_empty_list([
+                                str(values[0].get('depthUpper', '')),
+                                str(values[0].get('depthLower', ''))
+                            ]))
+                        } | {
+                            term_id: measurement_value(find_term_match(values, term_id))
+                            for term_id in OTHER_TERM_IDS
+                        } for values in valid_measurements
+                    ]))
 
-    should_run = all([has_all_measurements])
+    should_run = all([has_valid_measurements])
     logShouldRun(site, MODEL, TERM_ID, should_run)
-    return should_run, measurements
+    return should_run, valid_measurements
 
 
 def run(site: dict):
     should_run, measurements = _should_run(site)
-    return _run(site, measurements) if should_run else []
+    return flatten([_run(site, values) for values in measurements]) if should_run else []

hestia_earth/models/geospatialDatabase/soilPh.py

@@ -1,4 +1,5 @@
 from hestia_earth.schema import MeasurementMethodClassification
+from hestia_earth.utils.tools import non_empty_list
 
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.measurement import _new_measurement
@@ -18,37 +19,63 @@ REQUIREMENTS = {
 RETURNS = {
     "Measurement": [{
         "value": "",
-        "depthUpper": "0",
-        "depthLower": "30",
+        "depthUpper": "",
+        "depthLower": "",
         "methodClassification": "geospatial dataset"
     }]
 }
 TERM_ID = 'soilPh'
-EE_PARAMS = {
-    'collection': 'T_PH_H2O',
-    'ee_type': 'raster',
-    'reducer': 'mean'
-}
-BIBLIO_TITLE = 'Harmonized World Soil Database Version 1.2. Food and Agriculture Organization of the United Nations (FAO).'  # noqa: E501
+EE_PARAMS = [
+    {
+        'collection': 'T_PH_H2O_v2_depth_1',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 0,
+        'depthLower': 20
+    },
+    {
+        'collection': 'T_PH_H2O_v2_depth_2',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 20,
+        'depthLower': 40
+    },
+    {
+        'collection': 'T_PH_H2O_v2_depth_3',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 40,
+        'depthLower': 60
+    },
+    {
+        'collection': 'T_PH_H2O_v2_depth_4',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 60,
+        'depthLower': 80
+    }
+]
+BIBLIO_TITLE = 'Harmonized World Soil Database Version 2.0.'
 
 
-def _measurement(site: dict, value: float):
+def _measurement(site: dict, value: int, depthUpper: int, depthLower: int):
     measurement = _new_measurement(TERM_ID)
     measurement['value'] = [value]
-    measurement['depthUpper'] = 0
-    measurement['depthLower'] = 30
+    measurement['depthUpper'] = depthUpper
+    measurement['depthLower'] = depthLower
     measurement['methodClassification'] = MeasurementMethodClassification.GEOSPATIAL_DATASET.value
     return measurement | get_source(site, BIBLIO_TITLE)
 
 
-def _download(site: dict):
-    value = download(TERM_ID, site, EE_PARAMS)
-    return None if value is None else round(value, 7)
+def _run_depths(site: dict, params: dict):
+    value = download(TERM_ID, site, params)
+    return None if value is None else (
+        _measurement(site, round(value, 7), params.get('depthUpper'), params.get('depthLower'))
+    )
 
 
 def _run(site: dict):
-    value = _download(site)
-    return [] if value is None else [_measurement(site, value)]
+    return non_empty_list([_run_depths(site, params) for params in EE_PARAMS])
 
 
 def _should_run(site: dict):

hestia_earth/models/geospatialDatabase/totalNitrogenPerKgSoil.py

@@ -1,5 +1,5 @@
 from hestia_earth.schema import MeasurementMethodClassification
-from hestia_earth.utils.tools import safe_parse_float
+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.measurement import _new_measurement
@@ -19,33 +19,63 @@ REQUIREMENTS = {
 RETURNS = {
     "Measurement": [{
         "value": "",
-        "depthUpper": "0",
-        "depthLower": "50",
+        "depthUpper": "",
+        "depthLower": "",
         "methodClassification": "geospatial dataset"
     }]
 }
 TERM_ID = 'totalNitrogenPerKgSoil'
-EE_PARAMS = {
-    'collection': 'T_N',
-    'ee_type': 'raster',
-    'reducer': 'mean'
-}
-BIBLIO_TITLE = 'Harmonized soil property values for broad-scale modelling (WISE30sec) '
-'with estimates of global soil carbon stocks'
+EE_PARAMS = [
+    {
+        'collection': 'T_N_v2_depth_1',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 0,
+        'depthLower': 20
+    },
+    {
+        'collection': 'T_N_v2_depth_2',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 20,
+        'depthLower': 40
+    },
+    {
+        'collection': 'T_N_v2_depth_3',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 40,
+        'depthLower': 60
+    },
+    {
+        'collection': 'T_N_v2_depth_4',
+        'ee_type': 'raster',
+        'reducer': 'mean',
+        'depthUpper': 60,
+        'depthLower': 80
+    }
+]
+BIBLIO_TITLE = 'Harmonized World Soil Database Version 2.0.'
 
 
-def _measurement(site: dict, value: float):
+def _measurement(site: dict, value: int, depthUpper: int, depthLower: int):
     measurement = _new_measurement(TERM_ID)
     measurement['value'] = [value]
-    measurement['depthUpper'] = 0
-    measurement['depthLower'] = 50
+    measurement['depthUpper'] = depthUpper
+    measurement['depthLower'] = depthLower
     measurement['methodClassification'] = MeasurementMethodClassification.GEOSPATIAL_DATASET.value
     return measurement | get_source(site, BIBLIO_TITLE)
 
 
+def _run_depths(site: dict, params: dict):
+    value = download(TERM_ID, site, params)
+    return None if value is None else (
+        _measurement(site, safe_parse_float(value), params.get('depthUpper'), params.get('depthLower'))
+    )
+
+
 def _run(site: dict):
-    value = download(TERM_ID, site, EE_PARAMS)
-    return [_measurement(site, safe_parse_float(value))] if value is not None else []
+    return non_empty_list([_run_depths(site, params) for params in EE_PARAMS])
 
 
 def _should_run(site: dict):

hestia_earth/models/geospatialDatabase/utils.py

@@ -134,13 +134,19 @@ def _parse_run_query(term: str, query: dict):
         return None
 
 
+def _cache_sub_key(collection: dict):
+    return '-'.join(non_empty_list([
+        str(collection.get('year', '')),
+        str(collection.get('start_date', '')),
+        str(collection.get('end_date', '')),
+        str(collection.get('depthUpper', '')),
+        str(collection.get('depthLower', ''))
+    ]))
+
+
 def _get_cached_data(term: str, site: dict, data: dict):
     cache = _cached_value(site, term)
-    cache_sub_key = '-'.join(non_empty_list([
-        data.get('year'),
-        data.get('start_date'),
-        data.get('end_date')
-    ]))
+    cache_sub_key = _cache_sub_key(data)
     # data can be grouped by year when required
     value = cache.get(cache_sub_key) if (
         isinstance(cache, dict) and cache_sub_key in cache and cache is not None

hestia_earth/models/hyde32/landTransformationFromCropland100YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromCropland100YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromCropland20YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromCropland20YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromForest100YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromForest100YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromForest20YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromForest20YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromOtherNaturalVegetation100YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromOtherNaturalVegetation100YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromOtherNaturalVegetation20YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromOtherNaturalVegetation20YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromPermanentPasture100YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromPermanentPasture100YearAverageDuringCycle'

hestia_earth/models/hyde32/landTransformationFromPermanentPasture20YearAverageDuringCycle.py

@@ -50,7 +50,8 @@ LOOKUPS = {
 }
 RETURNS = {
     "Indicator": [{
-        "value": ""
+        "value": "",
+        "landCover": ""
     }]
 }
 TERM_ID = 'landTransformationFromPermanentPasture20YearAverageDuringCycle'

hestia_earth/models/hyde32/utils.py

@@ -6,6 +6,7 @@ from hestia_earth.models.log import debugMissingLookup, debugValues, logRequirem
 from hestia_earth.models.utils.indicator import _new_indicator
 from hestia_earth.models.utils.impact_assessment import get_product, get_site, get_region_id
 from hestia_earth.models.utils.cycle import land_occupation_per_kg
+from hestia_earth.models.utils.site import get_land_cover_term_id
 from . import MODEL
 
 
@@ -28,17 +29,19 @@ def _get_emission_factor(term_id: str, impact_assessment: dict, average_years: s
     return safe_parse_float(extract_grouped_data_closest_date(value, end_date.year), None) if end_date else None
 
 
-def _indicator(term_id: str, value: float):
-    indicator = _new_indicator(term_id, MODEL)
+def _indicator(term_id: str, value: float, land_covert_term_id: str):
+    indicator = _new_indicator(term_id, MODEL, land_covert_term_id)
     indicator['value'] = value
     return indicator
 
 
 def _run(impact_assessment: dict, term_id: str, land_occupation_m2: float, factor: float):
+    land_covert_term_id = get_land_cover_term_id(get_site(impact_assessment).get('siteType'))
     value = land_occupation_m2 * (factor or 0)
     debugValues(impact_assessment, model=MODEL, term=term_id,
-                value=value)
-    return _indicator(term_id, value)
+                value=value,
+                land_covert_term_id=land_covert_term_id)
+    return _indicator(term_id, value, land_covert_term_id)
 
 
 def _should_run(impact_assessment: dict, term_id: str, from_site_type: SiteSiteType, years: int):

hestia_earth/models/impact_assessment/allocationMethod.py

@@ -0,0 +1,39 @@
+"""
+Allocation Method
+
+If any of the impact `emissionsResourceUse`, `impacts`, or `endpoints`, have been modified by the calculations,
+the `allocationMethod` will be set to `economic`.
+"""
+from hestia_earth.schema import ImpactAssessmentAllocationMethod
+
+from hestia_earth.models.log import logShouldRun, logRequirements
+from . import MODEL
+
+REQUIREMENTS = {
+    "ImpactAssessment": {
+        "updated": ["emissionsResourceUse", "impacts", "endpoints"],
+        "added": ["emissionsResourceUse", "impacts", "endpoints"]
+    }
+}
+RETURNS = {
+    "`economic` if any indicators were updated or added by the HESTIA models": ""
+}
+
+MODEL_KEY = 'allocationMethod'
+_MODIFIED_KEYS = ["emissionsResourceUse", "impacts", "endpoints"]
+
+
+def _should_run(impact: dict):
+    modified = impact.get('updated', []) + impact.get('added', [])
+    is_modified_by_hestia = any([key for key in _MODIFIED_KEYS if key in modified])
+
+    logRequirements(impact, model=MODEL, key=MODEL_KEY,
+                    is_modified_by_hestia=is_modified_by_hestia)
+
+    should_run = all([is_modified_by_hestia])
+    logShouldRun(impact, MODEL, None, should_run, key=MODEL_KEY)
+    return should_run
+
+
+def run(impact: dict):
+    return ImpactAssessmentAllocationMethod.ECONOMIC.value if _should_run(impact) else None

hestia_earth/models/impact_assessment/emissions.py

@@ -31,7 +31,8 @@ REQUIREMENTS = {
 RETURNS = {
     "Indicator": [{
         "term": "",
-        "value": ""
+        "value": "",
+        "methodTier": ""
     }]
 }
 MODEL_KEY = 'emissions'
@@ -44,6 +45,7 @@ def _indicator(product: dict):
 
         indicator = _new_indicator(emission.get('term', {}), emission.get('methodModel'))
         indicator['value'] = value
+        indicator['methodTier'] = emission.get('methodTier')
 
         if len(emission.get('inputs', [])):
             indicator['inputs'] = emission['inputs']