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

hestia_earth/models/blonkConsultants2016/utils.py

@@ -25,5 +25,6 @@ def get_emission_factor(term_id: str, cycle: dict, factor: str):
     data = safe_parse_float(value, None)
     # fallback to site.siteType data if possible
     return data if data is not None else safe_parse_float(
-        extract_grouped_data(
-            get_table_value(lookup, 'termid', country_id, column_name('NONE')), site.get('siteType')), None)
+        extract_grouped_data(get_table_value(lookup, 'termid', country_id, column_name('NONE')), site.get('siteType')),
+        None
+    )

hestia_earth/models/cycle/post_checks/__init__.py

@@ -2,14 +2,15 @@ from os.path import dirname, abspath
 import sys
 
 from hestia_earth.models.utils import _run_in_serie
-from . import cache, site
+from . import cache, site, otherSites
 
 CURRENT_DIR = dirname(abspath(__file__)) + '/'
 sys.path.append(CURRENT_DIR)
 
 MODELS = [
     cache.run,
-    site.run
+    site.run,
+    otherSites.run
 ]
 
 

hestia_earth/models/cycle/post_checks/otherSites.py

@@ -0,0 +1,40 @@
+"""
+Post Checks Other Sites
+
+This model is run only if the [pre model](../pre_checks/cycle.md) has been run before.
+This model will restore the `cycle.otherSites` as a list of "linked node"
+(i.e. it will be set with only `@type`, `@id` and `name` keys).
+"""
+from hestia_earth.utils.model import linked_node
+
+REQUIREMENTS = {
+    "Cycle": {
+        "otherSites": [{
+            "@type": "Site",
+            "@id": ""
+        }]
+    }
+}
+RETURNS = {
+    "Cycle": {
+        "otherSites": [{"@type": "Site"}]
+    }
+}
+MODEL_KEY = 'otherSites'
+
+
+def _run_site(site: dict): return linked_node(site)
+
+
+def _should_run_site(site: dict): return site.get('@id') is not None
+
+
+def _should_run(cycle: dict): return len(cycle.get(MODEL_KEY, [])) > 0
+
+
+def run(cycle: dict):
+    return cycle | (
+        ({
+            MODEL_KEY: [_run_site(site) if _should_run_site(site) else site for site in cycle.get(MODEL_KEY, [])]
+        }) if _should_run(cycle) else {}
+    )

hestia_earth/models/cycle/pre_checks/__init__.py

@@ -2,12 +2,13 @@ from os.path import dirname, abspath
 import sys
 
 from hestia_earth.models.utils import _run_in_serie
-from . import site, cache_sources
+from . import site, cache_sources, otherSites
 
 CURRENT_DIR = dirname(abspath(__file__)) + '/'
 sys.path.append(CURRENT_DIR)
 
 MODELS = [
+    otherSites.run,
     site.run,
     cache_sources.run
 ]

hestia_earth/models/cycle/pre_checks/otherSites.py

@@ -0,0 +1,42 @@
+"""
+Pre Checks Other Sites
+
+Some Cycle models need a full version of the linked [Site](https://hestia.earth/schema/Site) to run.
+This model will fetch the complete version of the [Cycle Sites](https://hestia.earth/schema/Cycle#otherSites)
+and include them.
+"""
+from hestia_earth.schema import SchemaType
+
+from hestia_earth.models.utils import _load_calculated_node
+
+REQUIREMENTS = {
+    "Cycle": {
+        "otherSites": [{
+            "@type": "Site",
+            "@id": ""
+        }]
+    }
+}
+RETURNS = {
+    "Cycle": {
+        "otherSites": [{"@type": "Site"}]
+    }
+}
+MODEL_KEY = 'otherSites'
+
+
+def _run_site(site: dict): return _load_calculated_node(site, SchemaType.SITE)
+
+
+def _should_run_site(site: dict): return site.get('@id') is not None
+
+
+def _should_run(cycle: dict): return len(cycle.get(MODEL_KEY, [])) > 0
+
+
+def run(cycle: dict):
+    return cycle | (
+        ({
+            MODEL_KEY: [_run_site(site) if _should_run_site(site) else site for site in cycle.get(MODEL_KEY, [])]
+        }) if _should_run(cycle) else {}
+    )

