hestia-earth-models 0.65.3__py3-none-any.whl → 0.65.5__py3-none-any.whl

hestia_earth/models/pooreNemecek2018/freshwaterWithdrawalsDuringCycle.py

@@ -66,7 +66,10 @@ def _run(impact_assessment: dict, product: dict, irrigation: float):
     conveyancing = _get_conveyancing_efficiency(impact_assessment, product)
     # convert from m3 to litre
     value = convert_value_from_cycle(
-        product, irrigation / conveyancing * 1000 if irrigation > 0 else 0, model=MODEL, term_id=TERM_ID
+        impact_assessment,
+        product,
+        irrigation / conveyancing * 1000 if irrigation > 0 else 0,
+        model=MODEL, term_id=TERM_ID
     )
     debugValues(impact_assessment, model=MODEL, term=TERM_ID,
                 value=value)

hestia_earth/models/schererPfister2015/nErosionSoilFlux.py

@@ -1,28 +1,36 @@
 from hestia_earth.schema import EmissionMethodTier
+from hestia_earth.utils.tools import list_sum
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.measurement import most_relevant_measurement_value
-from .utils import get_pcorr, get_p_ef_c1, get_ef_p_c2, get_practice_factor, get_water, calculate_R, calculate_A
+from .utils import get_pcorr, get_p_ef_c1, get_ef_p_c2, get_practice_factor, get_water_input, calculate_R, calculate_A
 from . import MODEL
 
 REQUIREMENTS = {
     "Cycle": {
         "endDate": "",
-        "inputs": [
-            {"@type": "Input", "value": "", "term.termType": "water"}
-        ],
+        "or": {
+            "inputs": [
+                {"@type": "Input", "value": "> 0", "term.termType": "water"}
+            ],
+            "site": {
+                "@type": "Site",
+                "measurements": [
+                    {"@type": "Measurement", "value": "> 0", "term.@id": "precipitationAnnual"}
+                ]
+            }
+        },
         "site": {
             "@type": "Site",
             "country": {"@type": "Term", "termType": "region"},
             "measurements": [
-                {"@type": "Measurement", "value": "", "term.@id": "nutrientLossToAquaticEnvironment"},
-                {"@type": "Measurement", "value": "", "term.@id": "heavyWinterPrecipitation"},
-                {"@type": "Measurement", "value": "", "term.@id": "totalNitrogenPerKgSoil"},
-                {"@type": "Measurement", "value": "", "term.@id": "precipitationAnnual"},
-                {"@type": "Measurement", "value": "", "term.@id": "erodibility"},
-                {"@type": "Measurement", "value": "", "term.@id": "slopeLength"},
-                {"@type": "Measurement", "value": "", "term.@id": "slope"}
+                {"@type": "Measurement", "value": "> 0", "term.@id": "nutrientLossToAquaticEnvironment"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "heavyWinterPrecipitation"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "totalNitrogenPerKgSoil"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "erodibility"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "slopeLength"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "slope"}
             ]
         }
     }
@@ -82,7 +90,7 @@ def _should_run(cycle: dict):
     heavy_winter_precipitation = _get_measurement_content('heavyWinterPrecipitation')
 
     precipitation = _get_measurement_content('precipitationAnnual')
-    water = get_water(cycle, precipitation)
+    inputs_water = get_water_input(cycle)
 
     practice_factor = get_practice_factor(TERM_ID, site)
     pcorr = get_pcorr(slope / 100) if slope is not None else None
@@ -92,7 +100,7 @@ def _should_run(cycle: dict):
     list_of_contents_for_A = [
         practice_factor, erodibility, slope_length,
         pcorr, p_ef_c1, ef_p_c2]
-    list_of_contents_for_R = [heavy_winter_precipitation, water]
+    list_of_contents_for_R = [heavy_winter_precipitation, list_sum([(inputs_water or 0)/10, precipitation or 0])]
     list_of_contents_for_value = [nla_environment, soil_nitrogen_content]
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
@@ -104,7 +112,8 @@ def _should_run(cycle: dict):
                     p_ef_c1=p_ef_c1,
                     ef_p_c2=ef_p_c2,
                     heavy_winter_precipitation=heavy_winter_precipitation,
-                    water=water,
+                    inputs_water=inputs_water,
+                    precipitationAnnual=precipitation,
                     nla_environment=nla_environment,
                     soil_nitrogen_content=soil_nitrogen_content)
 

hestia_earth/models/schererPfister2015/pErosionSoilFlux.py

@@ -1,29 +1,36 @@
 from hestia_earth.schema import EmissionMethodTier
+from hestia_earth.utils.tools import list_sum
 
 from hestia_earth.models.log import debugValues, logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.measurement import most_relevant_measurement_value
