hestia-earth-models 0.72.1__tar.gz → 0.73.0__tar.gz

hestia_earth_models-0.73.0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.1
+Name: hestia_earth_models
+Version: 0.73.0
+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: MIT
+Platform: UNKNOWN
+Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
+Classifier: Programming Language :: Python :: 3.6
+Description-Content-Type: text/markdown
+Provides-Extra: spatial
+License-File: LICENSE
+
+# HESTIA Engine Models
+
+[![Pipeline Status](https://gitlab.com/hestia-earth/hestia-engine-models/badges/master/pipeline.svg)](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)
+[![Coverage Report](https://gitlab.com/hestia-earth/hestia-engine-models/badges/master/coverage.svg)](https://gitlab.com/hestia-earth/hestia-engine-models/commits/master)
+
+HESTIA's set of models for running calculations or retrieving data using external datasets and internal lookups.
+
+## Documentation
+
+Documentation for every model can be found in the [HESTIA API Documentation](https://hestia.earth/docs/#hestia-calculation-models).
+
+## Install
+
+1. Install python `3` (we recommend using python `3.6` minimum)
+2. Install the module:
+```bash
+pip install hestia_earth.models
+```
+3. Set the following environment variables:
+```
+API_URL=https://api.hestia.earth
+WEB_URL=https://hestia.earth
+```
+
+### Usage
+
+```python
+from hestia_earth.models.pooreNemecek2018 import run
+
+cycle_data = {"@type": "Cycle", ...}
+# cycle is a JSONLD node Cycle
+result = run('no3ToGroundwaterSoilFlux', cycle_data)
+print(result)
+```
+
+This will display only the result of the `no3ToGroundwaterSoilFlux` model (Emission).
+
+Additionally, to reduce the number of queries to the HESTIA API and run the models faster, prefetching can be enabled:
+```python
+from hestia_earth.models.preload_requests import enable_preload
+
+enable_preload()
+```
+
+#### Using the orchestrator
+
+The models come with an "orchestrator", which allows you to run a pre-configured set of models instead of a single one.
+
+The configuration for each Node (Cycle, Site or ImpactAssessment) can be found in the [config](./config) folder.
+
+Usage:
+```python
+from hestia_earth.orchestrator import run
+from hestia_earth.models.config import load_config
+
+cycle_data = {"@type": "Cycle", ...}
+result = run(cycle, load_config(cycle))
+print(result)
+```
+
+This will display the Cycle recalculated with all HESTIA default models running.
+
+#### Using Spatial Models
+
+We have models that can gap-fill geographical information on a `Site`. If you want to use these models:
+1. Install the library: `pip install hestia_earth.earth_engine`
+2. Follow the [Getting Started instructions](https://gitlab.com/hestia-earth/hestia-earth-engine#getting-started).
+
+#### Using the ecoinventV3 model
+
+ecoinvent is a consistent, transparent, and well validated life cycle inventory database.
+We use ecoinvent data to ascertain the environmental impacts of activities that occur outside of our system boundary, for example data on the environmental impacts of extracting oil and producing diesel, or the impacts of manufacturing plastics.
+
+The `ecoinventV3` model requires a valid [license](https://ecoinvent.org/offerings/licences/) to run. We are currently working on a way to enable users of this code with a valid ecoinvent licence to run these models themselves, but for now, these models are only available on the public platform.
+
+

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/__init__.py

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

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/ch4ToAirCropResidueBurning.py

@@ -0,0 +1,32 @@
+from hestia_earth.schema import EmissionMethodTier
+
+from .utils import run_emission
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "products": [{
+                "@type": "Product",
+                "term.@id": ["aboveGroundCropResidueBurnt", "discardedCropBurnt"],
+                "value": ""
+            }],
+            "completeness.cropResidue": "True"
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "sd": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "emission": ["akagiEtAl2011CropResidueBurningFactor", "akagiEtAl2011CropResidueBurningFactor-sd"]
+}
+TERM_ID = 'ch4ToAirCropResidueBurning'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def run(cycle: dict): return run_emission(TERM_ID, cycle)

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/nh3ToAirCropResidueBurning.py

@@ -0,0 +1,32 @@
+from hestia_earth.schema import EmissionMethodTier
+
+from .utils import run_emission
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "products": [{
+                "@type": "Product",
+                "term.@id": ["aboveGroundCropResidueBurnt", "discardedCropBurnt"],
+                "value": ""
+            }],
+            "completeness.cropResidue": "True"
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "sd": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "emission": ["akagiEtAl2011CropResidueBurningFactor", "akagiEtAl2011CropResidueBurningFactor-sd"]
+}
+TERM_ID = 'nh3ToAirCropResidueBurning'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def run(cycle: dict): return run_emission(TERM_ID, cycle)

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/noxToAirCropResidueBurning.py

@@ -0,0 +1,32 @@
+from hestia_earth.schema import EmissionMethodTier
+
+from .utils import run_emission
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "products": [{
+                "@type": "Product",
+                "term.@id": ["aboveGroundCropResidueBurnt", "discardedCropBurnt"],
+                "value": ""
+            }],
+            "completeness.cropResidue": "True"
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "sd": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "emission": ["akagiEtAl2011CropResidueBurningFactor", "akagiEtAl2011CropResidueBurningFactor-sd"]
+}
+TERM_ID = 'noxToAirCropResidueBurning'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def run(cycle: dict): return run_emission(TERM_ID, cycle)

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/pm25ToAirCropResidueBurning.py

@@ -0,0 +1,32 @@
+from hestia_earth.schema import EmissionMethodTier
+
+from .utils import run_emission
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "products": [{
+                "@type": "Product",
+                "term.@id": ["aboveGroundCropResidueBurnt", "discardedCropBurnt"],
+                "value": ""
+            }],
+            "completeness.cropResidue": "True"
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "sd": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "emission": ["akagiEtAl2011CropResidueBurningFactor", "akagiEtAl2011CropResidueBurningFactor-sd"]
+}
+TERM_ID = 'pm25ToAirCropResidueBurning'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def run(cycle: dict): return run_emission(TERM_ID, cycle)

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/so2ToAirCropResidueBurning.py

@@ -0,0 +1,32 @@
+from hestia_earth.schema import EmissionMethodTier
+
+from .utils import run_emission
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "products": [{
+                "@type": "Product",
+                "term.@id": ["aboveGroundCropResidueBurnt", "discardedCropBurnt"],
+                "value": ""
+            }],
+            "completeness.cropResidue": "True"
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "sd": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "emission": ["akagiEtAl2011CropResidueBurningFactor", "akagiEtAl2011CropResidueBurningFactor-sd"]
+}
+TERM_ID = 'so2ToAirCropResidueBurning'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def run(cycle: dict): return run_emission(TERM_ID, cycle)

hestia_earth_models-0.73.0/hestia_earth/models/akagiEtAl2011/utils.py

@@ -0,0 +1,45 @@
+from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, TermTermType
+
+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.cropResidue import get_crop_residue_burnt_value
+from . import MODEL
+
+TIER = EmissionMethodTier.TIER_1.value
+LOOKUP_NAME = 'akagiEtAl2011CropResidueBurningFactor'
+
+
+def _emission(term_id: str, value: float, sd: float = None):
+    emission = _new_emission(term_id, MODEL)
+    emission['value'] = [value]
+    emission['methodTier'] = TIER
+    if sd is not None:
+        emission['sd'] = [sd]
+        emission['statsDefinition'] = EmissionStatsDefinition.MODELLED.value
+    return emission
+
+
+def _run(term_id: str, product_value: list):
+    value = sum(product_value)
+    term = {'termType': TermTermType.EMISSION.value, '@id': term_id}
+    factor = get_lookup_value(term, LOOKUP_NAME)
+    factor_sd = get_lookup_value(term, LOOKUP_NAME + '-sd')
+    return [_emission(term_id, value * factor, value * factor_sd)]
+
+
+def _should_run(term_id: str, cycle: dict):
+    crop_residue_burnt_value = get_crop_residue_burnt_value(cycle)
+    has_crop_residue_burnt = len(crop_residue_burnt_value) > 0
+
+    logRequirements(cycle, model=MODEL, term=term_id,
+                    has_crop_residue_burnt=has_crop_residue_burnt)
+
+    should_run = all([has_crop_residue_burnt])
+    logShouldRun(cycle, MODEL, term_id, should_run, methodTier=TIER)
+    return should_run, crop_residue_burnt_value
+
+
+def run_emission(term_id: str, cycle: dict):
+    should_run, crop_residue_burnt_value = _should_run(term_id, cycle)
+    return _run(term_id, crop_residue_burnt_value) if should_run else []

hestia_earth_models-0.73.0/hestia_earth/models/aware/scarcityWeightedWaterUse.py

@@ -0,0 +1,104 @@
+from hestia_earth.schema import SiteSiteType
+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, emission_value, 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": "",
+    "region-aware-factors": ""
+}
+TERM_ID = 'scarcityWeightedWaterUse'
+AWARE_KEY = 'awareWaterBasinId'
+IRRIGATED_SITE_TYPES = [
+    SiteSiteType.CROPLAND.value,
+    SiteSiteType.GLASS_OR_HIGH_ACCESSIBLE_COVER.value,
+    SiteSiteType.PERMANENT_PASTURE.value
+]
+
+
+def _indicator(value: float):
+    indicator = _new_indicator(TERM_ID, MODEL)
+    indicator['value'] = value
+    return indicator
+
+
+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)
+    )
+    debugMissingLookup(f"{AWARE_KEY}.csv", 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, site: dict):
+    region_id = get_region_id(impact_assessment)
+    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)
+    return safe_parse_float(value, default=None)
+
+
+def run(impact_assessment: dict):
+    cycle = impact_assessment.get('cycle', {})
+    product = get_product(impact_assessment)
+    fresh_water = emission_value(impact_assessment, '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)
+    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]),
+        inputs_value
+    ])
+
+    logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
+                    fresh_water=fresh_water,
+                    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-0.73.0/hestia_earth/models/chaudharyBrooks2018/damageToTerrestrialEcosystemsTotalLandUseEffects.py

