hestia-earth-models 0.57.2__py3-none-any.whl → 0.59.0__py3-none-any.whl

hestia_earth/models/utils/cycle.py

@@ -1,6 +1,6 @@
 from hestia_earth.schema import CycleFunctionalUnit, SiteSiteType, TermTermType
 from hestia_earth.utils.model import filter_list_term_type, find_term_match, find_primary_product
-from hestia_earth.utils.tools import list_sum, safe_parse_float, safe_parse_date
+from hestia_earth.utils.tools import flatten, list_sum, safe_parse_float, safe_parse_date
 
 from ..log import logRequirements, debugValues
 from .lookup import factor_value
@@ -70,7 +70,8 @@ def get_crop_residue_decomposition_N_total(cycle: dict) -> float:
     products = [
         p for p in products if get_lookup_value(p.get('term'), 'decomposesOnField')
     ]
-    return list_sum(get_N_total(products), None) if _is_term_type_complete(cycle, TermTermType.CROPRESIDUE) else None
+    default_value = 0 if _is_term_type_complete(cycle, TermTermType.CROPRESIDUE) else None
+    return list_sum(get_N_total(products), default_value)
 
 
 def get_excreta_N_total(cycle: dict) -> float:
@@ -95,7 +96,8 @@ def get_excreta_N_total(cycle: dict) -> float:
     inputs = filter_list_term_type(cycle.get('inputs', []), TermTermType.EXCRETA)
     products = filter_list_term_type(cycle.get('products', []), TermTermType.EXCRETA)
     values = get_N_total(inputs) + get_N_total(products)
-    return list_sum(values, None) if _is_term_type_complete(cycle, TermTermType.EXCRETA) else None
+    default_value = 0 if _is_term_type_complete(cycle, TermTermType.EXCRETA) else None
+    return list_sum(values, default_value)
 
 
 def get_organic_fertiliser_N_total(cycle: dict) -> float:
@@ -120,7 +122,8 @@ def get_organic_fertiliser_N_total(cycle: dict) -> float:
         The total value as a number.
     """
     values = get_N_total(filter_list_term_type(cycle.get('inputs', []), TermTermType.ORGANICFERTILISER))
-    return list_sum(values, None) if _is_term_type_complete(cycle, 'fertiliser') else None
+    default_value = 0 if _is_term_type_complete(cycle, 'fertiliser') else None
+    return list_sum(values, default_value)
 
 
 def get_organic_fertiliser_P_total(cycle: dict) -> float:
@@ -145,7 +148,8 @@ def get_organic_fertiliser_P_total(cycle: dict) -> float:
         The total value as a number.
     """
     values = get_P2O5_total(filter_list_term_type(cycle.get('inputs', []), TermTermType.ORGANICFERTILISER))
-    return list_sum(values, None) if _is_term_type_complete(cycle, 'fertiliser') else None
+    default_value = 0 if _is_term_type_complete(cycle, 'fertiliser') else None
+    return list_sum(values, default_value)
 
 
 def get_inorganic_fertiliser_N_total(cycle: dict) -> float:
@@ -168,7 +172,8 @@ def get_inorganic_fertiliser_N_total(cycle: dict) -> float:
         The total value as a number.
     """
     values = get_N_total(filter_list_term_type(cycle.get('inputs', []), TermTermType.INORGANICFERTILISER))
-    return list_sum(values, None) if _is_term_type_complete(cycle, 'fertiliser') else None
+    default_value = 0 if _is_term_type_complete(cycle, 'fertiliser') else None
+    return list_sum(values, default_value)
 
 
 def get_inorganic_fertiliser_P_total(cycle: dict) -> float:
@@ -191,7 +196,8 @@ def get_inorganic_fertiliser_P_total(cycle: dict) -> float:
         The total value as a number.
     """
     values = get_P2O5_total(filter_list_term_type(cycle.get('inputs', []), TermTermType.INORGANICFERTILISER))
-    return list_sum(values, None) if _is_term_type_complete(cycle, 'fertiliser') else None
+    default_value = 0 if _is_term_type_complete(cycle, 'fertiliser') else None
+    return list_sum(values, default_value)
 
 
 def get_max_rooting_depth(cycle: dict) -> float:
@@ -364,7 +370,7 @@ def is_organic(cycle: dict):
 
 def is_irrigated(cycle: dict):
     """
-    Check if the `Cycle` is irrigated, i.e. if it contains an irrigated `Practice`.
+    Check if the `Cycle` is irrigated, i.e. if it contains an irrigated `Practice` with a value above `0`.
 
     Parameters
     ----------
@@ -376,7 +382,10 @@ def is_irrigated(cycle: dict):
     bool
         `True` if the `Cycle` is irrigated, `False` otherwise.
     """
-    return list_sum(find_term_match(cycle.get('practices', []), 'irrigated').get('value', [])) > 0
+    irrigated_practices = [
+        p for p in cycle.get('practices', []) if p.get('term', {}).get('@id', '').startswith('irrigated')
+    ]
+    return list_sum(flatten([p.get('value', []) for p in irrigated_practices])) > 0
 
 
 def cycle_end_year(cycle: dict):

hestia_earth/models/utils/measurement.py

@@ -17,7 +17,7 @@ from .term import get_lookup_value
 # TODO: verify those values
 MAX_DEPTH = 1000
 OLDEST_DATE = '1800'
