hestia-earth-models 0.44.0__tar.gz → 0.44.1__tar.gz

{hestia-earth-models-0.44.0/hestia_earth_models.egg-info → hestia-earth-models-0.44.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.44.0
+Version: 0.44.1
 Summary: Hestia's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.).
 Home-page: https://gitlab.com/hestia-earth/hestia-engine-models
 Author: Hestia Team

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/__init__.py

@@ -20,7 +20,8 @@ MODELS = list(map(lambda m: {'key': m, 'run': getattr(import_module(f".{m}", pac
 def _should_run_model(model, cycle: dict):
     is_complete = cycle.get('completeness', {}).get(model.get('key'))
     should_run = is_complete is False
-    logShouldRun(cycle, MODEL, None, should_run, key=model.get('key'))
+    if should_run:
+        logShouldRun(cycle, MODEL, None, should_run, key=model.get('key'))
     return should_run
 
 

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/animalFeed.py

@@ -1,12 +1,12 @@
 """
-Animal feed
+Completeness Animal feed
 
-This model checks if the site is a cropland and updates the
+This model checks if we have the requirements below and updates the
 [Data Completeness](https://hestia.earth/schema/Completeness#animalFeed) value.
 """
 from hestia_earth.schema import SiteSiteType
 
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from . import MODEL
 
 REQUIREMENTS = {
@@ -33,6 +33,8 @@ ALLOWED_SITE_TYPES = [
 def run(cycle: dict):
     site_type = cycle.get('site', {}).get('siteType')
     site_type_allowed = site_type in ALLOWED_SITE_TYPES
-    is_complete = all([site_type_allowed])
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    site_type_allowed=site_type_allowed)
+
+    return all([site_type_allowed])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/cropResidue.py

@@ -1,12 +1,12 @@
 """
-Crop Residue
+Completeness Crop Residue
 
-This model checks if we have all the [crop residue terms](https://hestia.earth/glossary?termType=cropResidue)
-and updates the [Data Completeness](https://hestia.earth/schema/Completeness#cropResidue) value.
+This model checks if we have the requirements below and updates the
+[Data Completeness](https://hestia.earth/schema/Completeness#cropResidue) value.
 """
 from hestia_earth.utils.model import find_term_match
 
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from hestia_earth.models.utils.term import get_crop_residue_terms
 from . import MODEL
 
@@ -44,11 +44,26 @@ def _optional_term_ids():
     return [term for term in terms if term not in REQUIRED_TERM_IDS]
 
 
+def _has_product(products):
+    def has_product(term_id: str):
+        return (term_id, find_term_match(products, term_id, None) is not None)
+    return has_product
+
+
 def run(cycle: dict):
     products = cycle.get('products', [])
     # all required terms + at least one of the optional terms must be present
-    required_valid = all([find_term_match(products, term_id, False) for term_id in REQUIRED_TERM_IDS])
-    optional_valid = any([find_term_match(products, term_id, False) for term_id in _optional_term_ids()])
-    is_complete = required_valid and optional_valid
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+    required_products_map = list(map(_has_product(products), REQUIRED_TERM_IDS))
+    optional_products_map = list(map(_has_product(products), _optional_term_ids()))
+
+    has_required_products = all([has_product for _term_id, has_product in required_products_map])
+    has_optional_product = any([has_product for _term_id, has_product in optional_products_map])
+
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    **({
+                        f'has_required_{term_id}': has_product for term_id, has_product in required_products_map
+                    } | {
+                        f'has_optional_{term_id}': has_product for term_id, has_product in optional_products_map
+                    }))
+
+    return all([has_required_products, has_optional_product])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/excreta.py

@@ -1,12 +1,12 @@
 """
-Excreta
+Completeness Excreta
 
-This model checks if the site is a cropland and updates the
+This model checks if we have the requirements below and updates the
 [Data Completeness](https://hestia.earth/schema/Completeness#excreta) value.
 """
 from hestia_earth.schema import SiteSiteType
 
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from . import MODEL
 
 REQUIREMENTS = {
@@ -33,6 +33,8 @@ ALLOWED_SITE_TYPES = [
 def run(cycle: dict):
     site_type = cycle.get('site', {}).get('siteType')
     site_type_allowed = site_type in ALLOWED_SITE_TYPES
-    is_complete = all([site_type_allowed])
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    site_type_allowed=site_type_allowed)
+
+    return all([site_type_allowed])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/material.py

@@ -1,13 +1,13 @@
 """
-Material
+Completeness Material
 
-This model checks if the `machinery` Input has been added and updates the
+This model checks if we have the requirements below and updates the
 [Data Completeness](https://hestia.earth/schema/Completeness#material) value.
 """
 from hestia_earth.schema import SiteSiteType
 from hestia_earth.utils.model import find_term_match
 
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from . import MODEL
 
 REQUIREMENTS = {
@@ -34,7 +34,12 @@ ALLOWED_SITE_TYPES = [
 def run(cycle: dict):
     site_type = cycle.get('site', {}).get('siteType')
     site_type_allowed = site_type in ALLOWED_SITE_TYPES
-    input = find_term_match(cycle.get('inputs', []), 'machineryInfrastructureDepreciatedAmountPerCycle', None)
-    is_complete = all([site_type_allowed, input])
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+    has_machinery_input = find_term_match(
+        cycle.get('inputs', []), 'machineryInfrastructureDepreciatedAmountPerCycle', None
+    ) is not None
+
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    site_type_allowed=site_type_allowed,
+                    has_machinery_input=has_machinery_input)
+
+    return all([site_type_allowed, has_machinery_input])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/other.py

@@ -1,13 +1,13 @@
 """
-Other
+Completeness Other
 
-This model checks if the `seed` or `saplings` Input has been added and updates the
+This model checks if we have the requirements below and updates the
 [Data Completeness](https://hestia.earth/schema/Completeness#other) value.
 """
 from hestia_earth.schema import SiteSiteType
 from hestia_earth.utils.model import find_term_match, find_primary_product
 
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from hestia_earth.models.utils.crop import is_orchard
 from . import MODEL
 
@@ -48,6 +48,9 @@ def run(cycle: dict):
     term_id = product.get('term', {}).get('@id')
     has_saplings = find_term_match(cycle.get('inputs', []), 'saplings', None) and is_orchard(MODEL, term_id)
 
-    is_complete = all([site_type_allowed, has_seed or has_saplings])
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    site_type_allowed=site_type_allowed,
+                    has_seed=has_seed,
+                    has_saplings=has_saplings)
+
+    return all([site_type_allowed, has_seed or has_saplings])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/cycle/completeness/soilAmendments.py

@@ -1,10 +1,10 @@
 """
-Soil Amendments
+Completeness Soil Amendments
 
-This model checks if the `soilPh` from geospatial dataset is greater than `6.5` and updates the
+This model checks if we have the requirements below and updates the
 [Data Completeness](https://hestia.earth/schema/Completeness#soilAmendments) value.
 """
-from hestia_earth.models.log import logger
+from hestia_earth.models.log import logRequirements
 from hestia_earth.models.utils import is_from_model
 from hestia_earth.models.utils.measurement import most_relevant_measurement, measurement_value
 from . import MODEL
@@ -32,6 +32,12 @@ def run(cycle: dict):
     measurements = cycle.get('site', {}).get('measurements', [])
     soilPh_measurement = most_relevant_measurement(measurements, 'soilPh', end_date)
     soilPh = measurement_value(soilPh_measurement)
-    is_complete = is_from_model(soilPh_measurement) and soilPh > 6.5
-    logger.debug('model=%s, key=%s, value=%s', MODEL, MODEL_KEY, is_complete)
-    return is_complete
+
+    soilPh_added = is_from_model(soilPh_measurement)
+    soilPh_above_6_5 = soilPh > 6.5
+
+    logRequirements(cycle, model=MODEL, term=None, key=MODEL_KEY,
+                    soilPh_added=soilPh_added,
+                    soilPh_above_6_5=soilPh_above_6_5)
+
+    return all([soilPh_added, soilPh_above_6_5])

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1}/hestia_earth/models/mocking/search-results.json

@@ -317,12 +317,12 @@
       "excretaSheepAndGoatsKgN",
       "excretaDucksKgN",
       "excretaBeefCattleExceptFeedlotFedKgN",
+      "excretaSolidAndLiquidFishCrustaceansKgN",
+      "excretaBuffaloKgN",
       "excretaHorsesMulesAndAssesKgN",
       "excretaPigsKgN",
       "excretaCamelsKgN",
       "excretaDairyCattleKgN",
-      "excretaSolidAndLiquidFishCrustaceansKgN",
-      "excretaBuffaloKgN",
       "excretaLiquidFishCrustaceansKgN",
       "excretaTurkeysKgN",
       "excretaMixturesKgN",
@@ -348,13 +348,13 @@
       "waterDrainageCanal",
       "waterMarine",
       "waterSourceUnspecified",
-      "waterIrrigationCanal",
       "waterMunicipalTap",
-      "waterBrackish",
-      "waterLakeOrReservoir",
+      "waterIrrigationCanal",
       "waterRiverStream",
+      "waterHarvestedRainfall",
       "waterPumpedGroundwater",
-      "waterHarvestedRainfall"
+      "waterBrackish",
+      "waterLakeOrReservoir"
     ]
   },
   {
@@ -389,11 +389,11 @@
       }
     },
     "results": [
-      "motorGasoline",
       "diesel1D",
+      "motorGasoline",
+      "gasolineTypeJetFuel",
       "diesel",
       "aviationGasoline",
-      "gasolineTypeJetFuel",
       "en590Diesel",
       "diesel4D",
       "diesel2D"
@@ -426,14 +426,14 @@
       }
     },
     "results": [
+      "milkYieldPerCowRaw",
+      "milkYieldPerBuffaloFpcm",
       "milkYieldPerGoatRaw",
       "milkYieldPerSheepRaw",
-      "milkYieldPerBuffaloFpcm",
-      "milkYieldPerCowRaw",
       "milkYieldPerCowFpcm",
       "milkYieldPerSheepFpcm",
-      "milkYieldPerBuffaloRaw",
-      "milkYieldPerCamelRaw"
+      "milkYieldPerCamelRaw",
+      "milkYieldPerBuffaloRaw"
     ]
   },
   {
@@ -476,13 +476,13 @@
       "name": "tillage"
     },
     "results": [
+      "mulchTillage",
+      "stripTillage",
+      "deepTillage",
       "minimumTillage",
       "fullTillage",
       "ridgeTillage",
       "noTillage",
-      "deepTillage",
-      "mulchTillage",
-      "stripTillage",
       "fullInversionTillage"
     ]
   },
