hestia-earth-models 0.50.0__py3-none-any.whl → 0.51.1__py3-none-any.whl

hestia_earth/models/pooreNemecek2018/aboveGroundCropResidueTotal.py

@@ -2,7 +2,7 @@ from hestia_earth.schema import ProductStatsDefinition, TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.tools import list_sum, safe_parse_float
 
-from hestia_earth.models.log import logRequirements, logShouldRun
+from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
 from hestia_earth.models.utils.completeness import _is_term_type_incomplete
 from hestia_earth.models.utils.product import _new_product
 from hestia_earth.models.utils.crop import get_crop_lookup_value
@@ -41,20 +41,27 @@ def _run(product: dict):
     return [_product(value)]
 
 
-def _should_run_product(product: dict):
-    value = list_sum(product.get('value', [0]))
-    lookup_value = _get_lookup_value(product)
-    return value > 0 and lookup_value is not None
-
-
 def _should_run(cycle: dict):
     # filter crop products with matching data in the lookup
     products = filter_list_term_type(cycle.get('products', []), TermTermType.CROP)
-    products = list(filter(_should_run_product, products))
+    product_values = [
+        (product, list_sum(product.get('value', [0])), _get_lookup_value(product)) for product in products
+    ]
+    product_logs = log_as_table([
+        {
+            'id': product.get('term', {}).get('@id'),
+            'value': value,
+            'lookup': lookup_value
+        } for product, value, lookup_value in product_values
+    ])
+    products = [
+        product for product, value, lookup_value in product_values if all([value > 0, lookup_value is not None])
+    ]
     single_crop_product = len(products) == 1
     term_type_incomplete = _is_term_type_incomplete(cycle, TERM_ID)
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
+                    product_details=product_logs,
                     single_crop_product=single_crop_product,
                     term_type_cropResidue_incomplete=term_type_incomplete)
 

hestia_earth/models/pooreNemecek2018/plantationProductiveLifespan.py

@@ -1,6 +1,7 @@
 from hestia_earth.schema import PracticeStatsDefinition
 from hestia_earth.utils.tools import safe_parse_float
 
+from hestia_earth.models.log import debugValues, log_as_table
 from hestia_earth.models.utils.practice import _new_practice
 from hestia_earth.models.utils.crop import get_crop_lookup_value
 from .utils import run_products_average
