hestia-earth-models 0.61.3__py3-none-any.whl → 0.61.5__py3-none-any.whl

hestia_earth/models/ecoinventV3AndEmberClimate/__init__.py

@@ -7,6 +7,7 @@ from functools import reduce
 from typing import Tuple
 
 from hestia_earth.utils.tools import list_sum, flatten
+from hestia_earth.utils.model import linked_node
 from hestia_earth.schema import EmissionMethodTier
 
 from hestia_earth.models.log import logShouldRun, logRequirements, log_blank_nodes_id
@@ -14,6 +15,7 @@ from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.blank_node import group_by_keys
 from hestia_earth.models.utils.completeness import _is_term_type_complete
 from hestia_earth.models.utils.term import get_electricity_grid_mix_terms
+from hestia_earth.models.utils.cycle import cycle_end_year
 from .utils import get_emission, get_all_emission_terms
 
 REQUIREMENTS = {
@@ -52,7 +54,7 @@ def _emission(value: float, term_id: str, inputs: list, operation: dict) -> dict
     emission = _new_emission(term_id, MODEL)
     emission['value'] = [value]
     emission['methodTier'] = TIER
-    emission["inputs"] = list(inputs)
+    emission['inputs'] = list(map(linked_node, inputs))
     if operation:
         emission["operation"] = operation
     return emission
@@ -65,23 +67,34 @@ def _grid_inputs(inputs: list, electricity_grid_terms: list):
     ]
 
 
-def _run_input(cycle: dict, inputs: list, emission_term_id: str, input_term: dict):
-    inputs = _grid_inputs(inputs, [input_term])
-    return [
-        _emission(
-            value=get_emission(
-                term_id=emission_term_id,
-                country=cycle.get("site", {}).get("country", {}).get("@id", ""),
-                energy=list_sum(flatten([i.get("value", []) for i in op_inputs])),
-                year=cycle.get("endDate", ""),
-                model=MODEL
-            ),
+def _run_input(cycle: dict, inputs: list, emission_term_id: str, electricity_grid_term: dict):
+    electricity_grid_inputs = [electricity_grid_term]
+    inputs = _grid_inputs(inputs, electricity_grid_inputs)
+
+    def run(grouped_inputs: list):
+        input = grouped_inputs[0]
+        term_id = input.get('term', {}).get('@id')
+        input_value = list_sum(flatten(input.get('value', []) for input in grouped_inputs))
+        country_id = cycle.get("site", {}).get("country", {}).get("@id")
+        year = cycle_end_year(cycle)
+        value = get_emission(
             term_id=emission_term_id,
-            inputs=[input_term],
-            operation=op_inputs[0].get("operation")
+            country=country_id,
+            energy=input_value,
+            year=year,
+            model=MODEL
         )
-        for op_inputs in _group_by_operation(inputs).values()
-    ] if inputs else []
+
+        logRequirements(cycle, model=MODEL, term=term_id,
+                        input_value=input_value,
+                        emission_value=value)
+
+        should_run = all([input_value > 0, value])
+        logShouldRun(cycle, MODEL, term_id, should_run, methodTier=TIER)
+
+        return _emission(value, emission_term_id, electricity_grid_inputs, input.get("operation"))
+
+    return list(map(run, _group_by_operation(inputs).values() if inputs else []))
 
 
 def _group_by_operation(inputs: list) -> dict:
@@ -94,8 +107,8 @@ def _run_emission(cycle: dict, electricity_grid_terms: list, inputs: list, emiss
             cycle=cycle,
             inputs=inputs,
             emission_term_id=emission_term_id,
-            input_term=input_term
-        ) for input_term in electricity_grid_terms
+            electricity_grid_term=electricity_grid_term
+        ) for electricity_grid_term in electricity_grid_terms
     ])
 
 
