hestia-earth-models 0.68.1__py3-none-any.whl → 0.69.1__py3-none-any.whl

hestia_earth/models/hestia/nh3ToSurfaceWaterAquacultureSystems.py

@@ -0,0 +1,64 @@
+from hestia_earth.schema import TermTermType, EmissionMethodTier
+from hestia_earth.models.utils.emission import _new_emission
+from hestia_earth.utils.model import filter_list_term_type
+from hestia_earth.models.utils.aquacultureManagement import valid_site_type
+from hestia_earth.models.utils.input import total_excreta_tan
+from . import MODEL
+
+
+REQUIREMENTS = {
+    "Cycle": {
+        "products": [{
+            "@type": "Product",
+            "term.termType": "excreta",
+            "term.@id": "excretaLiquidFishCrustaceansKgN"
+        }]
+    }
+}
+
+RETURNS = {
+    "Emission": [{
+        "value": "",
+        "methodTier": "tier 1"
+    }]
+}
+
+TIER = EmissionMethodTier.TIER_1.value
+TERM_ID = 'nh3ToSurfaceWaterAquacultureSystems'
+_EXCRETA_TERM_ID = 'excretaLiquidFishCrustaceansKgN'
+
+
+def _emission(value: float):
+    emission = _new_emission(TERM_ID, MODEL)
+    emission['value'] = [round(value, 7)]
+    emission['methodTier'] = TIER
+    return emission
+
+
+def _run(excreta_products: list):
+    value = total_excreta_tan(excreta_products)
+    return [_emission(value)]
+
+
+def _valid_excreta(cycle: dict):
+    excreta_products = filter_list_term_type(cycle.get('products', []), TermTermType.EXCRETA.value)
+    valid_excreta_products = [
+        product for product in excreta_products if all([
+            product.get('term', {}).get('@id') == _EXCRETA_TERM_ID
+        ])
+    ]
+    return valid_excreta_products
+
+
+def _should_run(cycle: dict):
+    valid_excreta_products = _valid_excreta(cycle)
+    should_run = all([
+        valid_site_type(cycle),
+        bool(valid_excreta_products),
+    ])
+    return should_run, valid_excreta_products
+
+
+def run(cycle: dict):
+    should_run, valid_excreta_products = _should_run(cycle)
+    return _run(valid_excreta_products) if should_run else []

hestia_earth/models/hestia/residueRemoved.py

@@ -1,7 +1,3 @@
-"""
-This model will gap-fill the value for `residueRemoved` when the only provided data is the incorporated residue.
-We are assuming that anything that was not incorporated must have been removed.
-"""
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.tools import list_sum

hestia_earth/models/hestia/resourceUse_utils.py

@@ -1,8 +1,3 @@
-"""
-Resource Use
-
-Provides common code for land transformation models.
-"""
 from datetime import datetime
 from dateutil.relativedelta import relativedelta
 from hestia_earth.schema import TermTermType

hestia_earth/models/hestia/seed_emissions.py