-from .utils import get_pcorr, get_p_ef_c1, get_ef_p_c2, get_practice_factor, get_water, calculate_R, calculate_A
+from .utils import get_pcorr, get_p_ef_c1, get_ef_p_c2, get_practice_factor, get_water_input, calculate_R, calculate_A
 from . import MODEL
 
 REQUIREMENTS = {
     "Cycle": {
         "endDate": "",
-        "inputs": [
-            {"@type": "Input", "value": "", "term.termType": "water"}
-        ],
+        "or": {
+            "inputs": [
+                {"@type": "Input", "value": "> 0", "term.termType": "water"}
+            ],
+            "site": {
+                "@type": "Site",
+                "measurements": [
+                    {"@type": "Measurement", "value": "> 0", "term.@id": "precipitationAnnual"}
+                ]
+            }
+        },
         "site": {
             "@type": "Site",
             "country": {"@type": "Term", "termType": "region"},
             "measurements": [
-                {"@type": "Measurement", "value": "", "term.@id": "nutrientLossToAquaticEnvironment"},
-                {"@type": "Measurement", "value": "", "term.@id": "heavyWinterPrecipitation"},
-                {"@type": "Measurement", "value": "", "term.@id": "totalPhosphorusPerKgSoil"},
-                {"@type": "Measurement", "value": "", "term.@id": "totalNitrogenPerKgSoil"},
-                {"@type": "Measurement", "value": "", "term.@id": "precipitationAnnual"},
-                {"@type": "Measurement", "value": "", "term.@id": "erodibility"},
-                {"@type": "Measurement", "value": "", "term.@id": "slopeLength"},
-                {"@type": "Measurement", "value": "", "term.@id": "slope"}
+                {"@type": "Measurement", "value": "> 0", "term.@id": "nutrientLossToAquaticEnvironment"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "heavyWinterPrecipitation"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "totalPhosphorusPerKgSoil"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "erodibility"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "slopeLength"},
+                {"@type": "Measurement", "value": "> 0", "term.@id": "slope"}
             ]
         }
     }
@@ -83,7 +90,7 @@ def _should_run(cycle: dict):
     heavy_winter_precipitation = _get_measurement_content('heavyWinterPrecipitation')
 
     precipitation = _get_measurement_content('precipitationAnnual')
-    water = get_water(cycle, precipitation)
+    inputs_water = get_water_input(cycle)
 
     practice_factor = get_practice_factor(TERM_ID, site)
     pcorr = get_pcorr(slope / 100) if slope is not None else None
@@ -93,7 +100,7 @@ def _should_run(cycle: dict):
     list_of_contents_for_A = [
         practice_factor, erodibility, slope_length,
         pcorr, p_ef_c1, ef_p_c2]
-    list_of_contents_for_R = [heavy_winter_precipitation, water]
+    list_of_contents_for_R = [heavy_winter_precipitation, list_sum([(inputs_water or 0)/10, precipitation or 0])]
     list_of_contents_for_value = [nla_environment, soil_phosphorus_content]
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
@@ -105,7 +112,8 @@ def _should_run(cycle: dict):
                     p_ef_c1=p_ef_c1,
                     ef_p_c2=ef_p_c2,
                     heavy_winter_precipitation=heavy_winter_precipitation,
-                    water=water,
+                    inputs_water=inputs_water,
+                    precipitationAnnual=precipitation,
                     nla_environment=nla_environment,
                     soil_phosphorus_content=soil_phosphorus_content)
 

hestia_earth/models/schererPfister2015/utils.py

@@ -64,11 +64,9 @@ def get_ef_p_c2(term_id: str, cycle: dict):
         get_lookup_value(country, 'EF_P_C2', model=MODEL, term=term_id), None)
 
 
-def get_water(cycle: dict, precipitation: float):
-    inputs = cycle.get('inputs', [])
-    filter_irrigation = filter_list_term_type(inputs, TermTermType.WATER)
-    irrigation = list_sum(get_total_value(filter_irrigation))
-    return list_sum([irrigation/10, precipitation or 0])
+def get_water_input(cycle: dict):
+    inputs_water = filter_list_term_type(cycle.get('inputs', []), TermTermType.WATER)
+    return list_sum(get_total_value(inputs_water), default=None)
 
 
 def calculate_R(heavy_winter_precipitation: bool, water: float):

hestia_earth/models/site/management.py

@@ -20,7 +20,7 @@ from hestia_earth.utils.tools import safe_parse_float, flatten
 from hestia_earth.utils.blank_node import get_node_value
 
 from hestia_earth.models.log import logRequirements, logShouldRun, log_as_table
-from hestia_earth.models.utils import _include, _omit
+from hestia_earth.models.utils import _include, _omit, group_by
 from hestia_earth.models.utils.management import _new_management
 from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.blank_node import condense_nodes