@@ -104,11 +117,16 @@ def _should_run_emission(cycle: dict, electricity_grid_terms: list, term_id: str
     inputs = _grid_inputs(cycle.get('inputs', []), electricity_grid_terms)
     has_relevant_inputs = bool(inputs)
     has_country = bool(cycle.get("site", {}).get("country", {}))
+    has_end_date = bool(cycle.get("endDate"))
 
     logRequirements(cycle, model=MODEL, term=term_id,
-                    input_ids=log_blank_nodes_id(inputs))
+                    term_type_electricityFuel_complete=term_type_complete,
+                    input_ids=log_blank_nodes_id(inputs),
+                    has_relevant_inputs=has_relevant_inputs,
+                    has_country=has_country,
+                    has_end_date=has_end_date)
 
-    should_run = all([term_type_complete, has_relevant_inputs, has_country])
+    should_run = all([term_type_complete, has_relevant_inputs, has_country, has_end_date])
     logShouldRun(cycle, MODEL, term_id, should_run, methodTier=TIER)
     return should_run, inputs
 
@@ -120,6 +138,6 @@ def _run_emissions(cycle: dict, electricity_grid_terms: list):
     return run_emissions_for_term
 
 
-def run(cycle: dict):
+def run(_, cycle: dict):
     electricity_grid_terms = get_electricity_grid_mix_terms()
     return flatten(list(map(_run_emissions(cycle, electricity_grid_terms), get_all_emission_terms())))

hestia_earth/models/ecoinventV3AndEmberClimate/utils.py

@@ -10,27 +10,18 @@ from hestia_earth.models.data.ecoinventV3 import ecoinventV3_emissions
 EMBER_ECOINVENT_LOOKUP_NAME = "ember-ecoinvent-mapping.csv"
 
 
-def _lookup_data(term_id: str, grouping: str, country_id: str, year: int, lookup_name: str, **log_args):
+def _lookup_data(term_id: str, grouping: str, country_id: str, year: str, lookup_name: str, **log_args):
     lookup = download_lookup(lookup_name)
-    data = get_table_value(lookup, 'termid', country_id, column_name(grouping))
-    debugMissingLookup(lookup_name, 'termid', country_id, grouping, data, term=term_id, **log_args)
-    percentage = extract_grouped_data(data, str(year))
+    column = column_name(grouping)
+    data = get_table_value(lookup, 'termid', country_id, column)
+    percentage = extract_grouped_data(data, year)
+    debugMissingLookup(lookup_name, 'termid', country_id, column, percentage, year=year, term=term_id, **log_args)
     return safe_parse_float(percentage, None)
 
 
 def _convert_name(name: str) -> str: return name.replace(";", ",")
 
 
-def _safe_parse_int(value: str, default=0):
-    """
-    Parse a string into an int.
-    """
-    try:
-        return int(value)
-    except ValueError:
-        return default
-
-
 def _zero_from_non_numeric(value: Any) -> float:
     try:
         return float(value)
@@ -62,7 +53,7 @@ def _get_emission_rate_per_source(ember_ecoinvent_mapping: Dict, emission_term_i
     }
 
 