hestia_earth/models/cycle/pre_checks/site.py

@@ -2,7 +2,7 @@
 Pre Checks Site
 
 Some Cycle models need a full version of the linked [Site](https://hestia.earth/schema/Site) to run.
-This model will fetch the complete version of the [Site](https://hestia.earth/schema/Site) and include it.
+This model will fetch the complete version of the [Cycle Site](https://hestia.earth/schema/Cycle#site) and include it.
 """
 from hestia_earth.schema import SchemaType
 

hestia_earth/models/ecoinventV3AndEmberClimate/utils.py

@@ -33,7 +33,7 @@ def _extract_emission_value(value_iter: Any) -> Union[float, None]:
     value_list = list(value_iter)
     try:
         if len(list(value_list)) > 0 and len(list(value_list)[0]) > 1:
-            return safe_parse_float(list(value_list)[0][1])
+            return safe_parse_float(list(value_list)[0][1], None)
     except ValueError:
         return None
 

hestia_earth/models/emepEea2019/utils.py

@@ -1,7 +1,7 @@
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.lookup import extract_grouped_data
-from hestia_earth.utils.tools import list_sum, safe_parse_float
+from hestia_earth.utils.tools import list_sum, safe_parse_float, non_empty_list
 
 from hestia_earth.models.utils.completeness import _is_term_type_complete
 from hestia_earth.models.utils.term import get_lookup_value
@@ -19,14 +19,15 @@ def _get_fuel_input_value(term_id: str, lookup_col: str):
             get_lookup_value(operation_term, lookup_col, model=MODEL, term=term_id), input_term_id
         ) if operation_term else None
         input_factor = operation_factor or get_lookup_value(input_term, lookup_col, model=MODEL, term=term_id)
+        factor = safe_parse_float(input_factor, None)
 
-        return input_value * safe_parse_float(input_factor)
+        return input_value * factor if factor is not None else None
     return get_value
 
 
 def get_fuel_values(term_id: str, cycle: dict, lookup_col: str):
     inputs = filter_list_term_type(cycle.get('inputs', []), TermTermType.FUEL)
-    values = list(map(_get_fuel_input_value(term_id, lookup_col), inputs))
+    values = non_empty_list(map(_get_fuel_input_value(term_id, lookup_col), inputs))
 
     return [0] if all([
         len(values) == 0,

hestia_earth/models/geospatialDatabase/heavyWinterPrecipitation.py

@@ -39,7 +39,7 @@ def _measurement(site: dict, value: float):
 
 def _download(site: dict):
     value = download(TERM_ID, site, EE_PARAMS)
-    return 1 if value == 1 else (0 if value == 0.1 else None)
+    return value == 1
 
 
 def _run(site: dict):

hestia_earth/models/ipcc2019/animal/pastureGrass.py

@@ -189,7 +189,7 @@ def _calculate_GE(
 ) -> float:
     term_id = animal.get('term', {}).get('@id')
 
-    NEm, NEa, NEl, NEwork, NEp, NEg = get_animal_values(cycle, animal, system)
+    NEm, NEa, NEl, NEwork, NEp, NEg = get_animal_values(cycle, animal, system, log_node=animal)
 
     NEm_feed, NEg_feed = calculate_NEfeed(animal)
     debugValues(animal, model=MODEL, term=term_id, model_key=MODEL_KEY,
@@ -205,19 +205,19 @@ def _calculate_GE(
     return (NEm + NEa + NEl + NEwork + NEp - NEm_feed)/REM + (NEg + NEwool - NEg_feed)/REG
 
 
-def _run_practice(cycle: dict, GE: float, meanECHHV: float):
+def _run_practice(animal: dict, GE: float, meanECHHV: float):
     def run(practice: dict):
         key = practice.get('key', {})
         key_id = key.get('@id')
         input_term_id = practice_input_id(practice)
         value = (GE / meanECHHV) * (list_sum(practice.get('value', [0])) / 100)
 
-        logRequirements(cycle, model=MODEL, term=input_term_id, model_key=MODEL_KEY,
+        logRequirements(animal, model=MODEL, term=input_term_id, model_key=MODEL_KEY,
                         GE=GE,
                         meanECHHV=meanECHHV,
-                        key_id=key_id)
+                        practice_key_id=key_id)
 
-        logShouldRun(cycle, MODEL, input_term_id, True, model_key=MODEL_KEY)
+        logShouldRun(animal, MODEL, input_term_id, True, model_key=MODEL_KEY)
 
         return _input(input_term_id, value)
 
@@ -249,7 +249,7 @@ def _run_animal(cycle: dict, meanDE: float, meanECHHV: float, system: dict, prac
                     GE=GE,
                     meanDE=meanDE)
 
-        inputs = list(map(_run_practice(cycle, GE, meanECHHV), practices))
+        inputs = list(map(_run_practice(animal, GE, meanECHHV), practices))
         return animal | {
             'inputs': animal.get('inputs', []) + inputs
         }

hestia_earth/models/ipcc2019/co2ToAirSoilOrganicCarbonStockChangeManagementChange.py

@@ -7,7 +7,7 @@ from pydash.objects import merge
 from typing import NamedTuple, Optional, Union
 
 from hestia_earth.schema import (
-    CycleFunctionalUnit, EmissionMethodTier, MeasurementMethodClassification
+    CycleFunctionalUnit, EmissionMethodTier, MeasurementMethodClassification, SiteSiteType
 )
 from hestia_earth.utils.date import diff_in_days
 from hestia_earth.utils.tools import flatten, non_empty_list, safe_parse_date
@@ -15,7 +15,8 @@ from hestia_earth.utils.tools import flatten, non_empty_list, safe_parse_date
 from hestia_earth.models.log import log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils import pairwise
 from hestia_earth.models.utils.blank_node import (
-    _get_datestr_format, _gapfill_datestr, DatestrGapfillMode, DatestrFormat, group_nodes_by_year, node_term_match
+    _get_datestr_format, _gapfill_datestr, DatestrGapfillMode, DatestrFormat, group_nodes_by_year, node_term_match,
+    cumulative_nodes_term_match
 )
 from hestia_earth.models.utils.constant import Units, get_atomic_conversion
 from hestia_earth.models.utils.emission import _new_emission, min_emission_method_tier
@@ -82,6 +83,13 @@ The list of `MeasurementMethodClassification`s that can be used to calculate SOC
 order from strongest to weakest.
 """
 
+_SITE_TYPE_SYSTEMS_MAPPING = {
+    SiteSiteType.GLASS_OR_HIGH_ACCESSIBLE_COVER.value: [
+        "protectedCroppingSystemSoilBased",
+        "protectedCroppingSystemSoilAndSubstrateBased"
+    ]
+}
+
 
 class _InventoryKey(Enum):
     """
@@ -207,19 +215,37 @@ def _should_run(cycle: dict) -> tuple[bool, str, dict]:
     soc_measurements = [node for node in site.get("measurements", []) if _validate_soc_measurement(node)]
     cycles = related_cycles(site)
 
+    site_type = site.get("siteType")
+    has_soil = site_type not in _SITE_TYPE_SYSTEMS_MAPPING or all(
+        cumulative_nodes_term_match(
+            cycle.get("practices", []),
+            target_term_ids=_SITE_TYPE_SYSTEMS_MAPPING[site_type],
+            cumulative_threshold=0
+        ) for cycle in cycles
+    )
+
     has_soc_measurements = len(soc_measurements) > 0
     has_cycles = len(cycles) > 0
     has_functional_unit_1_ha = all(cycle.get('functionalUnit') == CycleFunctionalUnit._1_HA.value for cycle in cycles)
 
-    should_compile_inventory = all([has_cycles, has_functional_unit_1_ha, has_soc_measurements])
+    should_compile_inventory = all([
+        has_soil,
+        has_cycles,
+        has_functional_unit_1_ha,
+        has_soc_measurements,
+    ])
 
-    inventory, logs = _compile_inventory(cycle_id, cycles, soc_measurements) if should_compile_inventory else ({}, {})
+    inventory, logs = (
+        _compile_inventory(cycle_id, cycles, soc_measurements) if should_compile_inventory else ({}, {})
+    )
 
     has_valid_inventory = len(inventory) > 0
     has_consecutive_years = check_consecutive(inventory.keys())
 
     logRequirements(
         cycle, model=MODEL, term=TERM_ID,
+        site_type=site_type,
+        has_soil=has_soil,
         has_soc_measurements=has_soc_measurements,
         has_cycles=has_cycles,
         has_functional_unit_1_ha=has_functional_unit_1_ha,

hestia_earth/models/ipcc2019/n2OToAirExcretaDirect.py

@@ -1,7 +1,8 @@
-from hestia_earth.schema import EmissionMethodTier
+from hestia_earth.schema import EmissionMethodTier, TermTermType
 
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.constant import Units, get_atomic_conversion
+from hestia_earth.models.utils.completeness import _is_term_type_complete
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.input import total_excreta
 from hestia_earth.models.utils.excretaManagement import get_lookup_factor
@@ -9,6 +10,7 @@ from . import MODEL
 
 REQUIREMENTS = {
     "Cycle": {
+        "completeness.excreta": "True",
         "practices": [
             {"@type": "Practice", "value": "", "term.termType": "excretaManagement"}
         ]
@@ -42,10 +44,12 @@ def _run(excretaKgN: float, N2O_N_EF: float):
 def _should_run(cycle: dict):
     excretaKgN = total_excreta(cycle.get('inputs', []))
     N2O_N_EF = get_lookup_factor(cycle.get('practices', []), LOOKUPS['excretaManagement'])
+    term_type_complete = _is_term_type_complete(cycle, TermTermType.EXCRETA)
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
                     excretaKgN=excretaKgN,
-                    N2O_N_EF=N2O_N_EF)
+                    N2O_N_EF=N2O_N_EF,
+                    term_type_excreta_complete=term_type_complete)
 
     should_run = all([excretaKgN, N2O_N_EF])
     logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)

hestia_earth/models/ipcc2019/n2OToAirExcretaIndirect.py

@@ -88,7 +88,7 @@ def _should_run(cycle: dict):
                     no3_n=no3_n,
                     nh3_n=nh3_n,
                     nox_n=nox_n,
-                    term_type_cropResidue_complete=term_type_complete)
+                    term_type_excreta_complete=term_type_complete)
 
     should_run = all([no3_n is not None, nh3_n is not None, nox_n is not None, term_type_complete])
     logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)

hestia_earth/models/ipcc2019/n2OToAirInorganicFertiliserDirect.py

@@ -97,7 +97,7 @@ def _should_run(cycle: dict):
     flooded_rice = has_flooded_rice(cycle.get('products', []))
 
     logRequirements(cycle, model=MODEL, term=TERM_ID,
-                    term_type_cropResidue_complete=term_type_complete,
+                    term_type_fertiliser_complete=term_type_complete,
                     N_total=N_total,
                     has_flooded_rice=flooded_rice,
                     ecoClimateZone=ecoClimateZone)

hestia_earth/models/ipcc2019/n2OToAirInorganicFertiliserIndirect.py

@@ -88,7 +88,7 @@ def _should_run(cycle: dict):
                     no3_n=no3_n,
                     nh3_n=nh3_n,
                     nox_n=nox_n,
-                    term_type_cropResidue_complete=term_type_complete)
+                    term_type_fertiliser_complete=term_type_complete)
 
     should_run = all([no3_n is not None, nh3_n is not None, nox_n is not None, term_type_complete])
     logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)

hestia_earth/models/ipcc2019/n2OToAirOrganicFertiliserIndirect.py

@@ -88,7 +88,7 @@ def _should_run(cycle: dict):
                     no3_n=no3_n,
                     nh3_n=nh3_n,
                     nox_n=nox_n,
-                    term_type_cropResidue_complete=term_type_complete)
+                    term_type_fertiliser_complete=term_type_complete)
 
     should_run = all([no3_n is not None, nh3_n is not None, nox_n is not None, term_type_complete])
     logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_1_utils.py

@@ -19,10 +19,11 @@ from typing import Callable, Optional, Union
 
 from hestia_earth.schema import MeasurementMethodClassification, SiteSiteType, TermTermType
 from hestia_earth.utils.model import find_term_match, filter_list_term_type
+from hestia_earth.utils.blank_node import get_node_value
 
 from hestia_earth.models.utils.array_builders import gen_seed
 from hestia_earth.models.utils.blank_node import (
-    cumulative_nodes_match, cumulative_nodes_lookup_match, cumulative_nodes_term_match, get_node_value,
+    cumulative_nodes_match, cumulative_nodes_lookup_match, cumulative_nodes_term_match,
     node_lookup_match, node_term_match, group_nodes_by_year
 )
 from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
@@ -1952,6 +1953,7 @@ def _get_carbon_input_kwargs(
     crop_residue_management_nodes = filter_list_term_type(management_nodes, [TermTermType.CROPRESIDUEMANAGEMENT])
     land_cover_nodes = filter_list_term_type(management_nodes, [TermTermType.LANDCOVER])
     land_use_management_nodes = filter_list_term_type(management_nodes, [TermTermType.LANDUSEMANAGEMENT])
+    system_nodes = filter_list_term_type(management_nodes, [TermTermType.SYSTEM])
     water_regime_nodes = filter_list_term_type(management_nodes, [TermTermType.WATERREGIME])
 
     has_animal_manure_used = any(
@@ -2006,7 +2008,7 @@ def _get_carbon_input_kwargs(
             node_lookup_match(node, PRACTICE_INCREASING_C_INPUT_LOOKUP, True)
             and not node_term_match(node, EXCLUDED_PRACTICE_TERM_IDS)
         ),
-        land_use_management_nodes,
+        land_use_management_nodes + system_nodes,
         cumulative_threshold=MIN_AREA_THRESHOLD
     )
 

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_2_utils.py

@@ -19,12 +19,13 @@ from hestia_earth.schema import (
 )
 from hestia_earth.utils.model import find_term_match, filter_list_term_type
 from hestia_earth.utils.tools import flatten, list_sum, non_empty_list
+from hestia_earth.utils.blank_node import get_node_value
 
 from hestia_earth.models.utils.array_builders import (
     avg_run_in_columnwise, gen_seed, grouped_avg, repeat_1d_array_as_columns
 )
 from hestia_earth.models.utils.blank_node import (
-    cumulative_nodes_lookup_match, cumulative_nodes_term_match, get_node_value, group_nodes_by_year,
+    cumulative_nodes_lookup_match, cumulative_nodes_term_match, group_nodes_by_year,
     group_nodes_by_year_and_month, GroupNodesByYearMode, node_term_match
 )
 from hestia_earth.models.utils.cycle import check_cycle_site_ids_identical

hestia_earth/models/ipcc2019/pastureGrass.py

@@ -165,7 +165,7 @@ def calculate_NEwool(cycle: dict) -> float:
 def _calculate_GE(
     cycle: dict, animals: list, REM: float, REG: float, NEwool: float, NEm_feed: float, NEg_feed: float, system: dict
 ) -> float:
-    values = [get_animal_values(cycle, animal, system) for animal in animals]
+    values = [get_animal_values(cycle, animal, system, log_node=cycle) for animal in animals]
     NEm = _sum_values(values, 0)
     NEa = _sum_values(values, 1)
     NEl = _sum_values(values, 2)
@@ -209,7 +209,7 @@ def _run_practice(cycle: dict, meanDE: float, meanECHHV: float, system: dict):
                         NEm_feed=NEm_feed,
                         NEg_feed=NEg_feed,
                         GE=GE,
-                        key_id=key_id)
+                        practice_key_id=key_id)
 
         logShouldRun(cycle, MODEL, input_term_id, True, model_key=MODEL_KEY)
 
@@ -242,7 +242,7 @@ def _should_run(cycle: dict, practices: dict):
         meanECHHV > 0
     ])
 
-    for term_id in [MODEL_KEY] + [practice_input_id(p) for p in practices]:
+    for term_id in [practice_input_id(p) for p in practices] or [MODEL_KEY]:
         logRequirements(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                         term_type_animalFeed_complete=animalFeed_complete,
                         term_type_animalPopulation_complete=animalPopulation_complete,