hestia-earth-models 0.73.7__py3-none-any.whl → 0.74.0__py3-none-any.whl

hestia_earth/models/aware/scarcityWeightedWaterUse.py

@@ -38,8 +38,8 @@ RETURNS = {
 }
 LOOKUPS = {
     "@doc": "Different lookup files are used depending on the situation",
-    "awareWaterBasinId": "",
-    "region-aware-factors": ""
+    "awareWaterBasinId": ["YR_IRRI", "YR_NONIRRI", "YR_TOT"],
+    "region-aware-factors": ["Agg_CF_irri", "Agg_CF_non_irri", "Agg_CF_unspecified"]
 }
 TERM_ID = 'scarcityWeightedWaterUse'
 AWARE_KEY = 'awareWaterBasinId'
@@ -48,6 +48,8 @@ IRRIGATED_SITE_TYPES = [
     SiteSiteType.GLASS_OR_HIGH_ACCESSIBLE_COVER.value,
     SiteSiteType.PERMANENT_PASTURE.value
 ]
+_REGION_LOOKUP = 'region-aware-factors.csv'
+_AWARE_LOOKUP = 'awareWaterBasinId.csv'
 
 
 def _indicator(value: float):
@@ -59,19 +61,18 @@ def _indicator(value: float):
 def _get_factor_from_basinId(site: dict, aware_id: str):
     lookup_col = 'YR_IRRI' if site.get('siteType') in IRRIGATED_SITE_TYPES else 'YR_NONIRRI'
     value = _get_single_table_value(
-        download_lookup(f"{AWARE_KEY}.csv"), column_name(AWARE_KEY), int(aware_id), column_name(lookup_col)
+        download_lookup(_AWARE_LOOKUP), column_name(AWARE_KEY), int(aware_id), column_name(lookup_col)
     )
-    debugMissingLookup(f"{AWARE_KEY}.csv", AWARE_KEY, aware_id, lookup_col, value, model=MODEL, term=TERM_ID)
+    debugMissingLookup(_AWARE_LOOKUP, AWARE_KEY, aware_id, lookup_col, value, model=MODEL, term=TERM_ID)
     return safe_parse_float(value, default=None)
 
 
 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')
     column = f"Agg_CF_{lookup_suffix}"
-    value = get_region_lookup_value(lookup_name, region_id, column, model=MODEL, term=TERM_ID)
+    value = get_region_lookup_value(_REGION_LOOKUP, region_id, column, model=MODEL, term=TERM_ID)
     return safe_parse_float(value, default=None)
 
 

hestia_earth/models/aware2_0/__init__.py

@@ -0,0 +1,14 @@
+import sys
+from importlib import import_module
+from os.path import dirname, abspath
+
+from hestia_earth.models.utils.blank_node import run_if_required
+
+CURRENT_DIR = dirname(abspath(__file__)) + '/'
+sys.path.append(CURRENT_DIR)
+MODEL = 'aware2-0'
+MODEL_FOLDER = MODEL.replace('-', '_')
+PKG = '.'.join(['hestia_earth', 'models', MODEL_FOLDER])
+
+
+def run(model: str, data): return run_if_required(MODEL, model, data, import_module(f".{model}", package=PKG))

hestia_earth/models/aware2_0/scarcityWeightedWaterUse.py

@@ -0,0 +1,115 @@
+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
+
+from hestia_earth.models.log import logRequirements, debugMissingLookup, 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, 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
+from . import MODEL
+
+REQUIREMENTS = {
+    "ImpactAssessment": {
+        "site": {
+            "@type": "Site",
+            "or": {
+                "awareWaterBasinId": "",
+                "country": {"@type": "Term", "termType": "region"}
+            }
+        },
+        "optional": {
+            "emissionsResourceUse": [{
+                "@type": "Indicator",
+                "term.@id": "freshwaterWithdrawalsDuringCycle",
+                "value": ""
+            }]
+        }
+    }
+}
+RETURNS = {
+    "Indicator": [{
+        "value": ""
+    }]
+}
+LOOKUPS = {
+    "@doc": "Different lookup files are used depending on the situation",
+    "awareWaterBasinId-2-0": ["CFs_agri", "CFs_nonagri", "CFs_unspecified"],
+    "region-aware-2-0-factors": ["CFs_agri", "CFs_nonagri", "CFs_unspecified"]
+}
+TERM_ID = 'scarcityWeightedWaterUse'
+AWARE_KEY = 'awareWaterBasinId'
+AGRI_SITE_TYPES = [
+    SiteSiteType.CROPLAND.value,
+    SiteSiteType.GLASS_OR_HIGH_ACCESSIBLE_COVER.value,
+    SiteSiteType.PERMANENT_PASTURE.value
+]
+_REGION_LOOKUP = 'region-aware-2-0-factors.csv'
+_AWARE_LOOKUP = 'awareWaterBasinId-2-0.csv'
+
+
+def _indicator(value: float):
+    indicator = _new_indicator(TERM_ID, MODEL)
+    indicator['value'] = value
+    return indicator
+
+
+def _lookup_column(site: dict):
+    site_type = site.get('siteType')
+    return (
+        'CFs_unspecified' if not site_type else
+        'CFs_agri' if site_type in AGRI_SITE_TYPES else
+        'CFs_nonagri'
+    )
+
+
+def _get_factor_from_basinId(site: dict, aware_id: str):
+    lookup_col = _lookup_column(site)
+    lookup = download_lookup(_AWARE_LOOKUP)
+    try:
+        value = _get_single_table_value(lookup, column_name(AWARE_KEY), int(aware_id), column_name(lookup_col))
+    except Exception:
+        value = None
+    debugMissingLookup(_AWARE_LOOKUP, AWARE_KEY, aware_id, lookup_col, value, model=MODEL, term=TERM_ID)
+    return safe_parse_float(value, default=None)
+
+
+def _get_factor_from_region(impact_assessment: dict, fresh_water: dict, site: dict):
+    region_id = get_region_id(impact_assessment, fresh_water)
+    lookup_col = _lookup_column(site)
+    value = get_region_lookup_value(_REGION_LOOKUP, region_id, lookup_col, model=MODEL, term=TERM_ID)
+    return safe_parse_float(value, default=None)
+
+
+def run(impact_assessment: dict):
+    cycle = impact_assessment.get('cycle', {})
+    product = get_product(impact_assessment)
+    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, 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.get('value'), factor]),
+        inputs_value
+    ])
+
+    logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
+                    fresh_water=fresh_water.get('value'),
+                    aware_id=aware_id,
+                    factor=factor,
+                    inputs_value=inputs_value)
+
+    should_run = all([value is not None])
+    logShouldRun(impact_assessment, MODEL, TERM_ID, should_run)
+
+    return [_indicator(value)] if should_run else []

