hestia-earth-models 0.62.1__py3-none-any.whl → 0.62.3__py3-none-any.whl

hestia_earth/models/pooreNemecek2018/longFallowPeriod.py

@@ -45,7 +45,7 @@ def _should_run(cycle: dict):
     product = next((p for p in cycle.get('products', []) if _should_run_product(p)), None)
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
-                    product_id=(product or {}).get('term', {}).get('@id'))
+                    crop_product_id=(product or {}).get('term', {}).get('@id'))
 
     should_run = all([product])
     logShouldRun(cycle, MODEL, TERM_ID, should_run)

hestia_earth/models/preload_requests.py

@@ -10,7 +10,7 @@ from .mocking import RESULTS_PATH, enable_mock as _mock
 
 def enable_preload(filepath: str = RESULTS_PATH, node: dict = None):
     """
-    Prefetch calls to Hestia API in a local file.
+    Prefetch calls to HESTIA API in a local file.
 
     Parameters
     ----------

hestia_earth/models/requirements.py

@@ -353,7 +353,7 @@ def get_single_returns(model: str, key: str):
     Returns
     -------
     list
-        The returned data following Hestia's schema.
+        The returned data following HESTIA's schema.
     """
     returns = _model_returns({'model': model, 'key': key})
     return_type = list(returns.keys())[0] if returns else None
@@ -368,7 +368,7 @@ def list_models(
     termType: str = None, tier: str = None, productTermId: str = None, productTermType: str = None, siteType: str = None
 ) -> list:
     """
-    Return list of models present in Hestia.
+    Return list of models present in HESTIA.
 
     Parameters
     ----------
@@ -410,7 +410,7 @@ def get_models(termId: str):
     Returns
     -------
     list
-        The list of modelscurrently in Hestia that are matching this Term (as `{"model": model, "key": key}`).
+        The list of modelscurrently in HESTIA that are matching this Term (as `{"model": model, "key": key}`).
     """
     return list(filter(lambda m: m.get('key') == termId, ALL_MODELS))
 
