hestia-earth-models 0.64.9__py3-none-any.whl → 0.64.10__py3-none-any.whl

hestia_earth/models/ipcc2019/aboveGroundBiomass_utils.py

@@ -1,180 +0,0 @@
-from enum import Enum
-from numpy import random
-from numpy.typing import NDArray
-from typing import Callable, Optional, Union
-
-from hestia_earth.models.utils.array_builders import repeat_single, truncated_normal_1d
-from hestia_earth.models.utils.ecoClimateZone import EcoClimateZone, get_ecoClimateZone_lookup_grouped_value
-
-
-class BiomassCategory(Enum):
-    """
-    Enum representing biomass categories, sourced from IPCC (2006), IPCC (2019) and European Commission (2010).
-
-    Enum values formatted for logging as table.
-    """
-    ANNUAL_CROPS = "annual-crops"
-    COCONUT = "coconut"                                             # European Commission (2010)
-    FOREST = "forest"                                               # IPCC (2019) recalculated per eco-climate zone
-    GRASSLAND = "grassland"
-    JATROPHA = "jatropha"                                           # European Commission (2010)
-    JOJOBA = "jojoba"                                               # European Commission (2010)
-    NATURAL_FOREST = "natural-forest"                               # IPCC (2019) recalculated per eco-climate zone
-    OIL_PALM = "oil palm"                                           # IPCC (2019)
-    OLIVE = "olive"                                                 # IPCC (2019)
-    ORCHARD = "orchard"                                             # IPCC (2019)
-    OTHER = "other"
-    PLANTATION_FOREST = "plantation-forest"                         # IPCC (2019) recalculated per eco-climate zone
-    RUBBER = "rubber"                                               # IPCC (2019)
-    SHORT_ROTATION_COPPICE = "short-rotation-coppice"               # IPCC (2019)
-    TEA = "tea"                                                     # IPCC (2019)
-    VINE = "vine"                                                   # IPCC (2019)
-    WOODY_PERENNIAL = "woody-perennial"                             # IPCC (2006)
-
-
-BIOMASS_CATEGORY_TO_LAND_COVER_LOOKUP_VALUE = {
-    BiomassCategory.ANNUAL_CROPS: "Annual crops",
-    BiomassCategory.COCONUT: "Coconut",
-    BiomassCategory.FOREST: "Forest",
-    BiomassCategory.GRASSLAND: "Grassland",
-    BiomassCategory.JATROPHA: "Jatropha",
-    BiomassCategory.JOJOBA: "Jojoba",
-    BiomassCategory.NATURAL_FOREST: "Natural forest",
-    BiomassCategory.OIL_PALM: "Oil palm",
-    BiomassCategory.OLIVE: "Olive",
-    BiomassCategory.ORCHARD: "Orchard",
-    BiomassCategory.OTHER: "Other",
-    BiomassCategory.PLANTATION_FOREST: "Plantation forest",
-    BiomassCategory.RUBBER: "Rubber",
-    BiomassCategory.SHORT_ROTATION_COPPICE: "Short rotation coppice",
-    BiomassCategory.TEA: "Tea",
-    BiomassCategory.VINE: "Vine",
-    BiomassCategory.WOODY_PERENNIAL: "Woody perennial"
-}
-
-
-def assign_biomass_category(lookup_value: str) -> BiomassCategory:
-    """
-    Return the `BiomassCategory` enum member associated with the input lookup value. If lookup value is missing or
-    doesn't map to any category, return `None`.
-    """
-    return next(
-        (key for key, value in BIOMASS_CATEGORY_TO_LAND_COVER_LOOKUP_VALUE.items() if value == lookup_value),
-        None
-    )
-
-
-def sample_biomass_equilibrium(
-    iterations: int,
-    biomass_category: BiomassCategory,
-    eco_climate_zone: EcoClimateZone,
-    seed: Union[int, random.Generator, None] = None
-) -> dict:
-    """
-    Sample a biomass equilibrium using the function specified in `KWARGS_TO_SAMPLE_FUNC`.
-
-    Parameters
-    ----------
-    iterations : int
-        The number of samples to take.
-    biomass_category : BiomassCategory
-        The biomass category of the land cover.
-    eco_climate_zone : EcoClimateZone
-        The eco-climate zone of the site.
-    seed : int | Generator | None, optional
-        A seed to initialize the BitGenerator. If passed a Generator, it will be returned unaltered. If `None`, then
-        fresh, unpredictable entropy will be pulled from the OS.
-
-    Returns
-    -------
-    NDArray
-        The sampled parameter as a numpy array with shape `(1, iterations)`.
-    """
-    kwargs = _get_biomass_equilibrium(biomass_category, eco_climate_zone)
-    func = _get_sample_func(kwargs)
-    return func(iterations=iterations, seed=seed, **kwargs)
-
-
-def _get_biomass_equilibrium(biomass_category: BiomassCategory, eco_climate_zone: EcoClimateZone) -> dict:
-    """
-    Retrieve the biomass equilibrium data for a specific combination of biomass category and eco-climate zone.
-
-    Parameters
-    ----------
-    biomass_category : BiomassCategory
-        The biomass category of the land cover.
-    eco_climate_zone : EcoClimateZone
-        The eco-climate zone of the site.
-
-    Returns
-    -------
-    dict
-        The biomass equilibrium data.
-    """
-    return get_ecoClimateZone_lookup_grouped_value(
-        eco_climate_zone.value,
-        _build_col_name(biomass_category),
-        default={"value": 0}
-    )
-
-
-def _build_col_name(biomass_category: BiomassCategory) -> str:
-    """
-    Get the column name for the `ecoClimateZone-lookup.csv` for a specific biomass category equilibrium.
-    """
-    COL_NAME_ROOT = "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_"
-    return (
-        f"{COL_NAME_ROOT}{biomass_category.name}" if isinstance(biomass_category, BiomassCategory)
-        else f"{COL_NAME_ROOT}OTHER"
-    )
-
-
-def _get_sample_func(kwargs: dict) -> Callable:
-    """
-    Select the correct sample function for a parameter based on the distribution data available. All possible
-    parameters for the model should have, at a minimum, a `value`, meaning that no default function needs to be
-    specified.
-
-    This function has been extracted into it's own method to allow for mocking of sample function.
-
-    Keyword Args
-    ------------
-    value : float
-        The distribution mean.
-    sd : float
-        The standard deviation of the distribution.
-    uncertainty : float
-        The +/- uncertainty of the 95% confidence interval expressed as a percentage of the mean.
-    error : float
-        Two standard deviations expressed as a percentage of the mean.
-
-    Returns
-    -------
-    Callable
-        The sample function for the distribution.
-    """
-    return next(
-        sample_func for required_kwargs, sample_func in _KWARGS_TO_SAMPLE_FUNC.items()
-        if all(kwarg in kwargs.keys() for kwarg in required_kwargs)
-    )
-
-
-def sample_plus_minus_error(
-    *, iterations: int, value: float, error: float, seed: Optional[int] = None, **_
-) -> NDArray:
-    """Randomly sample a model parameter with a truncated normal distribution described using plus/minus error."""
-    sd = value * (error / 200)
-    low = value - (value * (error / 100))
-    high = value + (value * (error / 100))
-    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sd, low=low, high=high, seed=seed)
-
-
-def sample_constant(*, iterations: int, value: float, **_) -> NDArray:
-    """Sample a constant model parameter."""
-    return repeat_single(shape=(1, iterations), value=value)
-
-
-_KWARGS_TO_SAMPLE_FUNC = {
-    ("value", "error"): sample_plus_minus_error,
-    ("value",): sample_constant
-}

