hestia-earth-models 0.70.0__py3-none-any.whl → 0.70.1__py3-none-any.whl

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_1.py

@@ -31,6 +31,77 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
+REQUIREMENTS = {
+    "Site": {
+        "management": [
+            {"@type": "Management", "value": "", "term.termType": "landCover"}
+        ],
+        "measurements": [
+            {
+                "@type": "Measurement",
+                "value": ["1", "2", "3", "4", "7", "8", "9", "10", "11", "12"],
+                "term.@id": "ecoClimateZone"
+            }
+        ],
+        "optional": {
+            "measurements": [
+                {"@type": "Measurement", "value": "", "term.termType": ["soilType", "usdaSoilType"]}
+            ],
+            "management": [
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "cropResidueManagement",
+                    "name": ["burnt", "removed"]
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "landUseManagement"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.termType": "tillage"},
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.termType": "waterRegime",
+                    "name": ["deep water", "irrigated"]
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "amendmentIncreasingSoilCarbonUsed"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.@id": "animalManureUsed"},
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "inorganicNitrogenFertiliserUsed"
+                },
+                {
+                    "@type": "Management",
+                    "value": "",
+                    "startDate": "",
+                    "endDate": "",
+                    "term.@id": "organicFertiliserUsed"
+                },
+                {"@type": "Management", "value": "", "startDate": "", "endDate": "", "term.@id": "shortBareFallow"}
+            ]
+        },
+        "none": {
+            "siteType": ["glass or high accessible cover"]
+        }
+    }
+}
 LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": [
@@ -43,6 +114,20 @@ LOOKUPS = {
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY",
     "usdaSoilType": "IPCC_SOIL_CATEGORY"
 }
+RETURNS = {
+    "Measurement": [{
+        "value": "",
+        "sd": "",
+        "min": "",
+        "max": "",
+        "statsDefinition": "simulated",
+        "observations": "",
+        "dates": "",
+        "depthUpper": "0",
+        "depthLower": "30",
+        "methodClassification": "tier 1 model"
+    }]
+}
 
 TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_1_MODEL.value
@@ -108,7 +193,7 @@ def _measurement(
     dict
         A valid HESTIA `Measurement` node, see: https://www.hestia.earth/schema/Measurement.
     """
-    measurement = _new_measurement(TERM_ID) | descriptive_stats_dict
+    measurement = _new_measurement(TERM_ID, MODEL) | descriptive_stats_dict
     measurement["dates"] = [f"{year}-12-31" for year in timestamps]
     measurement["depthUpper"] = DEPTH_UPPER
     measurement["depthLower"] = DEPTH_LOWER

hestia_earth/models/ipcc2019/organicCarbonPerHa_tier_2.py

@@ -33,11 +33,137 @@ from .organicCarbonPerHa_utils import (
 )
 from . import MODEL
 
+REQUIREMENTS = {
+    "Site": {
+        "siteType": "cropland",
+        "measurements": [
+            {
+                "@type": "Measurement",
+                "term.@id": "sandContent",
+                "value": "",
+                "depthUpper": "0",
+                "depthLower": "30",
+                "optional": {
+                    "dates": ""
+                }
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "temperatureMonthly",
+                "value": "",
+                "dates": ""
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "precipitationMonthly",
+                "value": "",
+                "dates": ""
+            },
+            {
+                "@type": "Measurement",
+                "term.@id": "potentialEvapotranspirationMonthly",
+                "value": "",
+                "dates": ""
+            }
+        ],
+        "related": {
+            "Cycle": [{
+                "endDate": "",
+                "products": [
+                    {
+                        "@type": "Product",
+                        "term.@id": [
+                            "aboveGroundCropResidueLeftOnField",
+                            "aboveGroundCropResidueIncorporated",
+                            "belowGroundCropResidue",
+                            "discardedCropLeftOnField",
+                            "discardedCropIncorporated"
+                        ],
+                        "value": "",
+                        "properties": [
+                            {
+                                "@type": "Property",
+                                "term.@id": "carbonContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "nitrogenContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "ligninContent",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ],
+                "inputs": [
+                    {
+                        "@type": "Input",
+                        "term.termType": ["organicFertiliser", "soilAmendment"],
+                        "value": "",
+                        "properties": [
+                            {
+                                "@type": "Property",
+                                "term.@id": "carbonContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "nitrogenContent",
+                                "value": ""
+                            },
+                            {
+                                "@type": "Property",
+                                "term.@id": "ligninContent",
+                                "value": ""
+                            }
+                        ]
+                    }
+                ],
+                "practices": [
+                    {
+                        "@type": "Practice",
+                        "term.termType": "tillage",
+                        "value": ""
+                    },
+                    {
+                        "@type": "Practice",
+                        "term.termType": "waterRegime",
+                        "name": "irrigated",
+                        "value": "",
+                        "startDate": "",
+                        "endDate": ""
+                    }
+                ],
+                "optional": {
+                    "startDate": ""
+                }
+            }]
+        }
+    }
+}
 LOOKUPS = {
     "crop": "IPCC_LAND_USE_CATEGORY",
     "landCover": "IPCC_LAND_USE_CATEGORY",
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY"
 }
+RETURNS = {
+    "Measurement": [{
+        "value": "",
+        "sd": "",
+        "min": "",
+        "max": "",
+        "statsDefinition": "simulated",
+        "observations": "",
+        "dates": "",
+        "depthUpper": "0",
+        "depthLower": "30",
+        "methodClassification": "tier 2 model"
+    }]
+}
 
 TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_2_MODEL.value
@@ -124,7 +250,7 @@ def _measurement(
     dict
         A valid HESTIA `Measurement` node, see: https://www.hestia.earth/schema/Measurement.
     """
-    measurement = _new_measurement(TERM_ID) | descriptive_stats_dict
+    measurement = _new_measurement(TERM_ID, MODEL) | descriptive_stats_dict
     measurement["dates"] = [f"{year}-12-31" for year in timestamps]
     measurement["depthUpper"] = DEPTH_UPPER
     measurement["depthLower"] = DEPTH_LOWER

hestia_earth/models/ipcc2019/organicCarbonPerHa_utils.py

@@ -1,13 +1,15 @@
 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.models.utils.array_builders import (
-    repeat_single, plus_minus_uncertainty_to_normal_1d, truncated_normal_1d
+    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
@@ -238,7 +240,9 @@ def sample_plus_minus_uncertainty(
     *, iterations: int, value: float, uncertainty: float, seed: Optional[int] = None, **_
 ) -> NDArray:
     """Randomly sample a model parameter with a plus/minus uncertainty distribution."""
-    return plus_minus_uncertainty_to_normal_1d(shape=(1, iterations), value=value, uncertainty=uncertainty, seed=seed)
+    n_sds = calc_z_critical(95)
+    sigma = (value * (uncertainty / 100)) / n_sds
+    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sigma, low=0, high=inf, seed=seed)
 
 
 def sample_plus_minus_error(
@@ -246,9 +250,7 @@ def sample_plus_minus_error(
 ) -> 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)
+    return truncated_normal_1d(shape=(1, iterations), mu=value, sigma=sd, low=0, high=inf, seed=seed)
 
 
 def sample_constant(*, iterations: int, value: float, **_) -> NDArray: