hestia-earth-models 0.63.0__py3-none-any.whl → 0.64.1__py3-none-any.whl

hestia_earth/models/mocking/search-results.json

@@ -979,11 +979,11 @@
       },
       {
         "@type": "Term",
-        "@id": "shortFallowCrop"
+        "@id": "longFallowCrop"
       },
       {
         "@type": "Term",
-        "@id": "longFallowCrop"
+        "@id": "shortFallowCrop"
       }
     ]
   },
@@ -1062,11 +1062,11 @@
       },
       {
         "@type": "Term",
-        "@id": "residueRemoved"
+        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
       },
       {
         "@type": "Term",
-        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
+        "@id": "residueRemoved"
       },
       {
         "@type": "Term",
@@ -1094,19 +1094,19 @@
       },
       {
         "@type": "Term",
-        "@id": "discardedCropIncorporated"
+        "@id": "discardedCropLeftOnField"
       },
       {
         "@type": "Term",
-        "@id": "aboveGroundCropResidueRemoved"
+        "@id": "discardedCropTotal"
       },
       {
         "@type": "Term",
-        "@id": "discardedCropLeftOnField"
+        "@id": "discardedCropIncorporated"
       },
       {
         "@type": "Term",
-        "@id": "discardedCropTotal"
+        "@id": "aboveGroundCropResidueRemoved"
       },
       {
         "@type": "Term",
@@ -1475,6 +1475,48 @@
       }
     ]
   },
+  {
+    "name": "get_flooded_pre_season_terms",
+    "query": {
+      "bool": {
+        "must": [
+          {
+            "match": {
+              "@type": "Term"
+            }
+          },
+          {
+            "match": {
+              "termType": "landUseManagement"
+            }
+          },
+          {
+            "match_phrase": {
+              "name": "flooded pre-season"
+            }
+          }
+        ]
+      }
+    },
+    "results": [
+      {
+        "@type": "Term",
+        "@id": "floodedPreSeasonMoreThan30Days"
+      },
+      {
+        "@type": "Term",
+        "@id": "nonFloodedPreSeasonLessThan180Days"
+      },
+      {
+        "@type": "Term",
+        "@id": "nonFloodedPreSeasonMoreThan180Days"
+      },
+      {
+        "@type": "Term",
+        "@id": "nonFloodedPreSeasonMoreThan365Days"
+      }
+    ]
+  },
   {
     "name": "get_generic_crop",
     "query": {
@@ -1486,7 +1528,7 @@
         "@type": "Term",
         "name": "Generic crop, seed",
         "@id": "genericCropSeed",
-        "_score": 26.36456
+        "_score": 25.47927
       }
     ]
   },
@@ -1722,61 +1764,61 @@
         "@type": "Term",
         "name": "Glass or high accessible cover",
         "@id": "glassOrHighAccessibleCover",
-        "_score": 59.78251
+        "_score": 58.564175
       },
       {
         "@type": "Term",
         "name": "River or stream",
         "@id": "riverOrStream",
-        "_score": 51.118263
+        "_score": 50.11611
       },
       {
         "@type": "Term",
         "name": "Other natural vegetation",
         "@id": "otherNaturalVegetation",
-        "_score": 41.25843
+        "_score": 40.03552
       },
       {
         "@type": "Term",
         "name": "Natural forest",
         "@id": "naturalForest",
-        "_score": 31.747753
+        "_score": 30.704037
       },
       {
         "@type": "Term",
         "name": "Permanent pasture",
         "@id": "permanentPasture",
-        "_score": 28.454437
+        "_score": 27.611277
       },
       {
         "@type": "Term",
         "name": "Animal housing",
         "@id": "animalHousing",
-        "_score": 27.424242
+        "_score": 26.687897
       },
       {
         "@type": "Term",
         "name": "Root or tuber crop plant",
         "@id": "rootOrTuberCropPlant",
-        "_score": 25.260658
+        "_score": 24.424568
       },
       {
         "@type": "Term",
         "name": "High intensity grazing pasture",
         "@id": "highIntensityGrazingPasture",
-        "_score": 24.038225
+        "_score": 23.257332
       },
       {
         "@type": "Term",
         "name": "Permanent cropland",
         "@id": "permanentCropland",
-        "_score": 20.689457
+        "_score": 19.83205
       },
       {
         "@type": "Term",
         "name": "Forest",
         "@id": "forest",
-        "_score": 20.366226
+        "_score": 19.576632
       }
     ]
   },