tests/models/ipcc2019/test_aboveGroundBiomass_utils.py

@@ -1,92 +0,0 @@
-from pytest import mark
-
-from itertools import product
-from hestia_earth.models.ipcc2019.aboveGroundBiomass_utils import (
-    _build_col_name, _get_sample_func, assign_biomass_category, BiomassCategory, EcoClimateZone,
-    sample_biomass_equilibrium, sample_constant, sample_plus_minus_error
-)
-
-_ITERATIONS = 1000
-
-
-# kwargs, sample_func, expected_shape
-PARAMS_GET_SAMPLE_FUNC = [
-    ({"value": 1}, sample_constant),
-    ({"value": 1, "error": 10}, sample_plus_minus_error),
-]
-IDS_GET_SAMPLE_FUNC = ["constant", "+/- error"]
-
-
-@mark.parametrize("kwargs, sample_func", PARAMS_GET_SAMPLE_FUNC, ids=IDS_GET_SAMPLE_FUNC)
-def test_get_sample_func(kwargs, sample_func):
-    result = _get_sample_func(kwargs)
-    assert result == sample_func
-
-
-PARAMS_BIOMASS = [p for p in product(BiomassCategory, EcoClimateZone)]
-IDS_BIOMASS = [f"{p[0].name} + {p[1].name}" for p in PARAMS_BIOMASS]
-
-
-@mark.parametrize("biomass_category, eco_climate_zone", PARAMS_BIOMASS, ids=IDS_BIOMASS)
-def test_sample_biomass_equilibrium(biomass_category, eco_climate_zone):
-    EXPECTED_SHAPE = (1, _ITERATIONS)
-    result = sample_biomass_equilibrium(_ITERATIONS, biomass_category, eco_climate_zone)
-    assert result.shape == EXPECTED_SHAPE
-
-
-# input, expected
-PARAMS_ASSIGN_BIOMASS_CATEGORY = [
-    ("Annual crops", BiomassCategory.ANNUAL_CROPS),
-    ("Coconut", BiomassCategory.COCONUT),
-    ("Forest", BiomassCategory.FOREST),
-    ("Grassland", BiomassCategory.GRASSLAND),
-    ("Jatropha", BiomassCategory.JATROPHA),
-    ("Jojoba", BiomassCategory.JOJOBA),
-    ("Natural forest", BiomassCategory.NATURAL_FOREST),
-    ("Oil palm", BiomassCategory.OIL_PALM),
-    ("Olive", BiomassCategory.OLIVE),
-    ("Orchard", BiomassCategory.ORCHARD),
-    ("Other", BiomassCategory.OTHER),
-    ("Plantation forest", BiomassCategory.PLANTATION_FOREST),
-    ("Rubber", BiomassCategory.RUBBER),
-    ("Short rotation coppice", BiomassCategory.SHORT_ROTATION_COPPICE),
-    ("Tea", BiomassCategory.TEA),
-    ("Vine", BiomassCategory.VINE),
-    ("Woody perennial", BiomassCategory.WOODY_PERENNIAL),
-    ("Miscellaneous value", None)
-]
-IDS_ASSIGN_BIOMASS_CATEGORY = [p[0] for p in PARAMS_ASSIGN_BIOMASS_CATEGORY]
-
-
-@mark.parametrize("input, expected", PARAMS_ASSIGN_BIOMASS_CATEGORY, ids=IDS_ASSIGN_BIOMASS_CATEGORY)
-def test_assign_biomass_category(input: str, expected: BiomassCategory):
-    assert assign_biomass_category(input) == expected
-
-
-# input, expected
-PARAMS_BUILD_COLUMN_NAME = [
-    (BiomassCategory.ANNUAL_CROPS, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_ANNUAL_CROPS"),
-    (BiomassCategory.COCONUT, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_COCONUT"),
-    (BiomassCategory.FOREST, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_FOREST"),
-    (BiomassCategory.GRASSLAND, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_GRASSLAND"),
-    (BiomassCategory.JATROPHA, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_JATROPHA"),
-    (BiomassCategory.JOJOBA, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_JOJOBA"),
-    (BiomassCategory.NATURAL_FOREST, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_NATURAL_FOREST"),
-    (BiomassCategory.OIL_PALM, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_OIL_PALM"),
-    (BiomassCategory.OLIVE, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_OLIVE"),
-    (BiomassCategory.ORCHARD, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_ORCHARD"),
-    (BiomassCategory.OTHER, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_OTHER"),
-    (BiomassCategory.PLANTATION_FOREST, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_PLANTATION_FOREST"),
-    (BiomassCategory.RUBBER, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_RUBBER"),
-    (BiomassCategory.SHORT_ROTATION_COPPICE, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_SHORT_ROTATION_COPPICE"),
-    (BiomassCategory.TEA, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_TEA"),
-    (BiomassCategory.VINE, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_VINE"),
-    (BiomassCategory.WOODY_PERENNIAL, "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_WOODY_PERENNIAL"),
-    ("Miscellaneous value", "AG_BIOMASS_EQUILIBRIUM_KG_C_HECTARE_OTHER")
-]
-IDS_BUILD_COLUMN_NAME = [p[0] for p in PARAMS_BUILD_COLUMN_NAME]
-
-
-@mark.parametrize("input, expected", PARAMS_BUILD_COLUMN_NAME, ids=IDS_BUILD_COLUMN_NAME)
-def test_build_col_name(input: BiomassCategory, expected: str):
-    assert _build_col_name(input) == expected