@@ -25,11 +26,22 @@ RETURNS = {
 TERM_ID = 'plantationProductiveLifespan'
 
 
-def _get_value(product: dict):
-    term_id = product.get('term', {}).get('@id', '')
-    non_bearing = safe_parse_float(get_crop_lookup_value(MODEL, TERM_ID, term_id, LOOKUPS['crop']), None)
-    plantationLifespan = get_plantationLifespan(product)
-    return plantationLifespan - non_bearing if plantationLifespan is not None and non_bearing is not None else None
+def _get_value(cycle: dict):
+    def get(product: dict):
+        term_id = product.get('term', {}).get('@id', '')
+        plantationLifespan = get_plantationLifespan(product)
+        nonProductiveLifespan = safe_parse_float(get_crop_lookup_value(MODEL, TERM_ID, term_id, LOOKUPS['crop']), None)
+        product_id = product.get('term').get('@id')
+        product_id_logs = log_as_table({
+            'plantationLifespan': plantationLifespan,
+            'nonProductiveLifespan': nonProductiveLifespan
+        })
+        debugValues(cycle, model=MODEL, term=TERM_ID,
+                    **{product_id: product_id_logs})
+        return plantationLifespan - nonProductiveLifespan if all([
+            plantationLifespan is not None, nonProductiveLifespan is not None
+         ]) else None
+    return get
 
 
 def _practice(value: float):
@@ -40,5 +52,5 @@ def _practice(value: float):
 
 
 def run(cycle: dict):
-    value = run_products_average(cycle, TERM_ID, _get_value)
+    value = run_products_average(cycle, TERM_ID, _get_value(cycle))
     return [_practice(value)] if value is not None else []

hestia_earth/models/pooreNemecek2018/rotationDuration.py

@@ -1,5 +1,6 @@
 from hestia_earth.schema import PracticeStatsDefinition
 
+from hestia_earth.models.log import debugValues, log_as_table
 from hestia_earth.models.utils.practice import _new_practice
 from hestia_earth.models.utils import sum_values
 from .plantationLifespan import _get_value as get_plantationLifespan
@@ -24,10 +25,19 @@ RETURNS = {
 TERM_ID = 'rotationDuration'
 
 
-def _get_value(product: dict):
-    plantationLifespan = get_plantationLifespan(product)
-    longFallowPeriod = get_longFallowPeriod(product)
-    return sum_values([plantationLifespan, longFallowPeriod])
+def _get_value(cycle: dict):
+    def get(product: dict):
+        plantationLifespan = get_plantationLifespan(product)
+        longFallowPeriod = get_longFallowPeriod(product)
+        product_id = product.get('term').get('@id')
+        product_id_logs = log_as_table({
+            'plantationLifespan': plantationLifespan,
+            'longFallowPeriod': longFallowPeriod
+        })
+        debugValues(cycle, model=MODEL, term=TERM_ID,
+                    **{product_id: product_id_logs})
+        return sum_values([plantationLifespan, longFallowPeriod])
+    return get
 
 
 def _practice(value: float):
@@ -38,5 +48,5 @@ def _practice(value: float):
 
 
 def run(cycle: dict):
-    value = run_products_average(cycle, TERM_ID, _get_value)
+    value = run_products_average(cycle, TERM_ID, _get_value(cycle))
     return [_practice(value)] if value is not None else []

hestia_earth/models/pooreNemecek2018/utils.py

@@ -1,6 +1,6 @@
 from hestia_earth.utils.tools import non_empty_list, list_average
 
-from hestia_earth.models.log import logShouldRun, logRequirements
+from hestia_earth.models.log import logShouldRun, logRequirements, log_as_table
 from . import MODEL
 
 
@@ -17,7 +17,9 @@ def run_products_average(cycle: dict, term_id: str, get_value_func):
 
     logRequirements(cycle, model=MODEL, term=term_id,
                     has_values=has_values,
-                    details=';'.join([f"id:{term_id}_value:{value}" for term_id, value in values_by_product]))
+                    details=log_as_table([
+                        {'id': term_id, 'value': value} for term_id, value in values_by_product
+                    ]))
 
     should_run = all([has_values])
     logShouldRun(cycle, MODEL, term_id, should_run)

hestia_earth/models/schmidt2007/__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 = 'schmidt2007'
+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/schmidt2007/ch4ToAirWasteTreatment.py

@@ -0,0 +1,60 @@
+from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition
+from hestia_earth.utils.tools import list_sum
+
+from hestia_earth.models.log import logRequirements, logShouldRun
+from hestia_earth.models.utils.emission import _new_emission
+from .utils import get_waste_values
+from . import MODEL
+
+REQUIREMENTS = {
+    "Cycle": {
+        "or": {
+            "product": [
+                {"@type": "Product", "value": "", "term.termType": "waste"}
+            ],
+            "completeness.waste": ""
+        }
+    }
+}
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "methodTier": "tier 1",
+        "statsDefinition": "modelled"
+    }]
+}
+LOOKUPS = {
+    "waste": "ch4EfSchmidt2007"
+}
+TERM_ID = 'ch4ToAirWasteTreatment'
+TIER = EmissionMethodTier.TIER_1.value
+
+
+def _emission(value: float):
+    emission = _new_emission(TERM_ID, MODEL)
+    emission['value'] = [value]
+    emission['methodTier'] = TIER
+    emission['statsDefinition'] = EmissionStatsDefinition.MODELLED.value
+    return emission
+
+
+def _run(waste_values: list):
+    value = list_sum(waste_values)
+    return [_emission(value)]
+
+
+def _should_run(cycle: dict):
+    waste_values = get_waste_values(TERM_ID, cycle, LOOKUPS['waste'])
+    has_waste = len(waste_values) > 0
+
+    logRequirements(cycle, model=MODEL, term=TERM_ID,
+                    has_waste=has_waste)
+
+    should_run = any([has_waste])
+    logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)
+    return should_run, waste_values
+
+
+def run(cycle: dict):
+    should_run, waste_values = _should_run(cycle)
+    return _run(waste_values) if should_run else []

hestia_earth/models/schmidt2007/utils.py

@@ -0,0 +1,16 @@
+from hestia_earth.schema import NodeType, TermTermType
+from hestia_earth.utils.model import filter_list_term_type
+from hestia_earth.utils.tools import non_empty_list
+
+from hestia_earth.models.utils.completeness import _is_term_type_complete
+from hestia_earth.models.utils.lookup import factor_value
+
+
+def get_waste_values(term_id: str, cycle: dict, lookup_col: str):
+    products = filter_list_term_type(cycle.get('products', []), TermTermType.WASTE)
+    values = non_empty_list(map(factor_value(None, term_id, f"{TermTermType.WASTE.value}.csv", lookup_col), products))
+    return [0] if all([
+        len(values) == 0,
+        _is_term_type_complete(cycle, {'termType': 'waste'}),
+        cycle.get('@type', cycle.get('type')) == NodeType.CYCLE.value  # ignore adding 0 value for Transformation
+    ]) else values

hestia_earth/models/transformation/input/excreta.py

@@ -31,7 +31,8 @@ RETURNS = {
         "inputs": [{
             "@type": "Input",
             "term.termType": "excreta",
-            "value": ""
+            "value": "",
+            "fromCycle": "true"
         }]
     }]
 }
@@ -49,7 +50,8 @@ def _to_input(transformation: dict):
         return {
             **data,
             **_new_input(product.get('term')),
-            'value': [v * ratio for v in product.get('value', [])]
+            'value': [v * ratio for v in product.get('value', [])],
+            'fromCycle': True
         }
     return new_input
 

hestia_earth/models/transformation/product/excreta.py

@@ -10,7 +10,7 @@ from hestia_earth.utils.tools import list_sum, non_empty_list
 from hestia_earth.utils.model import filter_list_term_type
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
-from hestia_earth.models.utils import get_kg_term_units
+from hestia_earth.models.utils import get_kg_term_units, _omit
 from hestia_earth.models.utils.product import _new_product
 from hestia_earth.models.utils.constant import Units, convert_to_N
 from hestia_earth.models.utils.term import get_lookup_value
@@ -73,7 +73,7 @@ def _add_product(transformation: dict, units: str, inputs: list, emissions: list
     should_run = all([has_value])
     logShouldRun(transformation, MODEL_LOG, term_id, should_run)
     return {
-        **input_same_units,
+        **_omit(input_same_units, ['fromCycle']),
         **_new_product(term_id, _product_value(input_same_units, emissions))
     } if should_run else None
 

hestia_earth/models/usetoxV2/{freshwaterEcotoxicityPotentialPaf.py → freshwaterEcotoxicityPotentialCtue.py}

@@ -17,9 +17,9 @@ RETURNS = {
     }
 }
 LOOKUPS = {
-    "pesticideAI": "pafM3DFreshwaterEcotoxicityUsetox"
+    "pesticideAI": "pafM3DFreshwaterEcotoxicityUsetox2-1Hc50Ec50eq"
 }
-TERM_ID = 'freshwaterEcotoxicityPotentialPaf'
+TERM_ID = 'freshwaterEcotoxicityPotentialCtue'
 
 
 def _indicator(value: float):

hestia_earth/models/utils/term.py

@@ -23,6 +23,7 @@ def get_liquid_fuel_terms():
     """
     Find all "liquid" `fuel` terms from the Glossary:
     - https://hestia.earth/glossary?termType=fuel&query=gasoline
+    - https://hestia.earth/glossary?termType=fuel&query=petrol
     - https://hestia.earth/glossary?termType=fuel&query=diesel
 
     Returns
@@ -50,6 +51,11 @@ def get_liquid_fuel_terms():
                         "name": "gasoline*"
                     }
                 },
+                {
+                    "regexp": {
+                        "name": "petrol*"
+                    }
+                },
                 {
                     "regexp": {
                         "name": "diesel*"

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.50.0'
+VERSION = '0.51.1'

{hestia_earth_models-0.50.0.dist-info → hestia_earth_models-0.51.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.50.0
+Version: 0.51.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
@@ -11,7 +11,7 @@ Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Programming Language :: Python :: 3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: hestia-earth.schema ==22.*
+Requires-Dist: hestia-earth.schema ==23.*
 Requires-Dist: hestia-earth.utils >=0.11.1
 Requires-Dist: python-dateutil >=2.8.1
 Requires-Dist: CurrencyConverter ==0.16.8