hestia_earth/models/pooreNemecek2018/excretaKgN.py

@@ -28,6 +28,14 @@ REQUIREMENTS = {
     "Cycle": {
         "completeness.animalFeed": "",
         "completeness.product": "",
+        "products": [{
+            "@type": "Product",
+            "value": "",
+            "term.termType": ["liveAnimal", "animalProduct", "liveAquaticSpecies"],
+            "optional": {
+                "properties": [{"@type": "Property", "value": "", "term.@id": "nitrogenContent"}]
+            }
+        }],
         "or": [
             {
                 "animals": [{
@@ -55,15 +63,7 @@ REQUIREMENTS = {
                     ]
                 }]
             }
-        ],
-        "products": [{
-            "@type": "Product",
-            "value": "",
-            "term.termType": ["liveAnimal", "animalProduct", "liveAquaticSpecies"],
-            "optional": {
-                "properties": [{"@type": "Property", "value": "", "term.@id": "nitrogenContent"}]
-            }
-        }]
+        ]
     }
 }
 RETURNS = {

hestia_earth/models/pooreNemecek2018/excretaKgVs.py

@@ -26,6 +26,12 @@ from . import MODEL
 
 REQUIREMENTS = {
     "Cycle": {
+        "products": [{
+            "@type": "Product",
+            "primary": "True",
+            "value": "",
+            "term.termType": ["animalProduct", "liveAnimal", "liveAquaticSpecies"]
+        }],
         "or": [
             {
                 "completeness.animalFeed": "",
@@ -72,14 +78,6 @@ REQUIREMENTS = {
                     "@type": "Site",
                     "measurements": [{"@type": "Measurement", "value": "", "term.@id": "netPrimaryProduction"}]
                 }
-            },
-            {
-                "products": [{
-                    "@type": "Product",
-                    "primary": "True",
-                    "value": "",
-                    "term.termType": ["animalProduct", "liveAnimal", "liveAquaticSpecies"]
-                }]
             }
         ]
     }

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

@@ -0,0 +1,40 @@
+from hestia_earth.models.log import logRequirements, logShouldRun
+from hestia_earth.models.utils.impact_assessment import impact_country_value
+from hestia_earth.models.utils.indicator import _new_indicator
+from . import MODEL
+
+REQUIREMENTS = {
+    "ImpactAssessment": {
+        "or": {
+            "country": {"@type": "Term", "termType": "region"},
+            "site": {
+                "@type": "Site",
+                "region": {"@type": "Term", "termType": "region"}
+            }
+        },
+        "emissionsResourceUse": [{"@type": "Indicator", "value": "", "term.termType": "emission"}]
+    }
+}
+RETURNS = {
+    "Indicator": {
+        "value": ""
+    }
+}
+LOOKUPS = {
+    "region-emission-terrestrialAcidificationPotentialAccumulatedExceedance": ""
+}
+TERM_ID = 'terrestrialAcidificationPotentialAccumulatedExceedance'
+
+
+def _indicator(value: float):
+    indicator = _new_indicator(TERM_ID, MODEL)
+    indicator['value'] = value
+    return indicator
+
+
+def run(impact_assessment: dict):
+    value = impact_country_value(MODEL, TERM_ID, impact_assessment, f"{list(LOOKUPS.keys())[0]}.csv")
+    logRequirements(impact_assessment, model=MODEL, term=TERM_ID,
+                    value=value)
+    logShouldRun(impact_assessment, MODEL, TERM_ID, True)
+    return _indicator(value)

hestia_earth/models/site/management.py

@@ -85,7 +85,8 @@ LOOKUPS = {
     "forage": ["landCoverTermId"],
     "inorganicFertiliser": "nitrogenContent",
     "organicFertiliser": "ANIMAL_MANURE",
-    "soilAmendment": "PRACTICE_INCREASING_C_INPUT"
+    "soilAmendment": "PRACTICE_INCREASING_C_INPUT",
+    "landUseManagement": "GAP_FILL_TO_MANAGEMENT"
 }
 MODEL_KEY = 'management'
 LAND_COVER_KEY = LOOKUPS['crop'][0]
@@ -216,6 +217,18 @@ def _get_relevant_inputs(cycles: list[dict]) -> list:
     return relevant_inputs
 
 
+def _has_gap_fill_to_management_set(practices: list) -> list:
+    """
+    Include only landUseManagement practices where GAP_FILL_TO_MANAGEMENT = True
+    """
+    result = [
+        p for p in practices
+        if p.get("term", {}).get("termType", {}) != TermTermType.LANDUSEMANAGEMENT.value
+        or get_lookup_value(lookup_term=p.get("term", {}), column=LOOKUPS["landUseManagement"])
+    ]
+    return result
+
+
 def _should_run_all_products(cycles: list, site_type: str):
     products_land_cover = [
         _extract_node_value(
@@ -292,6 +305,7 @@ def _should_run(site: dict):
             ]
         )
     ]
+    practices = _has_gap_fill_to_management_set(practices)
     practices = condense_nodes(practices)
 
     relevant_inputs = _get_relevant_inputs(cycles)

hestia_earth/models/site/pre_checks/cache_geospatialDatabase.py

@@ -3,15 +3,16 @@ Pre Checks Cache Geospatial Database
 
 This model caches results from Geospatial Database.
 """
+from typing import Union, List
 from functools import reduce
-from hestia_earth.utils.tools import flatten, non_empty_list
+from hestia_earth.utils.tools import flatten
 
 from hestia_earth.models.log import debugValues
 from hestia_earth.models.utils import CACHE_KEY, cached_value, first_day_of_month, last_day_of_month
 from hestia_earth.models.utils.site import CACHE_YEARS_KEY
 from hestia_earth.models.geospatialDatabase.utils import (
     MAX_AREA_SIZE, CACHE_VALUE, CACHE_AREA_SIZE,
-    has_geospatial_data, has_coordinates, get_area_size, geospatial_data, _run_query, _collection_name
+    has_geospatial_data, has_coordinates, get_area_size, geospatial_data, _run_query, _collection_name, _cache_sub_key
 )
 from hestia_earth.models.geospatialDatabase import list_ee_params
 
@@ -34,11 +35,7 @@ def cache_site_results(results: list, collections: list, area_size: int = None):
         collection = collections[index]
         name = collection.get('name')
         value = results[index]
-        cache_sub_key = '-'.join(non_empty_list([
-            collection.get('year'),
-            collection.get('start_date'),
-            collection.get('end_date')
-        ]))
+        cache_sub_key = _cache_sub_key(collection)
         data = (group.get(name, {}) | {cache_sub_key: value} if cache_sub_key else value)
         return group | {name: data}
 
@@ -62,20 +59,24 @@ def _extend_collection_by_month(year: int):
     } for month in range(1, 13)]
 
 
-def _extend_collection(name: str, collection: dict, years: list = []):
-    data = collection | {'name': name, 'collection': _collection_name(collection.get('collection'))}
+def _extend_collection_data(name: str, collection: dict):
+    return collection | {'name': name, 'collection': _collection_name(collection.get('collection'))}
 
+
+def _extend_collection(name: str, collection: Union[List[dict], dict], years: list = []):
     year_params = [{'year': str(year)} for year in years]
     # fetch from first year to last
     month_years = range(years[0], years[-1] + 1) if len(years) > 1 else years
     month_params = flatten(map(_extend_collection_by_month, month_years))
 
     return [
-        (data | params) for params in year_params
+        (_extend_collection_data(name, collection) | params) for params in year_params
     ] if name.endswith('Annual') else [
-        (data | params) for params in month_params
+        (_extend_collection_data(name, collection) | params) for params in month_params
     ] if name.endswith('Monthly') else [
-        data
+        _extend_collection_data(name, col) for col in collection
+    ] if isinstance(collection, list) else [
+        _extend_collection_data(name, collection)
     ]
 
 
@@ -85,18 +86,24 @@ def _extend_collections(values: list, years: list = []):
     ])
 
 
+def _is_type(value: dict, ee_type: str):
+    params = value.get('params')
+    return any([
+        p.get('ee_type') == ee_type for p in params
+    ]) if isinstance(params, list) else params.get('ee_type') == ee_type
+
+
 def list_collections(years: list = [], include_region: bool = False, years_only: bool = False):
     ee_params = list_ee_params()
     # only cache `raster` results as can be combined in a single query
-    rasters = [value for value in ee_params if value.get('params').get('ee_type') == 'raster']
+    rasters = [value for value in ee_params if _is_type(value, 'raster')]
     rasters = _extend_collections(rasters, years or [])
     rasters = [raster for raster in rasters if not years_only or _is_collection_by_year(raster)]
 
     vectors = [
-        value for value in ee_params if all([
-            value.get('params').get('ee_type') == 'vector',
+        value for value in ee_params if _is_type(value, 'vector') and (
             include_region or not value.get('params').get('collection', '').startswith('gadm36')
-        ])
+        )
     ]
     # no vectors are running with specific years
     vectors = [] if years_only else _extend_collections(vectors)

hestia_earth/models/site/waterDepth.py

@@ -14,9 +14,6 @@ RETURNS = {
         "methodClassification": "modelled using other measurements"
     }]
 }
-LOOKUPS = {
-    "crop": "Non_bearing_duration"
-}
 TERM_ID = 'waterDepth'
 BIBLIO_TITLE = 'Reducing food’s environmental impacts through producers and consumers'
 SITE_TYPE_TO_DEPTH = {

hestia_earth/models/utils/indicator.py

@@ -5,7 +5,9 @@ from hestia_earth.utils.model import linked_node
 from . import _term_id, _include_methodModel
 
 
-def _new_indicator(term, model=None):
+def _new_indicator(term, model=None, land_cover_id=None):
     node = {'@type': SchemaType.INDICATOR.value}
     node['term'] = linked_node(term if isinstance(term, dict) else download_hestia(_term_id(term)))
+    if land_cover_id:
+        node['landCover'] = linked_node(download_hestia(land_cover_id))
     return _include_methodModel(node, model)

hestia_earth/models/utils/term.py

@@ -252,6 +252,40 @@ def get_rice_paddy_terms():
     return [n['@id'] for n in terms if 'depth' not in n['@id'].lower()]
 
 
+def get_flooded_pre_season_terms():
+    """
+    Find all `landUseManagement` terms of "flooded pre season" from the Glossary:
+    https://hestia.earth/glossary?termType=landUseManagement&query=flooded%20pre-season
+
+    Returns
+    -------
+    list
+        List of matching term `@id` as `str`.
+    """
+    terms = search({
+        "bool": {
+            "must": [
+                {
+                    "match": {
+                        "@type": SchemaType.TERM.value
+                    }
+                },
+                {
+                    "match": {
+                        "termType": TermTermType.LANDUSEMANAGEMENT.value
+                    }
+                },
+                {
+                    "match_phrase": {
+                        "name": "flooded pre-season"
+                    }
+                }
+            ]
+        }
+    }, limit=LIMIT)
+    return list(map(lambda n: n['@id'], terms))
+
+
 def get_crop_residue_terms():
     """
     Find all `cropResidue` terms from the Glossary:

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.63.0'
+VERSION = '0.64.1'

{hestia_earth_models-0.63.0.dist-info → hestia_earth_models-0.64.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.63.0
+Version: 0.64.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,8 +11,8 @@ 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.3
+Requires-Dist: hestia-earth.schema==30.*
+Requires-Dist: hestia-earth.utils>=0.13.4
 Requires-Dist: python-dateutil>=2.8.1
 Requires-Dist: CurrencyConverter==0.16.8
 Requires-Dist: haversine>=2.7.0