@@ -494,10 +494,10 @@
     },
     "results": [
       "ureaKgN",
-      "ureaFormaldehydeKgN",
-      "ureaCalciumNitrateKgN",
-      "sulphurCoatedUreaKgN",
       "ureaAmmoniumNitrateKgN",
+      "sulphurCoatedUreaKgN",
+      "ureaCalciumNitrateKgN",
+      "ureaFormaldehydeKgN",
       "ureaAmmoniumSulphateKgN"
     ]
   },

hestia-earth-models-0.44.1/hestia_earth/models/version.py

@@ -0,0 +1 @@
+VERSION = '0.44.1'

{hestia-earth-models-0.44.0 → hestia-earth-models-0.44.1/hestia_earth_models.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.44.0
+Version: 0.44.1
 Summary: Hestia's set of modules for filling gaps in the activity data using external datasets (e.g. populating soil properties with a geospatial dataset using provided coordinates) and internal lookups (e.g. populating machinery use from fuel use). Includes rules for when gaps should be filled versus not (e.g. never gap fill yield, gap fill crop residue if yield provided etc.).
 Home-page: https://gitlab.com/hestia-earth/hestia-engine-models
 Author: Hestia Team

hestia-earth-models-0.44.0/hestia_earth/models/version.py

@@ -1 +0,0 @@
-VERSION = '0.44.0'