hestia-earth-models 0.73.1__py3-none-any.whl → 0.73.2__py3-none-any.whl

hestia_earth/models/akagiEtAl2011/utils.py

@@ -1,6 +1,7 @@
 from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, TermTermType
 
 from hestia_earth.models.log import logRequirements, logShouldRun
+from hestia_earth.models.utils import multiply_values
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.term import get_lookup_value
 from hestia_earth.models.utils.cropResidue import get_crop_residue_burnt_value
@@ -25,7 +26,8 @@ def _run(term_id: str, product_value: list):
     term = {'termType': TermTermType.EMISSION.value, '@id': term_id}
     factor = get_lookup_value(term, LOOKUP_NAME)
     factor_sd = get_lookup_value(term, LOOKUP_NAME + '-sd')
-    return [_emission(term_id, value * factor, value * factor_sd)]
+    emission_value = multiply_values([value, factor])
+    return [] if emission_value is None else [_emission(term_id, emission_value, multiply_values([value, factor_sd]))]
 
 
 def _should_run(term_id: str, cycle: dict):

hestia_earth/models/config/Cycle.json

@@ -27,17 +27,9 @@
       "stage": 1
     },
     {
-      "key": "practices",
-      "model": "hestia",
-      "value": "croppingIntensity",
-      "runStrategy": "add_blank_node_if_missing",
-      "mergeStrategy": "list",
-      "stage": 1
-    },
-    {
-      "key": "practices",
-      "model": "geospatialDatabase",
-      "value": "croppingIntensity",
+      "key": "inputs",
+      "model": "faostat2018",
+      "value": "seed",
       "runStrategy": "add_blank_node_if_missing",
       "mergeStrategy": "list",
       "stage": 1
@@ -100,6 +92,22 @@
         "stage": 1
       }
     ],
+    {
+      "key": "practices",
+      "model": "hestia",
+      "value": "croppingIntensity",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "practices",
+      "model": "geospatialDatabase",
+      "value": "croppingIntensity",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
     [
       {
         "key": "practices",
@@ -321,14 +329,6 @@
       "stage": 1
     },
     [
-      {
-        "key": "practices",
-        "model": "hestia",
-        "value": "longFallowRatio",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
       {
         "key": "practices",
         "model": "hestia",
@@ -467,24 +467,22 @@
         "stage": 1
       }
     ],
-    [
-      {
-        "key": "inputs",
-        "model": "faostat2018",
-        "value": "seed",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "inputs",
-        "model": "pooreNemecek2018",
-        "value": "saplingsDepreciatedAmountPerCycle",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      }
-    ],
+    {
+      "key": "practices",
+      "model": "hestia",
+      "value": "longFallowRatio",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "inputs",
+      "model": "pooreNemecek2018",
+      "value": "saplingsDepreciatedAmountPerCycle",
+      "runStrategy": "add_blank_node_if_missing",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
     {
       "key": "completeness",
       "model": "cycle",

hestia_earth/models/config/Site.json

@@ -65,30 +65,6 @@
         "mergeStrategy": "list",
         "stage": 1
       },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "brackishWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "freshWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
-      {
-        "key": "measurements",
-        "model": "hestia",
-        "value": "salineWater",
-        "runStrategy": "add_blank_node_if_missing",
-        "mergeStrategy": "list",
-        "stage": 1
-      },
       {
         "key": "measurements",
         "model": "hestia",
@@ -470,6 +446,32 @@
         "stage": 2
       }
     ],
+    [
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "brackishWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "freshWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "hestia",
+        "value": "salineWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
     [
       {
         "key": "defaultMethodClassification",

hestia_earth/models/geospatialDatabase/utils.py

@@ -1,4 +1,6 @@
 import os
+from area import area
+from functools import reduce
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.tools import non_empty_list
 
@@ -85,12 +87,11 @@ def geospatial_data(site: dict, only_coordinates=False):
 
 def _get_boundary_area_size(boundary: dict):
     try:
-        from hestia_earth.earth_engine.boundary import get_size_km2
-    except ImportError:
-        raise ImportError("Run `pip install hestia_earth.earth_engine` to use this functionality")
-
-    try:
-        return get_size_km2(boundary)
+        return (
+            (area(boundary.get('geometry')) / 1_000_000) if 'geometry' in boundary else
+            reduce(lambda p, c: p + _get_boundary_area_size(c), boundary.get('features'), 0) if 'features' in boundary
+            else area(boundary) / 1_000_000
+        )
     except Exception:
         return None
 

hestia_earth/models/hestia/aboveGroundCropResidue.py

@@ -28,6 +28,7 @@ RETURNS = {
         "value": ""
     }]
 }
+MODEL_KEY = 'aboveGroundCropResidue'
 TERM_ID = 'aboveGroundCropResidueLeftOnField,aboveGroundCropResidueBurnt,aboveGroundCropResidueIncorporated,aboveGroundCropResidueRemoved'  # noqa: E501
 TOTAL_TERM_ID = 'aboveGroundCropResidueTotal'
 REMAINING_MODEL = PRODUCT_ID_TO_PRACTICES_ID[-1]['product']
@@ -59,7 +60,7 @@ def _should_run_model(model, cycle: dict, total_value: float):
     practice_value = _get_practice_value(model.get('practices'), cycle)
     has_product = find_term_match(cycle.get('products', []), term_id, None) is not None
 
-    logRequirements(cycle, model=MODEL, term=term_id,
+    logRequirements(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                     practice_value=practice_value,
                     has_product=has_product)
 
@@ -70,7 +71,7 @@ def _should_run_model(model, cycle: dict, total_value: float):
         ]),
         not has_product
     ])
-    logShouldRun(cycle, MODEL, term_id, should_run)
+    logShouldRun(cycle, MODEL, term_id, should_run, model_key=MODEL_KEY)
     return should_run, practice_value
 
 
@@ -104,7 +105,7 @@ def _run(cycle: dict, total_values: list):
     for model in models:
         term_id = model.get('product')
         value = _run_model(model, cycle, total_value)
-        debugValues(cycle, model=MODEL, term=term_id,
+        debugValues(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                     total_above_ground_crop_residue=total_value,
                     remaining_crop_residue_value=remaining_value,
                     allocated_value=value)
@@ -132,13 +133,13 @@ def _should_run_product(cycle: dict, total_values: list, term_id: str):
         find_term_match(cycle.get('practices', []), term_id).get('value', []) == [0] for term_id in practice_term_ids
     ])
 