hestia_earth/models/config/Cycle.json

@@ -955,7 +955,7 @@
     {
       "key": "emissions",
       "model": "ecoinventV3AndEmberClimate",
-      "value": "all",
+      "value": "cycle",
       "runStrategy": "always",
       "mergeStrategy": "list",
       "mergeArgs": {
@@ -966,7 +966,7 @@
     {
       "key": "emissions",
       "model": "ecoinventV3",
-      "value": "all",
+      "value": "cycle",
       "runStrategy": "always",
       "mergeStrategy": "list",
       "mergeArgs": {
@@ -1469,7 +1469,9 @@
           "replaceThreshold": ["value", 0.01]
         },
         "stage": 2
-      },
+      }
+    ],
+    [
       {
         "key": "emissions",
         "model": "dammgen2009",
@@ -2080,8 +2082,8 @@
     [
       {
         "key": "emissions",
-        "model": "ipcc2019",
-        "value": "n2OToAirInorganicFertiliserIndirect",
+        "model": "pooreNemecek2018",
+        "value": "noxToAirAquacultureSystems",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2095,8 +2097,8 @@
       },
       {
         "key": "emissions",
-        "model": "jarvisAndPain1994",
-        "value": "n2ToAirExcreta",
+        "model": "pooreNemecek2018",
+        "value": "nh3ToAirAquacultureSystems",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2107,24 +2109,11 @@
           "replaceThreshold": ["value", 0.01]
         },
         "stage": 2
-      }
-    ],
-    {
-      "key": "emissions",
-      "model": "emissionNotRelevant",
-      "value": "all",
-      "runStrategy": "always",
-      "mergeStrategy": "list",
-      "mergeArgs": {
-        "replaceLowerTier": true
       },
-      "stage": 2
-    },
-    [
       {
         "key": "emissions",
         "model": "pooreNemecek2018",
-        "value": "noxToAirAquacultureSystems",
+        "value": "n2ToAirAquacultureSystems",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2139,7 +2128,7 @@
       {
         "key": "emissions",
         "model": "pooreNemecek2018",
-        "value": "nh3ToAirAquacultureSystems",
+        "value": "n2OToAirAquacultureSystemsDirect",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2154,7 +2143,7 @@
       {
         "key": "emissions",
         "model": "pooreNemecek2018",
-        "value": "n2ToAirAquacultureSystems",
+        "value": "ch4ToAirAquacultureSystems",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2168,8 +2157,25 @@
       },
       {
         "key": "emissions",
-        "model": "pooreNemecek2018",
-        "value": "n2OToAirAquacultureSystemsDirect",
+        "model": "hestia",
+        "value": "pToSurfaceWaterAquacultureSystems",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      }
+    ],
+    [
+      {
+        "key": "emissions",
+        "model": "ipcc2019",
+        "value": "n2OToAirInorganicFertiliserIndirect",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2183,8 +2189,8 @@
       },
       {
         "key": "emissions",
-        "model": "pooreNemecek2018",
-        "value": "ch4ToAirAquacultureSystems",
+        "model": "ipcc2019",
+        "value": "n2OToAirAquacultureSystemsIndirect",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2198,8 +2204,83 @@
       },
       {
         "key": "emissions",
-        "model": "hestia",
-        "value": "pToSurfaceWaterAquacultureSystems",
+        "model": "ipcc2019",
+        "value": "n2OToAirCropResidueBurningIndirect",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "emissions",
+        "model": "ipcc2019",
+        "value": "n2OToAirFuelCombustionIndirect",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "emissions",
+        "model": "ipcc2019",
+        "value": "n2OToAirNaturalVegetationBurningIndirect",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "emissions",
+        "model": "ipcc2019",
+        "value": "n2OToAirOrganicSoilBurningIndirect",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "emissions",
+        "model": "ipcc2019",
+        "value": "n2OToAirOrganicSoilCultivationIndirect",
+        "runStrategy": "add_blank_node_if_missing",
+        "runArgs": {
+          "runNonMeasured": true,
+          "runNonAddedTerm": true
+        },
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "emissions",
+        "model": "jarvisAndPain1994",
+        "value": "n2ToAirExcreta",
         "runStrategy": "add_blank_node_if_missing",
         "runArgs": {
           "runNonMeasured": true,
@@ -2212,6 +2293,17 @@
         "stage": 2
       }
     ],
+    {
+      "key": "emissions",
+      "model": "emissionNotRelevant",
+      "value": "all",
+      "runStrategy": "always",
+      "mergeStrategy": "list",
+      "mergeArgs": {
+        "replaceLowerTier": true
+      },
+      "stage": 2
+    },
     {
       "key": "products",
       "model": "transformation",