-
+SOIL_TEXTURE_IDS = ['sandContent', 'siltContent', 'clayContent']
 MEASUREMENT_REDUCE = {
     'mean': lambda value: mean(value),
     'mode': lambda value: mode(value),

hestia_earth/models/utils/property.py

@@ -87,24 +87,24 @@ 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):
+def node_property_lookup_value(model: str, 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 = download_lookup(lookup_name)
         term_id = term.get('@id')
         value = extract_grouped_data(get_table_value(lookup, 'termid', term_id, column_name(prop_id)), 'Avg')
-        debugMissingLookup(lookup_name, 'termid', term_id, prop_id, value, model=model, term=term_id)
+        debugMissingLookup(lookup_name, 'termid', term_id, prop_id, value, model=model, term=term_id, **log_args)
         return safe_parse_float(value, default=None)
     except Exception:
         return default
 
 
-def get_node_property_value(model: str, node: dict, prop_id: str, default=None):
+def get_node_property_value(model: str, node: dict, prop_id: str, default=None, **log_args):
     prop = get_node_property(node, prop_id)
     term = (prop or {}).get('term', download_hestia(prop_id))
     units = (term or {}).get('units')
-    value = prop.get('value') if prop else node_property_lookup_value(model, node.get('term', {}), prop_id)
+    value = prop.get('value') if prop else node_property_lookup_value(model, node.get('term', {}), prop_id, **log_args)
     return default if value is None else (value / 100 if units == '%' else value)
 
 

hestia_earth/models/utils/term.py

@@ -8,13 +8,13 @@ from .constant import Units
 LIMIT = 1000
 
 
-def get_lookup_value(lookup_term: dict, column: str, skip_debug: bool = False, **kwargs):
+def get_lookup_value(lookup_term: dict, column: str, skip_debug: bool = False, **log_args):
     table_name = f"{lookup_term.get('termType')}.csv" if lookup_term else None
     value = get_table_value(
         download_lookup(table_name), 'termid', lookup_term.get('@id'), column_name(column)
     ) if table_name else None
     debugMissingLookup(
-        table_name, 'termid', lookup_term.get('@id'), column, value, **kwargs
+        table_name, 'termid', lookup_term.get('@id'), column, value, **log_args
     ) if lookup_term and not skip_debug else None
     return value
 
@@ -544,7 +544,7 @@ def get_residue_removed_or_burnt_terms():
     return list(map(lambda n: n["@id"], terms))
 
 
-def get_rice_plant_upland_terms():
+def get_upland_rice_land_cover_terms():
     """
     Find all `landCover` terms related to upland rice the Glossary.
 
@@ -566,6 +566,28 @@ def get_rice_plant_upland_terms():
     return list(map(lambda n: n["@id"], terms))
 
 
+def get_upland_rice_crop_terms():
+    """
+    Find all `crop` terms related to upland rice the Glossary.
+
+    Returns
+    -------
+    list
+        List of matching term `@id` as `str`.
+    """
+    terms = search({
+        "bool": {
+            "must": [
+                {"match": {"@type": SchemaType.TERM.value}},
+                {"match": {"termType.keyword": TermTermType.CROP.value}},
+                {"match_phrase": {"name": "rice"}},
+                {"match": {"name": "upland"}}
+            ],
+        }
+    }, limit=LIMIT)
+    return list(map(lambda n: n["@id"], terms))
+
+
 def get_pasture_system_terms():
     """
     Find all `system` terms with the name `pasture`:
@@ -581,3 +603,26 @@ def get_pasture_system_terms():
         'name': 'pasture'
     }, limit=LIMIT)
     return list(map(lambda n: n["@id"], terms))
+
+
+def get_long_fallow_land_cover_terms():
+    """
+    Find all `landCover` terms with the name `long fallow`:
+    https://hestia.earth/glossary?termType=landCover&query=long%fallow
+
+    Returns
+    -------
+    list
+        List of matching term `@id` as `str`.
+    """
+    terms = search({
+        "bool": {
+            "must": [
+                {"match": {"@type": SchemaType.TERM.value}},
+                {"match": {"termType.keyword": TermTermType.LANDCOVER.value}},
+                {"match_phrase_prefix": {"name": "long"}},
+                {"match": {"name": "fallow"}}
+            ],
+        }
+    }, limit=LIMIT)
+    return list(map(lambda n: n["@id"], terms))

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.57.2'
+VERSION = '0.59.0'

{hestia_earth_models-0.57.2.dist-info → hestia_earth_models-0.59.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.57.2
+Version: 0.59.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
@@ -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 ==26.*
+Requires-Dist: hestia-earth.schema ==27.*
 Requires-Dist: hestia-earth.utils >=0.12.2
 Requires-Dist: python-dateutil >=2.8.1
 Requires-Dist: CurrencyConverter ==0.16.8
@@ -55,19 +55,15 @@ run('no3ToGroundwaterSoilFlux', cycle_data)
 
 ### Using Spatial Models
 
-We have models that can gap-fill geographical information on a `Site`.
-If you want to use thse 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 Ecoinvent Model
+### 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.
-To include these data in your environmental impact assessments using Hestia, you must own a suitable [ecoinvent license](https://ecoinvent.org/offerings/licences/).
 
-Please contact us at community@hestia.earth for instructions to download the required file to run the model.
-Once downloaded, copy the file in the _hestia_earth/models/data/ecoinventV3_ folder.
-Thank you!
+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.