@@ -1,16 +1,3 @@
-"""
-Seed Emissions
-
-This model uses the `emissions` recalculated from the current `Cycle` to estimate the `emissions` associated with
-producing the `Input` with `termType` = `seed`.
-
-These are the steps:
-
-1. Recalculate all emissions for the Cycle of interest;
-2. Group Cycle emissions based on their `inputProductionGroupId` lookup value and sum them up;
-3. Divide the sum of each emission group by the average crop yield (from FAOSTAT) to get emissions per kg of product;
-4. Multiply by `seed.value` to get total background `emissions` from seed production per ha.
-"""
 from functools import reduce
 from hestia_earth.schema import TermTermType, EmissionMethodTier, SiteSiteType
 from hestia_earth.utils.lookup import (

hestia_earth/models/impact_assessment/allocationMethod.py

@@ -1,9 +1,3 @@
-"""
-Allocation Method
-
-If any of the impact `emissionsResourceUse`, `impacts`, or `endpoints`, have been modified by the calculations,
-the `allocationMethod` will be set to `economic`.
-"""
 from hestia_earth.schema import ImpactAssessmentAllocationMethod
 
 from hestia_earth.models.log import logShouldRun, logRequirements

hestia_earth/models/impact_assessment/emissions.py

@@ -1,12 +1,3 @@
-"""
-Emissions
-
-Creates an [Indicator](https://hestia.earth/schema/Indicator) for every [Emission](https://hestia.earth/schema/Emission)
-contained within the [ImpactAssesment.cycle](https://hestia.earth/schema/ImpactAssessment#cycle).
-It does this by dividing the Emission amount by the Product amount, and applying an allocation between co-products.
-Note: for any Emission in the system boundary that does not exist in the Cycle, it will log the model as failed,
-so that we know the Emission is missing.
-"""
 from hestia_earth.utils.tools import list_sum
 from hestia_earth.utils.emission import cycle_emissions_in_system_boundary
 

hestia_earth/models/impact_assessment/irrigated.py

@@ -1,8 +1,3 @@
-"""
-Irrigated
-
-Detects if the [Cycle](https://hestia.earth/schema/ImpactAssessment#cycle) was irrigated.
-"""
 from hestia_earth.models.log import logger
 from hestia_earth.models.utils.cycle import is_irrigated
 from . import MODEL

hestia_earth/models/impact_assessment/organic.py

@@ -1,8 +1,3 @@
-"""
-Organic
-
-Detects if the [Cycle](https://hestia.earth/schema/ImpactAssessment#cycle) has an organic label.
-"""
 from hestia_earth.models.log import logger
 from hestia_earth.models.utils.cycle import is_organic
 from . import MODEL

hestia_earth/models/impact_assessment/post_checks/cycle.py

@@ -1,10 +1,3 @@
-"""
-Post Checks Cycle
-
-This model is run only if the [pre model](../pre_checks/cycle.md) has been run before.
-This model will restore the `impactAssessment.cycle` as a "linked node"
-(i.e. it will be set with only `@type`, `@id` and `name` keys).
-"""
 from hestia_earth.utils.model import linked_node
 
 REQUIREMENTS = {

hestia_earth/models/impact_assessment/post_checks/site.py

@@ -1,10 +1,3 @@
-"""
-Post Checks Site
-
-This model is run only if the [pre model](../pre_checks/site.md) has been run before.
-This model will restore the `impactAssessment.site` as a "linked node"
-(i.e. it will be set with only `@type`, `@id` and `name` keys).
-"""
 from hestia_earth.utils.model import linked_node
 
 REQUIREMENTS = {

hestia_earth/models/impact_assessment/pre_checks/cycle.py

@@ -1,9 +1,3 @@
-"""
-Pre Checks Cycle
-
-Some ImpactAssessment models need a full version of the linked [Cycle](https://hestia.earth/schema/Cycle) to run.
-This model will fetch the complete version of the [Cycle](https://hestia.earth/schema/Cycle) and include it.
-"""
 from hestia_earth.schema import SchemaType
 
 from hestia_earth.models.utils import _load_calculated_node

hestia_earth/models/impact_assessment/pre_checks/site.py

@@ -1,9 +1,3 @@
-"""
-Pre Checks Site
-
-Some ImpactAssessment 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.
-"""
 from hestia_earth.schema import SchemaType
 
 from hestia_earth.models.utils import _load_calculated_node

hestia_earth/models/impact_assessment/product/economicValueShare.py

@@ -1,9 +1,3 @@
-"""
-Product Economic Value Share
-
-Returns the [economicValueShare](https://hestia.earth/schema/Product#economicValueShare) of the Product
-linked to the Cycle.
-"""
 from hestia_earth.models.log import logShouldRun
 from hestia_earth.models.utils.product import find_by_product
 from .. import MODEL

hestia_earth/models/impact_assessment/product/value.py

@@ -1,8 +1,3 @@
-"""
-Product Value
-
-Returns the [value](https://hestia.earth/schema/Product#value) of the Product linked to the Cycle.
-"""
 from hestia_earth.models.log import logShouldRun
 from hestia_earth.models.utils.product import find_by_product
 from .. import MODEL

hestia_earth/models/ipcc2019/aboveGroundBiomass.py

@@ -18,6 +18,7 @@ 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
 
 from . import MODEL
@@ -87,6 +88,11 @@ RETURNS = {
     }]
 }
 TERM_ID = 'aboveGroundBiomass'
+BIBLIO_TITLE = '2019 Refinement to the 2006 IPCC Guidelines for National Greenhouse Gas Inventories'
+OTHER_BIBLIO_TITLES = [
+    '2006 IPCC Guidelines for National Greenhouse Gas Inventories',
+    'COMMISSION DECISION of 10 June 2010 on guidelines for the calculation of land carbon stocks for the purpose of Annex V to Directive 2009/28/EC'  # noqa: E501
+]
 
 _ITERATIONS = 10000
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_1_MODEL.value
@@ -131,7 +137,7 @@ def run(site: dict) -> list[dict]:
         `aboveGroundBiomass`
     """
     should_run, inventory, kwargs = _should_run(site)
-    return _run(inventory, iterations=_ITERATIONS, **kwargs) if should_run else []
+    return _run(site, inventory, iterations=_ITERATIONS, **kwargs) if should_run else []
 
 
 def _should_run(site: dict) -> tuple[bool, dict, dict]:
@@ -407,6 +413,7 @@ the `dict` keys.
 
 
 def _run(
+    site: dict,
     inventory: dict,
     *,
     eco_climate_zone: EcoClimateZone,
@@ -501,7 +508,7 @@ def _run(
         axis=1,     # Calculate stats rowwise.
         decimals=6  # Round values to the nearest milligram.
     )
-    return [_measurement(timestamps, **descriptive_stats)]
+    return [_measurement(timestamps, **descriptive_stats) | get_source(site, BIBLIO_TITLE, OTHER_BIBLIO_TITLES)]
 
 
 def _build_col_name(biomass_category: BiomassCategory) -> str:

hestia_earth/models/ipcc2019/animal/milkYieldPerAnimal.py

@@ -1,9 +1,3 @@
-"""
-Milk Yield Per Animal
-
-This model gap-fills the practice "Milk yield per X, raw" for live animals added to the animal node,
-taking values from a lookup file.
-"""
 from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.blank_node import merge_blank_nodes, get_lookup_value
 from hestia_earth.models.utils.practice import _new_practice

hestia_earth/models/ipcc2019/animal/pastureGrass.py

@@ -1,13 +1,3 @@
-"""
-Animal Pasture Grass
-
-This model estimates the energetic requirements of ruminants and can be used to estimate the amount of grass they graze.
-Source:
-[IPCC 2019, Vol.4, Chapter 10](https://www.ipcc-nggip.iges.or.jp/public/2019rf/pdf/4_Volume4/19R_V4_Ch10_Livestock.pdf).
-
-This version of the model will run at the Animal Blank Node level, if none of the Cycle Input are given as feed
-(see https://www.hestia.earth/schema/Input#isAnimalFeed).
-"""
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.tools import list_sum, non_empty_list

hestia_earth/models/ipcc2019/animal/weightAtMaturity.py

@@ -1,7 +1,3 @@
-"""
-Note: when the `liveweightPerHead` property is provided, this model will only work if the returned value is
-greater than or equal to `liveweightPerHead` value.
-"""
 from hestia_earth.utils.model import find_term_match
 
 from hestia_earth.models.log import logRequirements, logShouldRun

hestia_earth/models/ipcc2019/belowGroundBiomass.py

@@ -18,6 +18,7 @@ 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
 
 from . import MODEL
@@ -76,6 +77,11 @@ RETURNS = {
     }]
 }
 TERM_ID = 'belowGroundBiomass'
+BIBLIO_TITLE = '2019 Refinement to the 2006 IPCC Guidelines for National Greenhouse Gas Inventories'
+OTHER_BIBLIO_TITLES = [
+    '2006 IPCC Guidelines for National Greenhouse Gas Inventories',
+    'COMMISSION DECISION of 10 June 2010 on guidelines for the calculation of land carbon stocks for the purpose of Annex V to Directive 2009/28/EC'  # noqa: E501
+]
 
 _ITERATIONS = 10000
 _DEPTH_UPPER = 0
@@ -128,7 +134,7 @@ def run(site: dict) -> list[dict]:
         `aboveGroundBiomass`
     """
     should_run, inventory, kwargs = _should_run(site)
-    return _run(inventory, iterations=_ITERATIONS, **kwargs) if should_run else []
+    return _run(site, inventory, iterations=_ITERATIONS, **kwargs) if should_run else []
 
 
 def _should_run(site: dict) -> tuple[bool, dict, dict]:
@@ -394,6 +400,7 @@ the `dict` keys.
 
 
 def _run(
+    site: dict,
     inventory: dict,
     *,
     eco_climate_zone: EcoClimateZone,
@@ -484,7 +491,7 @@ def _run(
         axis=1,     # Calculate stats rowwise.
         decimals=6  # Round values to the nearest milligram.
     )
-    return [_measurement(timestamps, **descriptive_stats)]
+    return [_measurement(timestamps, **descriptive_stats) | get_source(site, BIBLIO_TITLE, OTHER_BIBLIO_TITLES)]
 
 
 def _build_col_name(biomass_category: BiomassCategory) -> str:

hestia_earth/models/ipcc2019/co2ToAirSoilOrganicCarbonStockChange.py

@@ -4,7 +4,7 @@ from hestia_earth.models.log import logRequirements, logShouldRun
 from hestia_earth.models.utils.blank_node import cumulative_nodes_term_match
 from hestia_earth.models.utils.emission import _new_emission
 
-from .organicCarbonPerHa_tier_1_utils import _assign_ipcc_land_use_category, get_valid_management_nodes
+from .organicCarbonPerHa_tier_1 import _assign_ipcc_land_use_category, get_valid_management_nodes
 from .co2ToAirCarbonStockChange_utils import create_run_function, create_should_run_function
 from . import MODEL
 

hestia_earth/models/ipcc2019/croppingDuration.py

@@ -1,8 +1,3 @@
-"""
-`croppingDuration` can be added by the uploader for all crops, however the model `IPCC (2019)` will only run for
-`riceGrainInHusk` or `ricePlantFlooded`.
-The model will only run for rice crops as this is the only crop which requires the value for emission recalculations.
-"""
 from hestia_earth.schema import PracticeStatsDefinition
 from hestia_earth.utils.tools import safe_parse_float
 

hestia_earth/models/ipcc2019/n2OToAirExcretaDirect.py

@@ -56,7 +56,7 @@ def _should_run(cycle: dict):
                     N2O_N_EF=N2O_N_EF,
                     term_type_excreta_complete=term_type_complete)
 
-    should_run = all([N_total, N2O_N_EF]) or all([not N_total, term_type_complete])
+    should_run = all([N_total is not None, N2O_N_EF is not None]) or all([not N_total, term_type_complete])
     logShouldRun(cycle, MODEL, TERM_ID, should_run, methodTier=TIER)
     return should_run, N_total, N2O_N_EF
 

hestia_earth/models/ipcc2019/no3ToGroundwaterExcreta.py

@@ -1,36 +1,47 @@
-from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, TermTermType
+from hestia_earth.schema import EmissionMethodTier, EmissionStatsDefinition, TermTermType, SiteSiteType
 
 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.cycle import get_excreta_N_total, get_ecoClimateZone
+from hestia_earth.models.utils.input import total_excreta
+from hestia_earth.models.utils.excretaManagement import get_excreta_inputs_with_factor
 from .utils import get_FracLEACH_H
 from . import MODEL
 
 REQUIREMENTS = {
     "Cycle": {
         "completeness.excreta": "True",
-        "completeness.water": "True",
         "inputs": [
             {
                 "@type": "Input",
                 "value": "",
                 "term.termType": "excreta",
-                "optional": {
-                    "properties": [{"@type": "Property", "value": "", "term.@id": "nitrogenContent"}]
-                }
+                "properties": [
+                    {"@type": "Property", "value": "", "term.@id": "nitrogenContent"},
+                    {"@type": "Property", "value": "", "term.@id": "totalAmmoniacalNitrogenContentAsN"}
+                ]
             }
         ],
         "site": {
             "@type": "Site",
-            "measurements": [{"@type": "Measurement", "value": "", "term.@id": "ecoClimateZone"}]
+            "optional": {
+                "measurements": [{"@type": "Measurement", "value": "", "term.@id": "ecoClimateZone"}]
+            }
         },
         "optional": {
-            "practices": [{"@type": "Practice", "value": "", "term.termType": "waterRegime"}]
+            "completeness.water": "True",
+            "practices": [
+                {"@type": "Practice", "value": "", "term.termType": "waterRegime"},
+                {"@type": "Practice", "value": "", "term.termType": "excretaManagement"}
+            ]
         }
     }
 }
+LOOKUPS = {
+    "excretaManagement-excreta-NO3_EF_2019": ""
+}
 RETURNS = {
     "Emission": [{
         "value": "",
@@ -45,12 +56,13 @@ TERM_ID = 'no3ToGroundwaterExcreta'
 TIER = EmissionMethodTier.TIER_1.value
 
 
-def _emission(value: float, sd: float, min: float, max: float):
+def _emission(value: float, sd: float = None, min: float = None, max: float = None):
     emission = _new_emission(TERM_ID, MODEL)
     emission['value'] = [value]
-    emission['sd'] = [sd]
-    emission['min'] = [min]
-    emission['max'] = [max]
+    if sd is not None:
+        emission['sd'] = [sd]
+        emission['min'] = [min]
+        emission['max'] = [max]
     emission['methodTier'] = TIER
     emission['statsDefinition'] = EmissionStatsDefinition.MODELLED.value
     return emission
@@ -68,21 +80,45 @@ def _run(cycle: dict):
     )]
 
 
+def _run_with_excreta_managemen(excreta_EF_input: float):
+    value = excreta_EF_input * get_atomic_conversion(Units.KG_NO3, Units.TO_N)
+    return [_emission(value)]
+
+
+def _should_run_with_excreta_management(cycle: dict):
+    site_type = cycle.get('site', {}).get('siteType')
+    return site_type not in [SiteSiteType.CROPLAND.value, SiteSiteType.PERMANENT_PASTURE.value]
+
+
 def _should_run(cycle: dict):
     N_excreta = get_excreta_N_total(cycle)
     ecoClimateZone = get_ecoClimateZone(cycle)
     excreta_complete = _is_term_type_complete(cycle, TermTermType.EXCRETA)
     water_complete = _is_term_type_complete(cycle, TermTermType.WATER)
 
+    use_excreta_management = _should_run_with_excreta_management(cycle)
+    excreta_EF_input = get_excreta_inputs_with_factor(
+        cycle, f"{list(LOOKUPS.keys())[0]}.csv", excreta_convertion_func=total_excreta, model=MODEL, term=TERM_ID
+    ) if use_excreta_management else None
+
     logRequirements(cycle, model=MODEL, term=TERM_ID,
                     N_excreta=N_excreta,
                     ecoClimateZone=ecoClimateZone,
                     term_type_excreta_complete=excreta_complete,
-                    term_type_water_complete=water_complete)
+                    term_type_water_complete=water_complete,
+                    excreta_EF_input=excreta_EF_input)
 
-    should_run = all([N_excreta is not None, ecoClimateZone, excreta_complete, water_complete])
+    should_run = excreta_complete and (
+        all([excreta_EF_input >= 0]) if use_excreta_management else
+        all([water_complete, N_excreta is not None, ecoClimateZone])
+    )
     logShouldRun(cycle, MODEL, TERM_ID, should_run)
-    return should_run
+    return should_run, excreta_EF_input
 
 
-def run(cycle: dict): return _run(cycle) if _should_run(cycle) else []
+def run(cycle: dict):
+    should_run, excreta_EF_input = _should_run(cycle)
+    return (
+        _run_with_excreta_managemen(excreta_EF_input) if _should_run_with_excreta_management(cycle) else
+        _run(cycle)
+    ) if should_run else []

hestia_earth/models/ipcc2019/nonCo2EmissionsToAirNaturalVegetationBurning.py

@@ -1,15 +1,3 @@
-"""
-Non-CO2 emissions, to air, natural vegetation burning
-
-This model returns the amounts of non-CO2 emissions from natural vegetation burning:
-1. [CH4, to air, natural vegetation burning](https://www.hestia.earth/term/ch4ToAirNaturalVegetationBurning);
-2. [CO, to air, natural vegetation burning](https://www.hestia.earth/term/coToAirNaturalVegetationBurning);
-3. [N2O, to air, natural vegetation burning](https://www.hestia.earth/term/n2OToAirNaturalVegetationBurningDirect);
-4. [NOx, to air, natural vegetation burning](https://www.hestia.earth/term/noxToAirNaturalVegetationBurning).
-
-For now, the V1 version of this model only calculates emissions from forests burning, as we have no reliable way of
-recording savannah grassland and woodland fire regimes using the HESTIA glossary.
-"""
 from enum import Enum
 from functools import lru_cache, reduce
 from itertools import product

hestia_earth/models/ipcc2019/organicCarbonPerHa.py

@@ -1,16 +1,3 @@
-"""
-The IPCC model for estimating soil organic carbon stock changes in the 0 - 30cm depth interval due to management
-changes. This model will attempt to run the Tier 2 methodology and return results. If the Tier 2 methodology cannot be
-run, it will attempt to run the Tier 1 methodology and return the results.
-
-Both tier methodologies are run as Monte Carlo simulations with 10000 iterations, allowing the model to calculate a
-`value` (mean), `sd`, `min`, `max` for each year of the model result.
-
-The requirements in this file are for the Tier 1 methodology only, as it has simpler requirements. The requirements for
-the Tier 2 methodology can be found in the
-[HESTIA SOC wiki](https://gitlab.com/hestia-earth/hestia-engine-models/-/wikis/Soil-organic-carbon-modelling)
-alongside data recommendations, examples and explanations for both tiers.
-"""
 from functools import reduce
 from pydash.objects import merge
 from types import ModuleType
@@ -18,8 +5,8 @@ from types import ModuleType
 from hestia_earth.models.log import log_as_table, logRequirements, logShouldRun
 
 from .organicCarbonPerHa_utils import format_bool, format_bool_list, format_enum, format_number, format_number_list
-from . import organicCarbonPerHa_tier_1_utils as tier_1
-from . import organicCarbonPerHa_tier_2_utils as tier_2
+from . import organicCarbonPerHa_tier_1 as tier_1
+from . import organicCarbonPerHa_tier_2 as tier_2
 from . import MODEL  # noqa
 
 REQUIREMENTS = {

hestia_earth/models/ipcc2019/{organicCarbonPerHa_tier_1_utils.py → organicCarbonPerHa_tier_1.py}

@@ -1,15 +1,3 @@
-"""
-The IPCC Tier 1 methodology for estimating soil organic carbon stock changes in the 0 - 30cm depth interval due to
-management changes.
-
-The model cannot not run on Sites with polar moist (ecoClimateZone 5) or polar dry (ecoClimateZone 6).
-
-More information on this model, including data requirements **and** recommendations, and examples can be found in the
-[HESTIA SOC wiki](https://gitlab.com/hestia-earth/hestia-engine-models/-/wikis/Soil-organic-carbon-modelling).
-
-Source: [IPCC 2019, Vol. 4, Chapter 2](https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html).
-"""
-
 from enum import Enum
 from functools import reduce
 from numpy import empty_like, random, vstack
@@ -56,7 +44,7 @@ _LOOKUPS = {
     "usdaSoilType": "IPCC_SOIL_CATEGORY"
 }
 
-_TERM_ID = 'organicCarbonPerHa'
+TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_1_MODEL.value
 
 _CLAY_CONTENT_TERM_ID = "clayContent"
@@ -120,7 +108,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) | descriptive_stats_dict
     measurement["dates"] = [f"{year}-12-31" for year in timestamps]
     measurement["depthUpper"] = DEPTH_UPPER
     measurement["depthLower"] = DEPTH_LOWER
@@ -556,7 +544,7 @@ def should_run(site: dict) -> tuple[bool, dict, dict]:
     )
 
     kwargs = {
-        "seed": gen_seed(site, MODEL, _TERM_ID),
+        "seed": gen_seed(site, MODEL, TERM_ID),
         "eco_climate_zone": eco_climate_zone,
         "ipcc_soil_category": ipcc_soil_category,
     }

hestia_earth/models/ipcc2019/{organicCarbonPerHa_tier_2_utils.py → organicCarbonPerHa_tier_2.py}

@@ -1,13 +1,3 @@
-"""
-The IPCC Tier 2 methodology for estimating soil organic carbon stock changes in the 0 - 30cm depth interval due to
-management changes.
-
-More information on this model, including data requirements **and** recommendations, and examples can be found in the
-[HESTIA SOC wiki](https://gitlab.com/hestia-earth/hestia-engine-models/-/wikis/Soil-organic-carbon-modelling).
-
-Source: [IPCC 2019, Vol. 4, Chapter 5](https://www.ipcc-nggip.iges.or.jp/public/2019rf/vol4.html).
-"""
-
 from enum import Enum
 from numpy import array, empty, exp, minimum, random, where, vstack
 from numpy.typing import NDArray
@@ -49,7 +39,7 @@ _LOOKUPS = {
     "tillage": "IPCC_TILLAGE_MANAGEMENT_CATEGORY"
 }
 
-_TERM_ID = 'organicCarbonPerHa'
+TERM_ID = 'organicCarbonPerHa'
 _METHOD_CLASSIFICATION = MeasurementMethodClassification.TIER_2_MODEL.value
 
 _RUN_IN_PERIOD = 5
@@ -134,7 +124,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) | descriptive_stats_dict
     measurement["dates"] = [f"{year}-12-31" for year in timestamps]
     measurement["depthUpper"] = DEPTH_UPPER
     measurement["depthLower"] = DEPTH_LOWER
@@ -413,7 +403,7 @@ def should_run(site: dict) -> tuple[bool, dict, dict]:
         _compile_inventory(cycles, measurement_nodes)
         if should_compile_inventory else ({}, {})
     )