@@ -0,0 +1,67 @@
+from hestia_earth.utils.tools import list_sum, safe_parse_float, non_empty_list
+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
+from hestia_earth.models.utils.indicator import _new_indicator
+from hestia_earth.models.utils.impact_assessment import convert_value_from_cycle, get_product
+from hestia_earth.models.utils.input import sum_input_impacts
+from .damageToTerrestrialEcosystemsLandOccupation import TERM_ID as TERM_ID_1
+from .damageToTerrestrialEcosystemsLandTransformation import TERM_ID as TERM_ID_2
+from . import MODEL
+
+REQUIREMENTS = {
+    "ImpactAssessment": {
+        "cycle": {
+            "@type": "Cycle",
+            "products": [{
+                "@type": "Product",
+                "primary": "True",
+                "value": "> 0",
+                "economicValueShare": "> 0"
+            }]
+        },
+        "impacts": [
+            {"@type": "Indicator", "value": "", "term.@id": "damageToTerrestrialEcosystemsLandOccupation"},
+            {"@type": "Indicator", "value": "", "term.@id": "damageToTerrestrialEcosystemsLandTransformation"}
+        ]
+    }
+}
+RETURNS = {
+    "Indicator": {
+        "value": ""
+    }
+}
+TERM_ID = 'damageToTerrestrialEcosystemsTotalLandUseEffects'
+BIODIVERSITY_TERM_IDS = [TERM_ID_1, TERM_ID_2]
+
+
+def _indicator(value: float):
+    indicator = _new_indicator(TERM_ID, MODEL)
+    indicator['value'] = value
+    return indicator
+
+
+def impact_value(impact_assessment: dict, term_id: str):
+    impact = find_term_match(impact_assessment.get('impacts', []), term_id)
+    value = impact.get('value')
+    value = safe_parse_float(value, default=None)
+    debugValues(impact, model=MODEL, term=TERM_ID, node=term_id, value=value, coefficient=1)
+    return value
+
+
+def run(impact_assessment: dict):
+    landUseEffects = list_sum(non_empty_list(
+        [impact_value(impact_assessment, term_id) for term_id in BIODIVERSITY_TERM_IDS]
+    ), None)
+    cycle = impact_assessment.get('cycle', {})
+    product = get_product(impact_assessment)
+    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([landUseEffects, inputs_value])
+    logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
+                    landUseEffects=landUseEffects,
+                    inputs_value=inputs_value)
+    logShouldRun(impact_assessment, MODEL, TERM_ID, value is not None)
+    return _indicator(value) if value is not None else None