@@ -420,7 +420,7 @@ def get_all(
     termType: str = None, tier: str = None, productTermId: str = None, productTermType: str = None, siteType: str = None
 ) -> list:
     """
-    Get the requirements to run all the models in Hestia.
+    Get the requirements to run all the models in HESTIA.
 
     Parameters
     ----------
@@ -441,7 +441,7 @@ def get_all(
     Returns
     -------
     list
-        The data requirements following Hestia's schema as multiple nodes.
+        The data requirements following HESTIA's schema as multiple nodes.
     """
     models = list_models(
         termType=termType, tier=tier, productTermId=productTermId, productTermType=productTermType, siteType=siteType
@@ -469,7 +469,7 @@ def get_single(model: str, key: str) -> list:
     Returns
     -------
     list
-        The data requirements following Hestia's schema as multiple nodes.
+        The data requirements following HESTIA's schema as multiple nodes.
     """
     model = {'model': model, 'key': key}
     linked_models = _recursive_linked_models(model)

hestia_earth/models/site/organicCarbonPerHa.py

@@ -278,7 +278,7 @@ def _rescale_soc_value(
     """
     Rescale an SOC measurement value from a source depth interval to a target depth interval.
 
-    Depths are converted from centimetres (Hestia schema) to metres for use in `cdf` function.
+    Depths are converted from centimetres (HESTIA schema) to metres for use in `cdf` function.
 
     Parameters
     ----------

hestia_earth/models/utils/__init__.py

@@ -61,7 +61,7 @@ def _filter_list_term_unit(values: list, unit: Any):
 
 def is_from_model(node: dict) -> bool:
     """
-    Check if the Blank Node came from one of the Hestia Models.
+    Check if the Blank Node came from one of the HESTIA Models.
 
     Parameters
     ----------

hestia_earth/models/utils/blank_node.py

@@ -41,6 +41,44 @@ from .lookup import (
 from .term import get_lookup_value
 
 
+def lookups_logs(model: str, blank_nodes: list, lookups_per_termType: dict, **log_args):
+    def mapper(blank_node: dict):
+        term = blank_node.get('term', {})
+        term_id = term.get('@id')
+        term_type = term.get('termType')
+        lookups = lookups_per_termType.get(term_type, [])
+        lookups = lookups if isinstance(lookups, list) else [lookups]
+
+        def _reduce_lookups_logs(logs: dict, column: str):
+            lookup_value = get_lookup_value(term, column, model=model, **log_args)
+            return logs | {column: lookup_value}
+
+        return reduce(_reduce_lookups_logs, lookups, {'id': term_id})
+
+    logs = list(map(mapper, blank_nodes))
+
+    return log_as_table(logs)
+
+
+def properties_logs(blank_nodes: list, properties: Union[dict, list]):
+    def mapper(blank_node: dict):
+        term = blank_node.get('term', {})
+        term_id = term.get('@id')
+        term_type = term.get('termType')
+        props = properties.get(term_type, []) if isinstance(properties, dict) else properties
+        props = props if isinstance(props, list) else [props]
+
+        def _reduce_properties_logs(logs: dict, prop: str):
+            value = get_node_property(term, prop).get('value')
+            return logs | {prop: value}
+
+        return reduce(_reduce_properties_logs, properties, {'id': term_id})
+
+    logs = list(map(mapper, blank_nodes))
+
+    return log_as_table(logs)
+
+
 def group_by_keys(group_keys: list = ['term']):
     def run(group: dict, node: dict):
         group_key = '-'.join(non_empty_list(map(lambda v: node.get(v, {}).get('@id'), group_keys)))
@@ -229,12 +267,17 @@ def get_total_value_converted_with_min_ratio(
     total_value_with_property = list_sum([value for term_id, value, prop_value in values if prop_value])
     total_value_ratio = total_value_with_property / total_value if total_value > 0 else 0
 
-    debugValues(node, model=model, term=term, property_id=prop_id,
-                total_value=total_value,
-                total_value_with_property=total_value_with_property,
-                total_value_ratio=total_value_ratio,
-                min_value_ratio=min_ratio,
-                conversion_details=value_logs)
+    logs = {
+        f"{prop_id}-term-id": prop_id,
+        f"{prop_id}-total-value": total_value,
+        f"{prop_id}-total-value-with-property": total_value_with_property,
+        f"{prop_id}-total-value-with-ratio": total_value_ratio,
+        f"{prop_id}-min-value-ratio": min_ratio,
+        f"{prop_id}-values": value_logs
+    }
+
+    debugValues(node, model=model, term=term,
+                **logs)
 
     return list_sum([
         value * prop_value for term_id, value, prop_value in values if all([value, prop_value])
@@ -574,7 +617,7 @@ def cumulative_nodes_lookup_match(
 
 class DatestrFormat(Enum):
     """
-    Enum representing ISO date formats permitted by Hestia.
+    Enum representing ISO date formats permitted by HESTIA.
 
     See: https://en.wikipedia.org/wiki/ISO_8601
     """
@@ -639,7 +682,7 @@ def _check_datestr_format(datestr: str, format: DatestrFormat) -> bool:
 
 def _get_datestr_format(datestr: str, default: Optional[Any] = None) -> Union[DatestrFormat, Any, None]:
     """
-    Check a datestr against each ISO format permitted by the Hestia schema and
+    Check a datestr against each ISO format permitted by the HESTIA schema and
     return the matching format.
     """
     return next(
@@ -1132,7 +1175,7 @@ def group_nodes_by_last_date(nodes: list) -> dict[str, list[dict]]:
     Parameters
     ----------
     nodes : list[dict]
-        A list of Hestia format nodes.
+        A list of HESTIA format nodes.
 
     Return
     ------

hestia_earth/models/utils/cycle.py

@@ -22,7 +22,7 @@ def unique_currencies(cycle: dict) -> list:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -41,7 +41,7 @@ def default_currency(cycle: dict) -> str:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -59,7 +59,7 @@ def get_crop_residue_decomposition_N_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -87,7 +87,7 @@ def get_excreta_N_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -115,7 +115,7 @@ def get_organic_fertiliser_N_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -141,7 +141,7 @@ def get_organic_fertiliser_P_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -165,7 +165,7 @@ def get_inorganic_fertiliser_N_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -189,7 +189,7 @@ def get_inorganic_fertiliser_P_total(cycle: dict) -> float:
     Parameters
     ----------
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -260,7 +260,7 @@ def land_occupation_per_ha(model: str, term_id: str, cycle: dict):
     term_id : str
         The name of the term running this function. For debugging purpose only.
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
 
     Returns
     -------
@@ -302,9 +302,9 @@ def land_occupation_per_kg(model: str, term_id: str, cycle: dict, site: dict, pr
     term_id : str
         The name of the term running this function. For debugging purpose only.
     cycle : dict
-        The `Cycle` as defined in the Hestia Schema.
+        The `Cycle` as defined in the HESTIA Schema.
     site : dict
-        The `Site` as defined in the Hestia Schema.
+        The `Site` as defined in the HESTIA Schema.
     primary_product : dict
         The primary `Product` of the `Cycle`.
 
@@ -447,7 +447,7 @@ def check_cycle_site_ids_identical(cycles: list[dict]) -> bool:
     Parameters
     ----------
     cycles : list[dict]
-        A list of Hestia `Cycle` nodes, see: https://www.hestia.earth/schema/Cycle.
+        A list of HESTIA `Cycle` nodes, see: https://www.hestia.earth/schema/Cycle.
 
     Returns
     -------

hestia_earth/models/utils/measurement.py

@@ -111,7 +111,7 @@ def group_measurement_values_by_year(
     Parameters
     ----------
     measurement : dict
-        A Hestia `Measurement` node, see: https://www.hestia.earth/schema/Measurement.
+        A HESTIA `Measurement` node, see: https://www.hestia.earth/schema/Measurement.
     inner_key: Any | None
         An optional inner dictionary key for the outputted annualised groups (can be used to merge annualised
         dictionaries together), default value: `None`.
@@ -165,9 +165,9 @@ def most_relevant_measurement_value_by_depth_and_date(
     Parameters
     ----------
     measurements list[dict]
-        A list of Hestia `Measurement` nodes, see: https://www.hestia.earth/schema/Measurement.
+        A list of HESTIA `Measurement` nodes, see: https://www.hestia.earth/schema/Measurement.
     term_id : str
-        The `@id` of a Hestia `Term`. Example: `"sandContent"`
+        The `@id` of a HESTIA `Term`. Example: `"sandContent"`
     date : str
         The target date in ISO 8601 string format (`"YYYY-MM-DD"`), see: https://en.wikipedia.org/wiki/ISO_8601.
     depth_upper : int

hestia_earth/models/utils/property.py

@@ -87,17 +87,17 @@ def node_has_property(term_id: str):
     return lambda product: find_term_match(product.get('properties', []), term_id, None) is not None
 
 
-def node_property_lookup_value(model: str, term: dict, prop_id: str, default=None, **log_args):
+def node_property_lookup_value(model: str, node_term: dict, prop_id: str, default=None, **log_args):
     # as the lookup table might not exist, we are making sure we return `0` in thise case
     try:
-        lookup_name = f"{term.get('termType')}-property.csv"
+        lookup_name = f"{node_term.get('termType')}-property.csv"
         lookup = download_lookup(lookup_name)
-        term_id = term.get('@id')
+        term_id = node_term.get('@id')
         lookup_value = get_table_value(lookup, 'termid', term_id, column_name(prop_id))
         value = extract_grouped_data(lookup_value, 'Avg') if (
             isinstance(lookup_value, str) and 'Avg' in lookup_value
         ) else lookup_value
-        debugMissingLookup(lookup_name, 'termid', term_id, prop_id, value, model=model, term=term_id, **log_args)
+        debugMissingLookup(lookup_name, 'termid', term_id, prop_id, value, model=model, **log_args)
         return safe_parse_float(value, default=None)
     except Exception:
         return default
@@ -111,9 +111,9 @@ def get_node_property_value(model: str, node: dict, prop_id: str, default=None,
     return default if value is None else (value / 100 if units == '%' else value)
 
 
-def get_node_property_value_converted(model: str, node: dict, prop_id: str, default=None):
+def get_node_property_value_converted(model: str, node: dict, prop_id: str, default=None, **log_args):
     node_value = list_sum(node.get('value', []))
-    prop_value = get_node_property_value(model, node, prop_id)
+    prop_value = get_node_property_value(model, node, prop_id, **log_args)
     return default if prop_value is None else node_value * prop_value
 
 

hestia_earth/models/utils/term.py

@@ -615,7 +615,7 @@ def get_electricity_grid_mix_terms():
     list
         List of matching `Term` as dict.
     """
-    return search({
+    terms = search({
         "bool": {
             "must": [
                 {"match": {"@type": SchemaType.TERM.value}},
@@ -625,3 +625,4 @@ def get_electricity_grid_mix_terms():
             ],
         }
     }, limit=LIMIT, fields=['@type', '@id', 'name', 'termType', 'units'])
+    return list(map(lambda n: n["@id"], terms))

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.62.1'
+VERSION = '0.62.3'

{hestia_earth_models-0.62.1.dist-info → hestia_earth_models-0.62.3.dist-info}/METADATA

@@ -1,9 +1,9 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.62.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.).
+Version: 0.62.3
+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: HESTIA Team
 Author-email: guillaumeroyer.mail@gmail.com
 License: GPL
 Platform: UNKNOWN
@@ -11,25 +11,25 @@ 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 ==29.*
-Requires-Dist: hestia-earth.utils >=0.13.2
-Requires-Dist: python-dateutil >=2.8.1
-Requires-Dist: CurrencyConverter ==0.16.8
-Requires-Dist: haversine >=2.7.0
+Requires-Dist: hestia-earth.schema==29.*
+Requires-Dist: hestia-earth.utils>=0.13.2
+Requires-Dist: python-dateutil>=2.8.1
+Requires-Dist: CurrencyConverter==0.16.8
+Requires-Dist: haversine>=2.7.0
 Requires-Dist: pydash
 Provides-Extra: spatial
-Requires-Dist: hestia-earth.earth-engine >=0.4.7 ; extra == 'spatial'
+Requires-Dist: hestia-earth.earth-engine>=0.4.7; extra == "spatial"
 
-# Hestia Engine Models
+# 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.
+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).
+Documentation for every model can be found in the [HESTIA API Documentation](https://hestia.earth/docs/#hestia-calculation-models).
 
 ## Install