hestia-earth-models 0.58.0__py3-none-any.whl → 0.59.1__py3-none-any.whl

hestia_earth/models/ipcc2019/utils.py

@@ -1,4 +1,5 @@
-from hestia_earth.utils.model import find_term_match
+from hestia_earth.schema import TermTermType
+from hestia_earth.utils.model import find_term_match, filter_list_term_type
 from hestia_earth.utils.tools import safe_parse_float
 
 from hestia_earth.models.log import debugValues
@@ -7,6 +8,7 @@ from hestia_earth.models.utils.cycle import get_ecoClimateZone
 from hestia_earth.models.utils.constant import Units, get_atomic_conversion
 from hestia_earth.models.utils.blank_node import find_terms_value
 from hestia_earth.models.utils.term import get_lookup_value, get_milkYield_terms
+from hestia_earth.models.utils.ecoClimateZone import get_ecoClimateZone_lookup_value
 from . import MODEL
 
 # From IPCC2019 Indirect N2O emission factor, in N [avg, min, max, std]
@@ -89,3 +91,82 @@ def check_consecutive(ints: list[int]) -> bool:
     """
     range_list = list(range(min(ints), max(ints)+1)) if ints else []
     return all(a == b for a, b in zip(ints, range_list))
+
+
+N2O_FACTORS = {
+    # All N inputs in dry climate
+    'dry': {
+        'value': 0.005,
+        'min': 0,
+        'max': 0.011
+    },
+    'wet': {
+        # Synthetic fertiliser inputs in wet climate
+        TermTermType.INORGANICFERTILISER: {
+            'value': 0.016,
+            'min': 0.013,
+            'max': 0.019
+        },
+        # Other N inputs in wet climate
+        TermTermType.ORGANICFERTILISER: {
+            'value': 0.006,
+            'min': 0.001,
+            'max': 0.011
+        },
+        TermTermType.CROPRESIDUE: {
+            'value': 0.006,
+            'min': 0.001,
+            'max': 0.011
+        }
+    },
+    'default': {
+        'value': 0.01,
+        'min': 0.001,
+        'max': 0.018
+    },
+    'flooded_rice': {
+        'value': 0.004,
+        'min': 0,
+        'max': 0.029
+    }
+}
+
+
+def _get_waterRegime_lookup(model_term_id: str, practice: dict, col: str):
+    return safe_parse_float(get_lookup_value(practice.get('term', {}), col, model=MODEL, term=model_term_id), None)
+
+
+def _is_wet(ecoClimateZone: str = None):
+    return get_ecoClimateZone_lookup_value(ecoClimateZone, 'wet') == 1 if ecoClimateZone else None
+
+
+def _ecoClimate_factors(input_term_type: TermTermType, ecoClimateZone: str = None):
+    is_wet = _is_wet(ecoClimateZone)
+    factors_key = 'default' if is_wet is None else 'wet' if is_wet else 'dry'
+    factors = N2O_FACTORS[factors_key]
+    return (factors.get(input_term_type) if factors_key == 'wet' else factors, is_wet is None)
+
+
+def _flooded_rice_factors(model_term_id: str, cycle: dict):
+    lookup_name = 'IPCC_2019_N2O_rice'
+    practices = filter_list_term_type(cycle.get('practices', []), TermTermType.WATERREGIME)
+    practice = next((p for p in practices if _get_waterRegime_lookup(model_term_id, p, lookup_name) is not None), None)
+
+    factors = {
+        'value': _get_waterRegime_lookup(model_term_id, practice, lookup_name),
+        'min': _get_waterRegime_lookup(model_term_id, practice, lookup_name + '-min'),
+        'max': _get_waterRegime_lookup(model_term_id, practice, lookup_name + '-max')
+    } if practice else N2O_FACTORS['flooded_rice']
+
+    return (factors, practice is None)
+
+
+def get_N2O_factors(
+    model_term_id: str,
+    cycle: dict,
+    input_term_type: TermTermType,
+    ecoClimateZone: str = None,
+    flooded_rice: bool = False
+):
+    return _flooded_rice_factors(model_term_id, cycle) if flooded_rice \
+        else _ecoClimate_factors(input_term_type, ecoClimateZone)

hestia_earth/models/mocking/search-results.json

@@ -839,11 +839,11 @@
       },
       {
         "@type": "Term",
-        "@id": "longFallowCrop"
+        "@id": "shortFallowCrop"
       },
       {
         "@type": "Term",
-        "@id": "shortFallowCrop"
+        "@id": "longFallowCrop"
       }
     ]
   },
@@ -912,10 +912,6 @@
       "termType.keyword": "cropResidueManagement"
     },
     "results": [
-      {
-        "@type": "Term",
-        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
-      },
       {
         "@type": "Term",
         "@id": "residueRemoved"
@@ -928,6 +924,10 @@
         "@type": "Term",
         "@id": "residueIncorporatedMoreThan30DaysBeforeCultivation"
       },
+      {
+        "@type": "Term",
+        "@id": "residueIncorporatedLessThan30DaysBeforeCultivation"
+      },
       {
         "@type": "Term",
         "@id": "pastureRenewed"
@@ -970,27 +970,27 @@
       },
       {
         "@type": "Term",
-        "@id": "aboveGroundCropResidueBurnt"
+        "@id": "discardedCropRemoved"
       },
       {
         "@type": "Term",
-        "@id": "belowGroundCropResidue"
+        "@id": "aboveGroundCropResidueTotal"
       },
       {
         "@type": "Term",
-        "@id": "aboveGroundCropResidueLeftOnField"
+        "@id": "aboveGroundCropResidueIncorporated"
       },
       {
         "@type": "Term",
-        "@id": "discardedCropRemoved"
+        "@id": "aboveGroundCropResidueBurnt"
       },
       {
         "@type": "Term",
-        "@id": "aboveGroundCropResidueTotal"
+        "@id": "belowGroundCropResidue"
       },
       {
         "@type": "Term",
-        "@id": "aboveGroundCropResidueIncorporated"
+        "@id": "aboveGroundCropResidueLeftOnField"
       }
     ]
   },
@@ -1028,11 +1028,11 @@
       },
       {
         "@type": "Term",
-        "@id": "digestibleEnergyPigs"
+        "@id": "digestibleEnergySalmonids"
       },
       {
         "@type": "Term",
-        "@id": "digestibleEnergySalmonids"
+        "@id": "digestibleEnergyPigs"
       },
       {
         "@type": "Term",
@@ -1109,14 +1109,6 @@
       "units.keyword": "kg N"
     },
     "results": [
-      {
-        "@type": "Term",
-        "@id": "excretaBuffaloKgN"
-      },
-      {
-        "@type": "Term",
-        "@id": "excretaSolidAndLiquidFishCrustaceansKgN"
-      },
       {
         "@type": "Term",
         "@id": "excretaPoultryKgN"
@@ -1173,6 +1165,14 @@
         "@type": "Term",
         "@id": "processedExcretaKgN"
       },
+      {
+        "@type": "Term",
+        "@id": "excretaBuffaloKgN"
+      },
+      {
+        "@type": "Term",
+        "@id": "excretaSolidAndLiquidFishCrustaceansKgN"
+      },
       {
         "@type": "Term",
         "@id": "excretaDairyCattleKgN"
@@ -1212,47 +1212,47 @@
       },
       {
         "@type": "Term",
-        "@id": "excretaLiquidFishCrustaceansKgVs"
+        "@id": "excretaPigsKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaSolidAndLiquidFishCrustaceansKgVs"
+        "@id": "excretaCamelsKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaDairyCattleKgVs"
+        "@id": "excretaDucksKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaGeeseKgVs"
+        "@id": "processedExcretaKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaPigsKgVs"
+        "@id": "excretaHorsesMulesAndAssesKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaCamelsKgVs"
+        "@id": "excretaBuffaloKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaDucksKgVs"
+        "@id": "excretaTurkeysKgVs"
       },
       {
         "@type": "Term",
-        "@id": "processedExcretaKgVs"
+        "@id": "excretaLiquidFishCrustaceansKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaHorsesMulesAndAssesKgVs"
+        "@id": "excretaSolidAndLiquidFishCrustaceansKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaBuffaloKgVs"
+        "@id": "excretaDairyCattleKgVs"
       },
       {
         "@type": "Term",
-        "@id": "excretaTurkeysKgVs"
+        "@id": "excretaGeeseKgVs"
       },
       {
         "@type": "Term",
@@ -1299,7 +1299,7 @@
         "@type": "Term",
         "name": "Generic crop, seed",
         "@id": "genericCropSeed",
-        "_score": 24.768406
+        "_score": 23.9092
       }
     ]
   },
@@ -1337,67 +1337,63 @@
     "results": [
       {
         "@type": "Term",
-        "@id": "deepWater"
+        "@id": "rainfedDeepWater"
       },
       {
         "@type": "Term",
-        "@id": "deepWaterWaterDepth50100Cm"
+        "@id": "rainfedDeepWaterWaterDepth50100Cm"
       },
       {
         "@type": "Term",
-        "@id": "deepWaterWaterDepth100Cm"
+        "@id": "rainfedDeepWaterWaterDepth100Cm"
       },
       {
         "@type": "Term",
-        "@id": "irrigated"
+        "@id": "irrigatedTypeUnspecified"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedManualIrrigation"
-      },
-      {
-        "@type": "Term",
-        "@id": "irrigatedSprinklerIrrigation"
+        "@id": "irrigatedLocalizedIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedDripIrrigation"
+        "@id": "irrigatedFurrowIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedLocalizedIrrigation"
+        "@id": "irrigatedSubIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedFurrowIrrigation"
+        "@id": "irrigatedSurfaceIrrigationDrainageRegimeUnspecified"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedSubIrrigation"
+        "@id": "irrigatedDripIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedSurfaceIrrigation"
+        "@id": "irrigatedSprinklerIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedContinuouslyFlooded"
+        "@id": "irrigatedLateralMoveIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedLateralMoveIrrigation"
+        "@id": "irrigatedCenterPivotIrrigation"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedSingleDrainagePeriod"
+        "@id": "irrigatedSurfaceIrrigationContinuouslyFlooded"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedCenterPivotIrrigation"
+        "@id": "irrigatedSurfaceIrrigationMultipleDrainagePeriods"
       },
       {
         "@type": "Term",
-        "@id": "irrigatedMultipleDrainagePeriods"
+        "@id": "irrigatedSurfaceIrrigationSingleDrainagePeriod"
       }
     ]
   },
@@ -1536,6 +1532,45 @@
       }
     ]
   },
+  {
+    "name": "get_long_fallow_land_cover_terms",
+    "query": {
+      "bool": {
+        "must": [
+          {
+            "match": {
+              "@type": "Term"
+            }
+          },
+          {
+            "match": {
+              "termType.keyword": "landCover"
+            }
+          },
+          {
+            "match_phrase_prefix": {
+              "name": "long"
+            }
+          },
+          {
+            "match": {
+              "name": "fallow"
+            }
+          }
+        ]
+      }
+    },
+    "results": [
+      {
+        "@type": "Term",
+        "@id": "longFallow"
+      },
+      {
+        "@type": "Term",
+        "@id": "longBareFallow"
+      }
+    ]
+  },
   {
     "name": "get_milkYield_terms",
     "query": {
@@ -1689,7 +1724,48 @@
     ]
   },
   {
-    "name": "get_rice_plant_upland_terms",
+    "name": "get_tillage_terms",
+    "query": {
+      "termType.keyword": "tillage",
+      "name": "tillage"
+    },
+    "results": [
+      {
+        "@type": "Term",
+        "@id": "ridgeTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "noTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "fullInversionTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "fullTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "minimumTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "deepTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "mulchTillage"
+      },
+      {
+        "@type": "Term",
+        "@id": "stripTillage"
+      }
+    ]
+  },
+  {
+    "name": "get_upland_rice_crop_terms",
     "query": {
       "bool": {
         "must": [
@@ -1700,12 +1776,12 @@
           },
           {
             "match": {
-              "termType.keyword": "landCover"
+              "termType.keyword": "crop"
             }
           },
           {
             "match_phrase": {
-              "name": "rice plant"
+              "name": "rice"
             }
           },
           {
@@ -1719,48 +1795,42 @@
     "results": [
       {
         "@type": "Term",
-        "@id": "ricePlantUpland"
+        "@id": "riceGrainInHuskUpland"
       }
     ]
   },
   {
-    "name": "get_tillage_terms",
+    "name": "get_upland_rice_land_cover_terms",
     "query": {
-      "termType.keyword": "tillage",
-      "name": "tillage"
+      "bool": {
+        "must": [
+          {
+            "match": {
+              "@type": "Term"
+            }
+          },
+          {
+            "match": {
+              "termType.keyword": "landCover"
+            }
+          },
+          {
+            "match_phrase": {
+              "name": "rice plant"
+            }
+          },
+          {
+            "match": {
+              "name": "upland"
+            }
+          }
+        ]
+      }
     },
     "results": [
       {
         "@type": "Term",
-        "@id": "ridgeTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "noTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "fullTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "minimumTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "fullInversionTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "deepTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "mulchTillage"
-      },
-      {
-        "@type": "Term",
-        "@id": "stripTillage"
+        "@id": "ricePlantUpland"
       }
     ]
   },
@@ -1777,11 +1847,11 @@
       },
       {
         "@type": "Term",
-        "@id": "ureaFormaldehydeKgN"
+        "@id": "ureaAmmoniumSulphateKgN"
       },
       {
         "@type": "Term",
-        "@id": "sulphurCoatedUreaKgN"
+        "@id": "ureaFormaldehydeKgN"
       },
       {
         "@type": "Term",
@@ -1789,11 +1859,11 @@
       },
       {
         "@type": "Term",
-        "@id": "ureaCalciumNitrateKgN"
+        "@id": "sulphurCoatedUreaKgN"
       },
       {
         "@type": "Term",
-        "@id": "ureaAmmoniumSulphateKgN"
+        "@id": "ureaCalciumNitrateKgN"
       }
     ]
   },
@@ -1833,11 +1903,11 @@
     "results": [
       {
         "@type": "Term",
-        "@id": "woodPellets"
+        "@id": "woodFuel"
       },
       {
         "@type": "Term",
-        "@id": "woodFuel"
+        "@id": "woodPellets"
       },
       {
         "@type": "Term",

hestia_earth/models/site/management.py

@@ -79,7 +79,9 @@ def _copy_item_if_exists(source: dict, keys: List[str] = [], dest: dict = {}) ->
 
 
 def _get_landCover_term_id(product: dict) -> str:
-    return get_lookup_value(product.get('term', {}), LAND_COVER_KEY, model=MODEL, model_key=LAND_COVER_KEY)
+    value = get_lookup_value(product.get('term', {}), LAND_COVER_KEY, model=MODEL, model_key=LAND_COVER_KEY)
+    # TODO: what should happen when there are multiple values?
+    return value.split(';')[0] if value else None
 
 
 def _get_items_with_relevant_term_type(cycles: List[dict], item_name: str, relevant_values: list):
@@ -111,6 +113,11 @@ def should_run(site: dict):
         )
     ]
 
+    products_crop_forage = _get_items_with_relevant_term_type(
+        cycles=cycles,
+        item_name="products",
+        relevant_values=[TermTermType.CROP, TermTermType.FORAGE]
+    )
     products_crop_forage = [
         _copy_item_if_exists(
             source=product,
@@ -120,11 +127,7 @@ def should_run(site: dict):
                 "value": 100
             }
         )
-        for product in _get_items_with_relevant_term_type(
-            cycles=cycles,
-            item_name="products",
-            relevant_values=[TermTermType.CROP, TermTermType.FORAGE]
-        )
+        for product in list(filter(_get_landCover_term_id, products_crop_forage))
     ]
 
     practices = [
@@ -150,9 +153,9 @@ def should_run(site: dict):
         model=MODEL,
         term=None,
         model_key=MODEL_KEY,
-        products_crop_forage_id=log_blank_nodes_id(products_crop_forage),
-        products_land_cover_id=log_blank_nodes_id(products_land_cover),
-        practice_id=log_blank_nodes_id(practices)
+        products_crop_forage_ids=log_blank_nodes_id(products_crop_forage),
+        products_land_cover_ids=log_blank_nodes_id(products_land_cover),
+        practice_ids=log_blank_nodes_id(practices)
     )
 
     _should_run = any(products_crop_forage + products_land_cover + practices)