@@ -330,7 +330,7 @@ def run(site: dict):
     nodes = flatten([_run_cycle(site, cycle) for cycle in cycles])
 
     # group nodes with same `id` to display as a single log per node
-    grouped_nodes = reduce(lambda p, c: p | {c['id']: p.get(c['id'], []) + [c]}, nodes, {})
+    grouped_nodes = group_by(nodes, ['id'])
     for id, values in grouped_nodes.items():
         logRequirements(
             site,

hestia_earth/models/utils/__init__.py

@@ -7,6 +7,7 @@ import sys
 import datetime
 from functools import reduce
 import operator
+from pydash.objects import get
 from typing import Any, Callable, Union
 from hestia_earth.schema import SchemaType
 from hestia_earth.utils.api import download_hestia
@@ -26,6 +27,14 @@ def cached_value(node: dict, key: str = None, default=None):
     return cache.get(key, default) if key else cache
 
 
+def group_by(values: list, keys: list):
+    def _group_by(group: dict, value: dict):
+        group_key = ';'.join(non_empty_list([get(value, key) for key in keys]))
+        group[group_key] = group.get(group_key, []) + [value]
+        return group
+    return reduce(_group_by, values, {})
+
+
 def _term_id(term): return term.get('@id') if isinstance(term, dict) else term
 
 

hestia_earth/models/utils/blank_node.py

@@ -663,6 +663,7 @@ DATESTR_FORMAT_TO_EXPECTED_LENGTH = {
 
 DatestrGapfillMode = Enum("DatestrGapfillMode", [
     "START",
+    "MIDDLE",
     "END"
 ])
 """
@@ -738,8 +739,25 @@ def _gapfill_datestr_end(datestr: str, format: DatestrFormat) -> str:
     return datestr + completion_str[len(datestr):]
 
 
+def _gapfill_datestr_middle(datestr: str, format: DatestrFormat) -> str:
+    """
+    Gap-fill an incomplete datestr with the middle value, halfway between the latest and earliest values.
+    """
+    start_date_obj = datetime.strptime(
+        _gapfill_datestr_start(datestr),
+        DatestrFormat.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.value
+    )
+    end_date_obj = datetime.strptime(
+        _gapfill_datestr_end(datestr, format=format),
+        DatestrFormat.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.value
+    )
+    middle_date = start_date_obj + (end_date_obj - start_date_obj) / 2
+    return datetime.strftime(middle_date, DatestrFormat.YEAR_MONTH_DAY_HOUR_MINUTE_SECOND.value)
+
+
 DATESTR_GAPFILL_MODE_TO_GAPFILL_FUNCTION = {
     DatestrGapfillMode.START: _gapfill_datestr_start,
+    DatestrGapfillMode.MIDDLE: _gapfill_datestr_middle,
     DatestrGapfillMode.END: _gapfill_datestr_end
 }
 
@@ -757,6 +775,16 @@ def _gapfill_datestr(datestr: str, mode: DatestrGapfillMode = DatestrGapfillMode
     return DATESTR_GAPFILL_MODE_TO_GAPFILL_FUNCTION[mode](_datestr, format) if should_run else _datestr
 
 
+def _str_dates_match(date_str_one: str, date_str_two: str, mode=DatestrGapfillMode.END) -> bool:
+    """
+    Comparison of non-gap-filled string dates.
+    example: For end dates, '2010' would match '2010-12-31', but not '2010-01-01'
+    """
+    return (
+        _gapfill_datestr(datestr=date_str_one, mode=mode) == _gapfill_datestr(datestr=date_str_two, mode=mode)
+    )
+
+
 def _datetime_within_range(datetime: datetime, range: DatetimeRange) -> bool:
     """
     Determine whether or not a `datetime` falls within a `DatetimeRange`.

hestia_earth/models/utils/ecoClimateZone.py

@@ -118,10 +118,7 @@ def get_ecoClimateZone_lookup_grouped_value(
         code = int(str(eco_climate_zone))
         data = _get_single_table_value(lookup, column_name('ecoClimateZone'), code, column_name(col_name))
         grouped_data = reduce(
-            lambda prev, curr: {
-                **prev,
-                **{curr.split(':')[0]: safe_parse_float(curr.split(':')[1])}
-            },
+            lambda prev, curr: prev | {curr.split(':')[0]: safe_parse_float(curr.split(':')[1])},
             data.split(';'),
             {}
         ) if data is not None and isinstance(data, str) and len(data) > 1 else default

hestia_earth/models/utils/fuel.py

@@ -13,7 +13,10 @@ def impact_lookup_value(model: str, term_id: str, impact_assessment: dict, looku
     fuels = filter_list_term_type(cycle.get('inputs', []), TermTermType.FUEL)
     has_fuels_inputs = len(fuels) > 0
     fuels_total_value = convert_value_from_cycle(
-        product, cycle_lookup_value(model, term_id, cycle, fuels, lookup_col), model=model, term_id=term_id
+        impact_assessment,
+        product,
+        cycle_lookup_value(model, term_id, cycle, fuels, lookup_col),
+        model=model, term_id=term_id
     ) if has_fuels_inputs else None
     logRequirements(impact_assessment, model=model, term=term_id,
                     term_type_electricityFuel_complete=fuel_complete,

hestia_earth/models/utils/impact_assessment.py

@@ -4,7 +4,7 @@ from hestia_earth.utils.lookup import download_lookup
 from hestia_earth.utils.model import find_term_match, filter_list_term_type
 from hestia_earth.utils.tools import list_sum, safe_parse_date
 
-from hestia_earth.models.log import logRequirements, debugValues, log_as_table
+from hestia_earth.models.log import debugValues, log_as_table
 from .lookup import all_factor_value, _term_factor_value, _aware_factor_value, fallback_country
 from .product import find_by_product
 from .site import region_level_1_id
@@ -244,13 +244,15 @@ def emission_value(impact_assessment: dict, term_id: str):
     return find_term_match(impact_assessment.get('emissionsResourceUse', []), term_id).get('value')
 
 
-def convert_value_from_cycle(product: dict, value: float, default=None, model: str = None, term_id: str = None):
+def convert_value_from_cycle(
+    log_node: dict, product: dict, value: float, default=None, model: str = None, term_id: str = None
+):
     pyield = list_sum(product.get('value', [])) if product else 0
     economic_value = product.get('economicValueShare') if product else 0
 
-    logRequirements({}, model=model, term=term_id,
-                    product_yield=pyield,
-                    economicValueShare=economic_value)
+    debugValues(log_node, model=model, term=term_id,
+                product_yield=pyield,
+                economicValueShare=economic_value)
 
     return (value / pyield) * economic_value / 100 if all([
         value is not None, pyield > 0, economic_value

hestia_earth/models/utils/lookup.py

@@ -77,7 +77,10 @@ def _term_factor_value(model: str, term_id: str, lookup_name: str, lookup_term_i
         coefficient = get_table_value(lookup, 'termid', lookup_term_id, column_name(node_term_id))
         coefficient = safe_parse_float(extract_grouped_data(coefficient, group_key) if group_key else coefficient)
         if value is not None and coefficient is not None:
-            debugValues(data, model=model, term=term_id, node=node_term_id, value=value, coefficient=coefficient)
+            debugValues(data, model=model, term=term_id,
+                        node=node_term_id,
+                        value=value,
+                        coefficient=coefficient)
         return {'id': node_term_id, 'value': value, 'coefficient': coefficient}
     return get_value
 
@@ -93,7 +96,10 @@ def _aware_factor_value(model: str, term_id: str, lookup_name: str, aware_id: st
             coefficient = _get_single_table_value(lookup, lookup_col, int(aware_id), column_name(node_term_id))
             coefficient = safe_parse_float(extract_grouped_data(coefficient, group_key)) if group_key else coefficient
             if value is not None and coefficient is not None:
-                debugValues(data, model=model, term=term_id, node=node_term_id, value=value, coefficient=coefficient)
+                debugValues(data, model=model, term=term_id,
+                            node=node_term_id,
+                            value=value,
+                            coefficient=coefficient)
                 return value * coefficient
             return None
         except ValueError:  # factor does not exist

hestia_earth/models/utils/pesticideAI.py

@@ -22,6 +22,7 @@ def impact_lookup_value(model: str, term_id: str, impact_assessment: dict, looku
         get_pesticides_from_inputs(cycle)
     has_pesticides_inputs = len(pesticides) > 0
     pesticides_total_value = convert_value_from_cycle(
+        log_node=impact_assessment,
         product=product,
         value=cycle_lookup_value(model, term_id, cycle, pesticides, lookup_col),
         default=None,

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.65.3'
+VERSION = '0.65.5'

{hestia_earth_models-0.65.3.dist-info → hestia_earth_models-0.65.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.65.3
+Version: 0.65.5
 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
@@ -12,7 +12,7 @@ Classifier: Programming Language :: Python :: 3.6
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: hestia-earth-schema==30.*
-Requires-Dist: hestia-earth-utils>=0.13.12
+Requires-Dist: hestia-earth-utils>=0.13.14
 Requires-Dist: python-dateutil>=2.8.1
 Requires-Dist: CurrencyConverter==0.16.8
 Requires-Dist: haversine>=2.7.0