-def get_emission(term_id: str, country: str, year: str, energy: float, model: str) -> float:
+def get_emission(term_id: str, country: str, year: int, energy: float, model: str) -> float:
     """
     Get the <term_id> emissions in kg for the energy consumed.
         a: ecoInventId of each source        - from "ember-ecoinvent-mapping.csv"
@@ -89,7 +80,7 @@ def get_emission(term_id: str, country: str, year: str, energy: float, model: st
             term_id=source,
             grouping=source,
             country_id=country,
-            year=_safe_parse_int(year),
+            year=str(year),
             lookup_name="region-ember-energySources.csv",
             model=model
         )

hestia_earth/models/mocking/mock_search.py

@@ -1,6 +1,7 @@
 import os
 from inspect import getmembers, isfunction
 import json
+from hestia_earth.utils.tools import flatten
 
 from hestia_earth.models.log import logger
 from hestia_earth.models.utils import term
@@ -14,7 +15,7 @@ def _map_results(results):
     # returning the whole term
     return [results] if isinstance(results, dict) else (
         {'@type': 'Term', '@id': results} if isinstance(results, str) else
-        list(map(_map_results, results)) if isinstance(results, list) else
+        flatten(map(_map_results, results)) if isinstance(results, list) else
         None
     )
 

hestia_earth/models/mocking/search-results.json

@@ -1113,26 +1113,22 @@
       }
     },
     "results": [
-      [
-        {
-          "@type": "Term",
-          "name": "Electricity, grid, renewable mix",
-          "termType": "electricity",
-          "@id": "electricityGridRenewableMix",
-          "units": "kWh",
-          "_score": 27.711746
-        }
-      ],
-      [
-        {
-          "@type": "Term",
-          "name": "Electricity, grid, market mix",
-          "termType": "electricity",
-          "@id": "electricityGridMarketMix",
-          "units": "kWh",
-          "_score": 27.711746
-        }
-      ]
+      {
+        "@type": "Term",
+        "name": "Electricity, grid, renewable mix",
+        "termType": "electricity",
+        "@id": "electricityGridRenewableMix",
+        "units": "kWh",
+        "_score": 27.711746
+      },
+      {
+        "@type": "Term",
+        "name": "Electricity, grid, market mix",
+        "termType": "electricity",
+        "@id": "electricityGridMarketMix",
+        "units": "kWh",
+        "_score": 27.711746
+      }
     ]
   },
   {

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.61.3'
+VERSION = '0.61.5'

{hestia_earth_models-0.61.3.dist-info → hestia_earth_models-0.61.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.61.3
+Version: 0.61.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 ==28.*
-Requires-Dist: hestia-earth.utils >=0.12.6
+Requires-Dist: hestia-earth.utils >=0.13.0
 Requires-Dist: python-dateutil >=2.8.1
 Requires-Dist: CurrencyConverter ==0.16.8
 Requires-Dist: haversine >=2.7.0

{hestia_earth_models-0.61.3.dist-info → hestia_earth_models-0.61.5.dist-info}/RECORD

@@ -3,7 +3,7 @@ hestia_earth/models/__init__.py,sha256=qEFeq3yuf3lQKVseALmL8aPM8fpCS54B_5pry00M3
 hestia_earth/models/cache_sites.py,sha256=KQp9cUKE-aIcYJoMWEtKFYS8gBFfsx5LKQhqoWpUSoM,6065
 hestia_earth/models/log.py,sha256=b63I3qyTtQs17xxbq8RI0Fv2lvZ1oDZ9k0njhxqiFFk,3459
 hestia_earth/models/requirements.py,sha256=znNZJAhwX2iYiKcAQXPftY7z_1MsNa0QxCXkXyHm_U0,17363
-hestia_earth/models/version.py,sha256=udATuWRkjmyXbQMDrQ7L8ZfZbgPNc9NrQyIikiyw35s,19
+hestia_earth/models/version.py,sha256=B-nNMbNCza5Xs1ctuDa5VlUAhx8D4prlU9I-wHx7Hcg,19
 hestia_earth/models/agribalyse2016/__init__.py,sha256=WvK0qCQbnYtg9oZxrACd1wGormZyXibPtpCnIQeDqbw,415
 hestia_earth/models/agribalyse2016/fuelElectricity.py,sha256=mrh8seYSYdTgcMDCETLiknuPeJehg071YoG4UiyW0yU,4404
 hestia_earth/models/agribalyse2016/machineryInfrastructureDepreciatedAmountPerCycle.py,sha256=_Rbngu0DzHKa62JwBl58ZC_ui1zLF2que_nB7ukhOQc,3392
@@ -106,8 +106,8 @@ hestia_earth/models/data/ecoinventV3/__init__.py,sha256=oevyurRuioXy_CsQCtG-S_FX
 hestia_earth/models/deRuijterEtAl2010/__init__.py,sha256=lbH6mB98dmZZlwdZctNYtEmVwAow957l80Dv7JSPDsI,418
 hestia_earth/models/deRuijterEtAl2010/nh3ToAirCropResidueDecomposition.py,sha256=2z10WqMsGUDDO8xJ3lmXvSUHgzz2t6PPRDha5NHoT5s,3291
 hestia_earth/models/ecoinventV3/__init__.py,sha256=nSktsE0c9ohx1FyDEEi-YlnGgMGNd-actCwPs_htzC0,6309
-hestia_earth/models/ecoinventV3AndEmberClimate/__init__.py,sha256=ZReEjdgfg_pBOQqCCk24r7z7MaEng6yr-ZP1QgCfyoY,4385
-hestia_earth/models/ecoinventV3AndEmberClimate/utils.py,sha256=Vh8cGkgvbcq3b8tE8Y_8LI1PYqrt9E53fPwInKoYmaY,4577
+hestia_earth/models/ecoinventV3AndEmberClimate/__init__.py,sha256=H5fxfUy6HLHxRgvG3oPZ8pnLbq3Axm0Ejkp9CQ2UGlM,5306
+hestia_earth/models/ecoinventV3AndEmberClimate/utils.py,sha256=mV55GMUxe_fORBVDWGBxOqmH2JVDKhLoKodJ7UzC38c,4420
 hestia_earth/models/emepEea2019/__init__.py,sha256=l90-pWrqIzt1ap1WNk0gF4iZeF5_TSG62hE83bIi4rQ,412
 hestia_earth/models/emepEea2019/co2ToAirFuelCombustion.py,sha256=DfoGlB5HjA1gafO0OutJjfsA6yPP_PsAd-p16evwCiQ,1609
 hestia_earth/models/emepEea2019/n2OToAirFuelCombustionDirect.py,sha256=R3lRF5-Md4Jd7irvTe8WJZJPc9-wa1pD6UWVk7lnGtQ,1616
@@ -358,8 +358,8 @@ hestia_earth/models/linkedImpactAssessment/landTransformationFromPermanentPastur
 hestia_earth/models/linkedImpactAssessment/landTransformationFromPermanentPasture20YearAverageInputsProduction.py,sha256=pdluhfRQuJK0EHq-L0s0TOf37tvOQYB-M-wZiuSbarw,1050
 hestia_earth/models/linkedImpactAssessment/utils.py,sha256=dGwGc2d-8_WQElTpfyPmz5vQtL-LHQRmiZnCTuPXMDs,1876
 hestia_earth/models/mocking/__init__.py,sha256=kmSeOTSvurMUxw7Ajhf3G-SVPQ1NgmirMTk4TSOEicY,765
-hestia_earth/models/mocking/mock_search.py,sha256=V-ycVBTkJu7PP37Ivy_16hpKBV4aEtJb5S9DfChPNSU,2038
-hestia_earth/models/mocking/search-results.json,sha256=FuWHaK_s8PNp46cP3fBfE7kwkm4Tu_HlMGz8Y62UWLk,41248
+hestia_earth/models/mocking/mock_search.py,sha256=B_ATXOyeP_zVhQRktqJP5BZfLFCzE09o9XqDitkggG8,2086
+hestia_earth/models/mocking/search-results.json,sha256=kD4tqX17b_Nijn8P4aPLe6E8Otipufy2XV-zLqEyhd0,41184
 hestia_earth/models/pooreNemecek2018/__init__.py,sha256=nPboL7ULJzL5nJD5q7q9VOZt_fxbKVm8fmn1Az5YkVY,417
 hestia_earth/models/pooreNemecek2018/aboveGroundCropResidueTotal.py,sha256=Qt-mel4dkhK6N5uUOutNOinCTFjbjtGzITaaI0LvYc4,2396
 hestia_earth/models/pooreNemecek2018/belowGroundCropResidue.py,sha256=JT0RybbvWVlo01FO8K0Yj41HrEaJT3Kj1xfayr2X-xw,2315
@@ -557,7 +557,7 @@ hestia_earth/models/webbEtAl2012AndSintermannEtAl2012/nh3ToAirOrganicFertiliser.
 tests/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/models/test_cache_sites.py,sha256=AsZSGb4ruFqag74wRaQxpoZxbMxexPY8q8sMb2ergzg,1986
 tests/models/test_ecoinventV3.py,sha256=gde7ny9ThMmezkDcTmS3ZKn82MNOaNSrpMcbkTjFJxk,1491
-tests/models/test_ecoinventV3AndEmberClimate.py,sha256=r_Wy7rvzM1G9mqsFgdIsEJ3BPdRE91cx4FobxVmpmtg,3621
+tests/models/test_ecoinventV3AndEmberClimate.py,sha256=_V4d01j6itpwa_22H2GbSlRfOLN5KZLCxCIjkPdwoNg,3660
 tests/models/test_emissionNotRelevant.py,sha256=YXTdRfcdR_JepHuj2P3Y3r0aFMKNOmsXQHY48tmLTQo,1316
 tests/models/agribalyse2016/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/models/agribalyse2016/test_fuelElectricity.py,sha256=u_wNlqngJc8NELPr16kYsYQ-_2PcL8BnrfJucY7dccU,1353
@@ -1069,8 +1069,8 @@ tests/models/utils/test_source.py,sha256=mv3vHZV5cjpoLA2I1109-YUkuzAiuhbRSnv_76_
 tests/models/utils/test_term.py,sha256=M5Sa26v2gzQYbZ4H_fo7DspnaCx__-WtL-MULGapCWk,3509
 tests/models/webbEtAl2012AndSintermannEtAl2012/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tests/models/webbEtAl2012AndSintermannEtAl2012/test_nh3ToAirOrganicFertiliser.py,sha256=qi2FNXS5Af2WDtm7nq_FsprH3BfCF0XxnE0XHmC4aIY,2244
-hestia_earth_models-0.61.3.dist-info/LICENSE,sha256=AC7h7GAgCZGJK_Tzh6LUCrML9gQEfowWwecEw2w54QM,1154
-hestia_earth_models-0.61.3.dist-info/METADATA,sha256=useT0uZJrlTEXw8_mab7qYrr94U0oOCUgqeB-l39Qcw,3134
-hestia_earth_models-0.61.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-hestia_earth_models-0.61.3.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
-hestia_earth_models-0.61.3.dist-info/RECORD,,
+hestia_earth_models-0.61.5.dist-info/LICENSE,sha256=AC7h7GAgCZGJK_Tzh6LUCrML9gQEfowWwecEw2w54QM,1154
+hestia_earth_models-0.61.5.dist-info/METADATA,sha256=ysVUlLWO6-b7GOw12O3oUg5q9uC43Fy3GeMDawIAHEQ,3134
+hestia_earth_models-0.61.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+hestia_earth_models-0.61.5.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
+hestia_earth_models-0.61.5.dist-info/RECORD,,

tests/models/test_ecoinventV3AndEmberClimate.py

@@ -10,8 +10,8 @@ from hestia_earth.models.ecoinventV3AndEmberClimate import MODEL, _should_run_em
 class_path = f"hestia_earth.models.{MODEL}"
 fixtures_folder = f"{fixtures_path}/{MODEL}"
 
-cycle_with_country = {"site": {"country": {"@type": "Term", "termType": "region"}}}
-cycle_without_country = {"site": {"country": {}}}
+cycle_with_country = {"endDate": "2010", "site": {"country": {"@type": "Term", "termType": "region"}}}
+cycle_without_country = {"endDate": "2010", "site": {"country": {}}}
 ELECTRICITY_TERMS = [
     {"@type": "Term", "@id": "electricityGridMarketMix"},
     {"@type": "Term", "@id": "electricityGridRenewableMix"}
@@ -89,5 +89,5 @@ def test_run(mock_ecoinventV3_emissions, *args):
     with open(f"{fixtures_folder}/result.jsonld", encoding="utf-8") as f:
         expected = json.load(f)
 
-    value = run(cycle=cycle)
+    value = run('all', cycle)
     assert value == expected