-    logRequirements(cycle, model=MODEL, term=term_id,
+    logRequirements(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                     term_type_cropResidue_incomplete=term_type_incomplete,
                     has_aboveGroundCropResidueTotal=has_aboveGroundCropResidueTotal,
                     practice_term_ids=';'.join(practice_term_ids),
                     practice_value_is_0=is_value_0)
     should_run = all([has_aboveGroundCropResidueTotal or is_value_0, term_type_incomplete])
-    logShouldRun(cycle, MODEL, term_id, should_run)
+    logShouldRun(cycle, MODEL, term_id, should_run, model_key=MODEL_KEY)
     return should_run
 
 

hestia_earth/models/hestia/cropResidueManagement.py

@@ -20,6 +20,7 @@ RETURNS = {
         "term.termType": "cropResidueManagement"
     }]
 }
+MODEL_KEY = 'cropResidueManagement'
 PRACTICE_IDS = [
     residueBurnt.TERM_ID,
     residueIncorporated.TERM_ID,
@@ -50,10 +51,10 @@ def _should_run(cycle: dict):
     should_run = all([99.5 <= sum_practices <= 100.5])
 
     for term_id in missing_practices:
-        logRequirements(cycle, model=MODEL, term=term_id,
+        logRequirements(cycle, model=MODEL, term=term_id, model_key=MODEL_KEY,
                         sum_crop_residue_management=sum_practices)
 
-        logShouldRun(cycle, MODEL, term_id, should_run)
+        logShouldRun(cycle, MODEL, term_id, should_run, model_key=MODEL_KEY)
 
     return should_run, missing_practices
 

hestia_earth/models/ipcc2019/aboveGroundBiomass.py

@@ -3,20 +3,18 @@ from functools import reduce
 from numpy import average, copy, random, vstack
 from numpy.typing import NDArray
 from typing import Optional, Union
-
 from hestia_earth.schema import (
     MeasurementMethodClassification,
     MeasurementStatsDefinition,
     SiteSiteType
 )
-
 from hestia_earth.utils.tools import non_empty_list
+from hestia_earth.utils.stats import gen_seed
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.log import log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils import pairwise
-from hestia_earth.models.utils.array_builders import gen_seed
 from hestia_earth.models.utils.blank_node import group_nodes_by_year
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
 from hestia_earth.models.utils.source import get_source
 from hestia_earth.models.utils.measurement import _new_measurement

hestia_earth/models/ipcc2019/belowGroundBiomass.py

@@ -3,20 +3,18 @@ from functools import reduce
 from numpy import average, copy, random, vstack
 from numpy.typing import NDArray
 from typing import Optional, Union
-
 from hestia_earth.schema import (
     MeasurementMethodClassification,
     MeasurementStatsDefinition,
     SiteSiteType
 )
-
 from hestia_earth.utils.tools import non_empty_list
+from hestia_earth.utils.stats import gen_seed
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.log import log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils import pairwise
-from hestia_earth.models.utils.array_builders import gen_seed
 from hestia_earth.models.utils.blank_node import group_nodes_by_year
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
 from hestia_earth.models.utils.source import get_source
 from hestia_earth.models.utils.measurement import _new_measurement

hestia_earth/models/ipcc2019/biomass_utils.py

@@ -9,7 +9,7 @@ from hestia_earth.schema import TermTermType
 from hestia_earth.utils.blank_node import get_node_value
 from hestia_earth.utils.model import filter_list_term_type
 
-from hestia_earth.models.utils.array_builders import repeat_single, truncated_normal_1d
+from hestia_earth.utils.stats import repeat_single, truncated_normal_1d
 from hestia_earth.models.utils.blank_node import node_term_match, validate_start_date_end_date
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_ecoClimateZone_lookup_grouped_value
 from hestia_earth.models.utils.term import get_cover_crop_property_terms, get_lookup_value

hestia_earth/models/ipcc2019/ch4ToAirOrganicSoilCultivation.py

@@ -1,15 +1,14 @@
 import numpy as np
 import numpy.typing as npt
 from typing import Callable, Union
-
 from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition
-
 from hestia_earth.models.log import logRequirements, logShouldRun
-from hestia_earth.models.utils.array_builders import (
+from hestia_earth.utils.stats import (
     discrete_uniform_1d, gen_seed, normal_1d, repeat_single, triangular_1d
 )
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
+
 from hestia_earth.models.utils.cycle import land_occupation_per_ha
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.measurement import most_relevant_measurement_value

hestia_earth/models/ipcc2019/co2ToAirCarbonStockChange_utils.py

@@ -2,7 +2,6 @@
 Utilities for calculating CO2 emissions based on changes in carbon stocks (e.g., `organicCarbonPerHa`,
 `aboveGroundBiomass` and `belowGroundBiomass`).
 """
-
 from datetime import datetime, timedelta
 from enum import Enum
 from functools import reduce
@@ -11,22 +10,21 @@ from numpy import array, random, mean
 from numpy.typing import NDArray
 from pydash.objects import merge
 from typing import Any, Callable, NamedTuple, Optional, Union
-
 from hestia_earth.schema import (
     EmissionMethodTier, EmissionStatsDefinition, MeasurementMethodClassification
 )
 from hestia_earth.utils.date import diff_in_days, YEAR
 from hestia_earth.utils.tools import flatten, non_empty_list, safe_parse_date
+from hestia_earth.utils.stats import correlated_normal_2d, gen_seed
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.log import log_as_table
 from hestia_earth.models.utils import pairwise
-from hestia_earth.models.utils.array_builders import correlated_normal_2d, gen_seed
 from hestia_earth.models.utils.blank_node import (
     _gapfill_datestr, _get_datestr_format, DatestrGapfillMode, DatestrFormat, group_nodes_by_year, node_term_match,
     split_node_by_dates
 )
 from hestia_earth.models.utils.constant import Units, get_atomic_conversion
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.emission import min_emission_method_tier
 from hestia_earth.models.utils.measurement import (
     group_measurements_by_method_classification, min_measurement_method_classification,

hestia_earth/models/ipcc2019/co2ToAirOrganicSoilCultivation.py

@@ -1,13 +1,12 @@
 import numpy as np
 import numpy.typing as npt
 from typing import Callable, Union
-
 from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition
+from hestia_earth.utils.stats import gen_seed, repeat_single, truncated_normal_1d
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.log import logRequirements, logShouldRun
-from hestia_earth.models.utils.array_builders import gen_seed, repeat_single, truncated_normal_1d
 from hestia_earth.models.utils.cycle import land_occupation_per_ha
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.measurement import most_relevant_measurement_value

hestia_earth/models/ipcc2019/nonCo2EmissionsToAirNaturalVegetationBurning.py

@@ -4,15 +4,14 @@ from itertools import product
 import numpy as np
 import numpy.typing as npt
 from typing import Any, Callable, Literal, Optional, TypedDict, Union
-
 from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, SiteSiteType
 from hestia_earth.utils.lookup import download_lookup, get_table_value, column_name
 from hestia_earth.utils.tools import safe_parse_float
+from hestia_earth.utils.stats import gen_seed, repeat_single, truncated_normal_1d
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.log import debugMissingLookup, log_as_table, logRequirements, logShouldRun
-from hestia_earth.models.utils.array_builders import gen_seed, repeat_single, truncated_normal_1d
 from hestia_earth.models.utils.blank_node import group_nodes_by_year
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
 from hestia_earth.models.utils.emission import _new_emission
 from hestia_earth.models.utils.lookup import get_region_lookup_value

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_1.py

@@ -4,20 +4,19 @@ from numpy import empty_like, random, vstack
 from numpy.typing import NDArray
 from pydash.objects import merge
 from typing import Callable, Literal, Optional, Union
-
 from hestia_earth.schema import MeasurementMethodClassification, SiteSiteType, TermTermType
 from hestia_earth.utils.blank_node import get_node_value
 from hestia_earth.utils.model import find_term_match, filter_list_term_type
 from hestia_earth.utils.tools import non_empty_list
+from hestia_earth.utils.stats import gen_seed
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 
 from hestia_earth.models.utils import split_on_condition
-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, group_by_term,
     node_lookup_match, node_term_match, group_nodes_by_year, validate_start_date_end_date
 )
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.measurement import _new_measurement
 from hestia_earth.models.utils.property import get_node_property
 from hestia_earth.models.utils.term import get_residue_removed_or_burnt_terms, get_upland_rice_land_cover_terms

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_2.py

@@ -3,23 +3,22 @@ from numpy import array, empty, exp, minimum, random, where, vstack
 from numpy.typing import NDArray
 from pydash.objects import merge
 from typing import Any, Callable, Union
-
 from hestia_earth.schema import (
     CycleFunctionalUnit, MeasurementMethodClassification, SiteSiteType, TermTermType
 )
 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 (
+from hestia_earth.utils.stats import (
     avg_run_in_columnwise, gen_seed, grouped_avg, repeat_1d_array_as_columns
 )
+from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
+
 from hestia_earth.models.utils.blank_node import (
     cumulative_nodes_lookup_match, cumulative_nodes_term_match, group_nodes_by_year, group_nodes_by_year_and_month,
     GroupNodesByYearMode, node_lookup_match, node_term_match
 )
 from hestia_earth.models.utils.cycle import check_cycle_site_ids_identical
-from hestia_earth.models.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.models.utils.measurement import _new_measurement
 from hestia_earth.models.utils.property import get_node_property
 from hestia_earth.models.utils.site import related_cycles

hestia_earth/models/ipcc2019/organicCarbonPerHa_utils.py

@@ -2,14 +2,13 @@ from enum import Enum
 from numpy import inf
 from numpy.typing import NDArray
 from typing import NamedTuple, Optional
-
 from hestia_earth.schema import MeasurementStatsDefinition, SiteSiteType
+from hestia_earth.utils.stats import calc_z_critical
 
-from hestia_earth.models.utils.array_builders import (
+from hestia_earth.utils.stats import (
     repeat_single, truncated_normal_1d
 )
 from hestia_earth.models.utils.blank_node import cumulative_nodes_term_match, node_term_match
-from hestia_earth.models.utils.stats import calc_z_critical
 from hestia_earth.models.utils.term import get_cover_crop_property_terms, get_irrigated_terms
 
 STATS_DEFINITION = MeasurementStatsDefinition.SIMULATED.value