hestia-earth-models 0.74.14__py3-none-any.whl → 0.74.16__py3-none-any.whl

hestia_earth/models/ipcc2019/aboveGroundBiomass.py

@@ -2,7 +2,7 @@ from enum import Enum
 from functools import reduce
 from numpy import average, copy, random, vstack
 from numpy.typing import NDArray
-from typing import Optional, Union
+from typing import Union
 from hestia_earth.schema import (
     MeasurementMethodClassification,
     MeasurementStatsDefinition,
@@ -12,7 +12,7 @@ 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.log import format_bool, format_float, log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils import pairwise
 from hestia_earth.models.utils.blank_node import group_nodes_by_year
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
@@ -338,7 +338,7 @@ def _format_inventory(inventory: dict) -> str:
         {
             "year": year,
             **{
-                _format_column_header(category): _format_number(
+                _format_column_header(category): format_float(
                     inventory.get(year, {}).get(_InventoryKey.LAND_COVER_SUMMARY, {}).get(category, 0)
                 ) for category in land_covers
             },
@@ -384,16 +384,6 @@ def _get_loggable_inventory_keys(inventory: dict) -> list:
     return sorted(unique_keys, key=lambda key_: key_order[key_])
 
 
-def _format_bool(value: Optional[bool]) -> str:
-    """Format a bool for logging in a table."""
-    return str(bool(value))
-
-
-def _format_number(value: Optional[float]) -> str:
-    """Format a float for logging in a table."""
-    return f"{value:.1f}" if isinstance(value, (float, int)) else "None"
-
-
 def _format_column_header(value: Union[_InventoryKey, BiomassCategory, str]):
     """Format an enum or str for logging as a table column header."""
     as_string = value.value if isinstance(value, Enum) else str(value)
@@ -401,8 +391,8 @@ def _format_column_header(value: Union[_InventoryKey, BiomassCategory, str]):
 
 
 _INVENTORY_KEY_TO_FORMAT_FUNC = {
-    _InventoryKey.LAND_COVER_CHANGE_EVENT: _format_bool,
-    _InventoryKey.YEARS_SINCE_LCC_EVENT: _format_number
+    _InventoryKey.LAND_COVER_CHANGE_EVENT: format_bool,
+    _InventoryKey.YEARS_SINCE_LCC_EVENT: format_float
 }
 """
 Map inventory keys to format functions. The columns in inventory logged as a table will also be sorted in the order of

hestia_earth/models/ipcc2019/belowGroundBiomass.py

@@ -2,7 +2,7 @@ from enum import Enum
 from functools import reduce
 from numpy import average, copy, random, vstack
 from numpy.typing import NDArray
-from typing import Optional, Union
+from typing import Union
 from hestia_earth.schema import (
     MeasurementMethodClassification,
     MeasurementStatsDefinition,
@@ -12,7 +12,7 @@ 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.log import format_bool, format_float, log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils import pairwise
 from hestia_earth.models.utils.blank_node import group_nodes_by_year
 from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_eco_climate_zone_value
@@ -325,7 +325,7 @@ def _format_inventory(inventory: dict) -> str:
         {
             "year": year,
             **{
-                _format_column_header(category): _format_number(
+                _format_column_header(category): format_float(
                     inventory.get(year, {}).get(_InventoryKey.BIOMASS_CATEGORY_SUMMARY, {}).get(category, 0)
                 ) for category in land_covers
             },
@@ -371,16 +371,6 @@ def _get_loggable_inventory_keys(inventory: dict) -> list:
     return sorted(unique_keys, key=lambda key_: key_order[key_])
 
 
-def _format_bool(value: Optional[bool]) -> str:
-    """Format a bool for logging in a table."""
-    return str(bool(value))
-
-
-def _format_number(value: Optional[float]) -> str:
-    """Format a float for logging in a table."""
-    return f"{value:.1f}" if isinstance(value, (float, int)) else "None"
-
-
 def _format_column_header(value: Union[_InventoryKey, BiomassCategory, str]):
     """Format an enum or str for logging as a table column header."""
     as_string = value.value if isinstance(value, Enum) else str(value)
@@ -388,8 +378,8 @@ def _format_column_header(value: Union[_InventoryKey, BiomassCategory, str]):
 
 
 _INVENTORY_KEY_TO_FORMAT_FUNC = {
-    _InventoryKey.LAND_COVER_CHANGE_EVENT: _format_bool,
-    _InventoryKey.YEARS_SINCE_LCC_EVENT: _format_number
+    _InventoryKey.LAND_COVER_CHANGE_EVENT: format_bool,
+    _InventoryKey.YEARS_SINCE_LCC_EVENT: format_float
 }
 """
 Map inventory keys to format functions. The columns in inventory logged as a table will also be sorted in the order of

hestia_earth/models/ipcc2019/biocharOrganicCarbonPerHa.py

@@ -11,7 +11,7 @@ from hestia_earth.utils.descriptive_stats import calc_descriptive_stats
 from hestia_earth.utils.stats import gen_seed, truncated_normal_1d
 from hestia_earth.utils.tools import non_empty_list
 
-from hestia_earth.models.log import log_as_table, logRequirements, logShouldRun
+from hestia_earth.models.log import format_nd_array, format_str, log_as_table, logRequirements, logShouldRun
 from hestia_earth.models.utils.blank_node import group_nodes_by_year, filter_list_term_type
 from hestia_earth.models.utils.measurement import _new_measurement
 from hestia_earth.models.utils.property import get_node_property
@@ -280,17 +280,17 @@ def _format_inventory(inventory: dict) -> str:
     return log_as_table(
         {
             "year": year,
-            "stable-oc-from-biochar": _format_factor(inventory.get(year))
+            "stable-oc-from-biochar": format_nd_array(inventory.get(year))
         } for year in inventory_years
     ) if should_run else "None"
 
 
 def _format_logs(logs: dict):
     """
-    Format model logs. Format method selected based on dict key, with `_format_str` as fallback.
+    Format model logs. Format method selected based on dict key, with `format_str` as fallback.
     """
     return {
-        _format_str(key): _LOG_KEY_TO_FORMAT_FUNC.get(key, _format_str)(value) for key, value in logs.items()
+        format_str(key): _LOG_KEY_TO_FORMAT_FUNC.get(key, format_str)(value) for key, value in logs.items()
     }
 
 
@@ -303,45 +303,11 @@ def _format_factor_cache(factor_cache: dict) -> str:
     return log_as_table(
         {
             "term-id": term_id,
-            **{_format_str(key): _format_factor(value) for key, value in factor_dict.items()}
+            **{format_str(key): format_nd_array(value) for key, value in factor_dict.items()}
         } for term_id, factor_dict in factor_cache.items()
     ) if should_run else "None"
 
 
-def _format_factor(value) -> str:
-    """
-    Format a model factor. Method selected based on factor type (ndarray, int or float).
-    """
-    format_func = next(
-        (func for type, func in _TYPE_TO_FORMAT_FUNC.items() if isinstance(value, type)),
-        None
-    )
-    return format_func(value) if format_func else "None"
-
-
-def _format_nd_array(value) -> str:
-    return f"{np.mean(value):.3g} ± {np.std(value):.3g}"
-
-
-def _format_number(value) -> str:
-    return f"{value:.3g}"
-
-
-_INVALID_CHARS = {"_", ":", ",", "="}
-_REPLACEMENT_CHAR = "-"
-
-
-def _format_str(value: str, *_) -> str:
-    """Format a string for logging in a table. Remove all characters used to render the table on the front end."""
-    return reduce(lambda x, char: x.replace(char, _REPLACEMENT_CHAR), _INVALID_CHARS, str(value))
-
-
-_TYPE_TO_FORMAT_FUNC = {
-    np.ndarray: _format_nd_array,
-    (float, int): _format_number
-}
-
-
 _LOG_KEY_TO_FORMAT_FUNC = {
     "factor_cache": _format_factor_cache
 }

hestia_earth/models/ipcc2019/ch4ToAirOrganicSoilCultivation.py

@@ -2,7 +2,7 @@ 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.log import format_nd_array, format_float, logRequirements, logShouldRun
 from hestia_earth.utils.stats import (
     discrete_uniform_1d, gen_seed, normal_1d, repeat_single, triangular_1d
 )
@@ -15,8 +15,8 @@ from hestia_earth.models.utils.measurement import most_relevant_measurement_valu
 from hestia_earth.models.utils.site import valid_site_type
 
 from .organicSoilCultivation_utils import (
-    assign_ditch_category, assign_organic_soil_category, calc_emission, DitchCategory, format_nd_array, format_number,
-    get_ditch_frac, get_emission_factor, OrganicSoilCategory, remap_categories, valid_eco_climate_zone
+    assign_ditch_category, assign_organic_soil_category, calc_emission, DitchCategory, get_ditch_frac,
+    get_emission_factor, OrganicSoilCategory, remap_categories, valid_eco_climate_zone
 )
 from . import MODEL
 
@@ -226,8 +226,8 @@ def _should_run(cycle: dict):
         emission_factor=format_nd_array(emission_factor),
         ditch_factor=format_nd_array(ditch_factor),
         ditch_frac=format_nd_array(ditch_frac),
-        land_occupation=format_number(land_occupation),
-        histosol=format_number(histosol)
+        land_occupation=format_float(land_occupation),
+        histosol=format_float(histosol)
     )
 
     should_run = all([

hestia_earth/models/ipcc2019/co2ToAirAboveGroundBiomassStockChange.py

@@ -1,6 +1,5 @@
 from hestia_earth.schema import EmissionMethodTier, MeasurementMethodClassification
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .biomass_utils import detect_land_cover_change, get_valid_management_nodes, summarise_land_cover_nodes
@@ -42,8 +41,10 @@ RETURNS = {
 }
 TERM_ID = 'co2ToAirAboveGroundBiomassStockChangeLandUseChange,co2ToAirAboveGroundBiomassStockChangeManagementChange'
 
-_LU_EMISSION_TERM_ID = "co2ToAirAboveGroundBiomassStockChangeLandUseChange"
-_MG_EMISSION_TERM_ID = "co2ToAirAboveGroundBiomassStockChangeManagementChange"
+_TERM_IDS = TERM_ID.split(",")
+
+_LU_EMISSION_TERM_ID = _TERM_IDS[0]
+_MG_EMISSION_TERM_ID = _TERM_IDS[1]
 
 _CARBON_STOCK_TERM_ID = 'aboveGroundBiomass'
 
@@ -122,23 +123,17 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
-        measurements_mandatory=False,  # Model can allocate zero emissions to LUC with enough landCover data
+        _LU_EMISSION_TERM_ID,
+        _MG_EMISSION_TERM_ID,
+        measurements_required=False,  # Model can allocate zero emissions to LUC with enough landCover data
         measurement_method_ranking=_MEASUREMENT_METHOD_RANKING,
         get_valid_management_nodes_func=get_valid_management_nodes,
         summarise_land_use_func=summarise_land_cover_nodes,
         detect_land_use_change_func=detect_land_cover_change,
     )
 
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=_LU_EMISSION_TERM_ID,
-        management_change_emission_term_id=_MG_EMISSION_TERM_ID
-    )
-
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    for term_id in [_LU_EMISSION_TERM_ID, _MG_EMISSION_TERM_ID]:
-        logRequirements(cycle, model=MODEL, term=term_id, **logs)
-        logShouldRun(cycle, MODEL, term_id, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []

hestia_earth/models/ipcc2019/co2ToAirBelowGroundBiomassStockChange.py

@@ -1,6 +1,5 @@
 from hestia_earth.schema import EmissionMethodTier
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .biomass_utils import detect_land_cover_change, get_valid_management_nodes, summarise_land_cover_nodes
@@ -43,8 +42,10 @@ RETURNS = {
 }
 TERM_ID = 'co2ToAirBelowGroundBiomassStockChangeLandUseChange,co2ToAirBelowGroundBiomassStockChangeManagementChange'
 
-_LU_EMISSION_TERM_ID = "co2ToAirBelowGroundBiomassStockChangeLandUseChange"
-_MG_EMISSION_TERM_ID = "co2ToAirBelowGroundBiomassStockChangeManagementChange"
+_TERM_IDS = TERM_ID.split(",")
+
+_LU_EMISSION_TERM_ID = _TERM_IDS[0]
+_MG_EMISSION_TERM_ID = _TERM_IDS[1]
 
 _DEPTH_UPPER = 0
 _DEPTH_LOWER = 30
@@ -114,24 +115,18 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
+        _LU_EMISSION_TERM_ID,
+        _MG_EMISSION_TERM_ID,
         depth_upper=_DEPTH_UPPER,
         depth_lower=_DEPTH_LOWER,
-        measurements_mandatory=False,  # Model can allocate zero emissions to LUC with enough landCover data
+        measurements_required=False,  # Model can allocate zero emissions to LUC with enough landCover data
         get_valid_management_nodes_func=get_valid_management_nodes,
         summarise_land_use_func=summarise_land_cover_nodes,
-        detect_land_use_change_func=detect_land_cover_change
-    )
-
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=_LU_EMISSION_TERM_ID,
-        management_change_emission_term_id=_MG_EMISSION_TERM_ID
+        detect_land_use_change_func=detect_land_cover_change,
     )
 
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    for term_id in [_LU_EMISSION_TERM_ID, _MG_EMISSION_TERM_ID]:
-        logRequirements(cycle, model=MODEL, term=term_id, **logs)
-        logShouldRun(cycle, MODEL, term_id, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []

hestia_earth/models/ipcc2019/co2ToAirBiocharStockChange.py

@@ -1,7 +1,6 @@
 from hestia_earth.schema import EmissionMethodTier
 from hestia_earth.utils.date import YEAR
 
-from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.emission import _new_emission
 
 from .co2ToAirCarbonStockChange_utils import create_run_function, create_should_run_function
@@ -116,25 +115,16 @@ def run(cycle: dict) -> list[dict]:
     """
     should_run_exec = create_should_run_function(
         _CARBON_STOCK_TERM_ID,
+        land_use_change_emission_term_id=None,  # All emissions allocated to management change
+        management_change_emission_term_id=TERM_ID,
         depth_upper=_DEPTH_UPPER,
         depth_lower=_DEPTH_LOWER,
-        transition_period=_TRANSITION_PERIOD_DAYS
+        transition_period=_TRANSITION_PERIOD_DAYS,
+        exclude_from_logs=_EXCLUDE_FROM_LOGS
     )
 
-    run_exec = create_run_function(
-        new_emission_func=_emission,
-        land_use_change_emission_term_id=None,  # All emissions allocated to management change
-        management_change_emission_term_id=TERM_ID
-    )
+    run_exec = create_run_function(new_emission_func=_emission)
 
-    should_run, cycle_id, inventory, logs = should_run_exec(cycle)
-
-    logRequirements(
-        cycle,
-        model=MODEL,
-        term=TERM_ID,
-        **{k: v for k, v in logs.items() if k not in _EXCLUDE_FROM_LOGS}
-    )
-    logShouldRun(cycle, MODEL, TERM_ID, should_run)
+    should_run, assigned_emissions = should_run_exec(cycle)
 
-    return run_exec(cycle_id, inventory) if should_run else []
+    return run_exec(assigned_emissions) if should_run else []