-    kwargs["seed"] = gen_seed(site, MODEL, _TERM_ID)
+    kwargs["seed"] = gen_seed(site, MODEL, TERM_ID)
 
     valid_years = [year for year, group in inventory.items() if group.get(_InventoryKey.SHOULD_RUN)]
 

hestia_earth/models/ipcc2019/pastureGrass.py

@@ -1,13 +1,3 @@
-"""
-Cycle Pasture Grass
-
-This model estimates the energetic requirements of ruminants and can be used to estimate the amount of grass they graze.
-Source:
-[IPCC 2019, Vol.4, Chapter 10](https://www.ipcc-nggip.iges.or.jp/public/2019rf/pdf/4_Volume4/19R_V4_Ch10_Livestock.pdf).
-
-This version of the model will run at the Cycle level, if at least one Cycle Input is given as feed
-(see https://www.hestia.earth/schema/Input#isAnimalFeed).
-"""
 from hestia_earth.schema import TermTermType
 from hestia_earth.utils.model import filter_list_term_type
 from hestia_earth.utils.tools import list_sum, non_empty_list

hestia_earth/models/koble2014/aboveGroundCropResidue.py

@@ -1,12 +1,3 @@
-"""
-Above Ground Crop Residue
-
-This model returns the amounts and destinations of above ground crop residue, working in the following order:
-1. [Above ground crop residue, removed](https://hestia.earth/term/aboveGroundCropResidueRemoved);
-2. [Above ground crop residue, incorporated](https://hestia.earth/term/aboveGroundCropResidueIncorporated);
-3. [Above ground crop residue, burnt](https://hestia.earth/term/aboveGroundCropResidueBurnt);
-4. [Above ground crop residue, left on field](https://hestia.earth/term/aboveGroundCropResidueLeftOnField).
-"""
 from functools import reduce
 from hestia_earth.utils.model import find_term_match
 from hestia_earth.utils.tools import flatten, list_sum, list_average