hestia_earth_models-0.73.0/hestia_earth/models/chaudharyBrooks2018/utils.py

@@ -0,0 +1,36 @@
+from hestia_earth.utils.lookup import download_lookup, get_table_value, column_name, extract_grouped_data
+from hestia_earth.utils.tools import safe_parse_float
+
+from hestia_earth.models.log import debugMissingLookup, logRequirements
+from hestia_earth.models.utils.impact_assessment import get_site, get_country_id
+from hestia_earth.models.utils.lookup import get_region_lookup_value
+from . import MODEL
+
+
+def _lookup_value(term_id: str, lookup_name: str, col_match: str, col_val: str, column: str):
+    value = get_table_value(download_lookup(lookup_name), col_match, col_val, column_name(column))
+    debugMissingLookup(lookup_name, col_match, col_val, column, value, model=MODEL, term=term_id)
+    return value
+
+
+def get_region_factor(term_id: str, impact_assessment: dict, lookup_suffix: str, group_key: str = None):
+    site = get_site(impact_assessment)
+    ecoregion = site.get('ecoregion')
+    country_id = get_country_id(impact_assessment)
+    site_type = site.get('siteType')
+
+    lookup_prefix = 'ecoregion' if ecoregion else 'region' if country_id else None
+    lookup_name = f"{lookup_prefix}-siteType-{lookup_suffix}.csv"
+
+    logRequirements(impact_assessment, model=MODEL, term=term_id,
+                    site_type=site_type,
+                    ecoregion=ecoregion,
+                    country_id=country_id)
+
+    value = get_region_lookup_value(
+        lookup_name, country_id, site_type, model=MODEL, term=term_id
+    ) if lookup_prefix == 'region' else _lookup_value(
+        term_id, lookup_name, 'ecoregion', ecoregion, site_type
+    )
+    value = extract_grouped_data(value, group_key) if group_key else value
+    return safe_parse_float(value, default=None)

hestia_earth_models-0.73.0/hestia_earth/models/cml2001Baseline/resourceUseEnergyDepletionInputsProduction.py

@@ -0,0 +1,41 @@
+from hestia_earth.models.linkedImpactAssessment.utils import run_inputs_production
+from . import MODEL
+
+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": [
+                            "resourceUseEnergyDepletionDuringCycle",
+                            "resourceUseEnergyDepletionInputsProduction"
+                        ],
+                        "value": "> 0"
+                    }]
+                }
+            }]
+        }
+    }
+}
+RETURNS = {
+    "Indicator": [{
+        "value": "",
+        "inputs": "units in MJ"
+    }]
+}
+TERM_ID = 'resourceUseEnergyDepletionInputsProduction'
+
+
+def run(impact_assessment: dict): return run_inputs_production(impact_assessment, TERM_ID, MODEL)

hestia_earth_models-0.73.0/hestia_earth/models/cml2001Baseline/resourceUseMineralsAndMetalsInputsProduction.py

@@ -0,0 +1,41 @@
+from hestia_earth.models.linkedImpactAssessment.utils import run_inputs_production
+from . import MODEL
+
+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": [
+                            "resourceUseMineralsAndMetalsDuringCycle",
+                            "resourceUseMineralsAndMetalsInputsProduction"
+                        ],
+                        "value": "> 0"
+                    }]
+                }
+            }]
+        }
+    }
+}
+RETURNS = {
+    "Indicator": [{
+        "value": "",
+        "inputs": ""
+    }]
+}
+TERM_ID = 'resourceUseMineralsAndMetalsInputsProduction'
+
+
+def run(impact_assessment: dict): return run_inputs_production(impact_assessment, TERM_ID, MODEL)