hestia-earth-models 0.65.6__py3-none-any.whl → 0.65.7__py3-none-any.whl

hestia_earth/models/config/Site.json

@@ -0,0 +1,471 @@
+{
+  "models": [
+    [
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "organicCarbonPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "organicCarbonPerM3Soil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "organicMatterPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "organicMatterPerM3Soil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "potentialEvapotranspirationMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "precipitationMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "rainfallMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "temperatureMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "brackishWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "freshWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "salineWater",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
+    [
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "potentialEvapotranspirationAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "precipitationAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "rainfallAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "temperatureAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
+    [
+      {
+        "key": "awareWaterBasinId",
+        "model": "geospatialDatabase",
+        "value": "aware",
+        "runStrategy": "add_key_if_missing",
+        "mergeStrategy": "default",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "ecoClimateZone",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "drainageClass",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "ecoregion",
+        "model": "geospatialDatabase",
+        "value": "ecoregion",
+        "runStrategy": "add_key_if_missing",
+        "mergeStrategy": "default",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "erodibility",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "histosol",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "nutrientLossToAquaticEnvironment",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "precipitationMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "precipitationAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "precipitationLongTermAnnualMean",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "region",
+        "model": "geospatialDatabase",
+        "value": "region",
+        "runStrategy": "add_key_if_missing",
+        "mergeStrategy": "node",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "slopeLength",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "slope",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "totalNitrogenPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "organicCarbonPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "soilPh",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "totalPhosphorusPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "temperatureMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "temperatureAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "temperatureLongTermAnnualMean",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "heavyWinterPrecipitation",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "potentialEvapotranspirationMonthly",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "potentialEvapotranspirationAnnual",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "potentialEvapotranspirationLongTermAnnualMean",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "waterDepth",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "clayContent",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "sandContent",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
+    [
+      {
+        "key": "measurements",
+        "model": "geospatialDatabase",
+        "value": "siltContent",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "totalNitrogenPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "netPrimaryProduction",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "waterDepth",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      },
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "cationExchangeCapacityPerKgSoil",
+        "runStrategy": "add_blank_node_if_missing",
+        "mergeStrategy": "list",
+        "stage": 1
+      }
+    ],
+    {
+      "key": "measurements",
+      "model": "site",
+      "value": "measurement.value",
+      "runStrategy": "always",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "measurements",
+      "model": "site",
+      "value": "soilMeasurement",
+      "runStrategy": "always",
+      "mergeStrategy": "list",
+      "stage": 1
+    },
+    {
+      "key": "management",
+      "model": "site",
+      "value": "management",
+      "runStrategy": "always",
+      "mergeStrategy": "list",
+      "stage": 2
+    },
+    [
+      {
+        "key": "measurements",
+        "model": "site",
+        "value": "organicCarbonPerHa",
+        "runStrategy": "always",
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "management",
+        "model": "hestia",
+        "value": "landCover",
+        "runStrategy": "always",
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      }
+    ],
+    [
+      {
+        "key": "measurements",
+        "model": "ipcc2019",
+        "value": "organicCarbonPerHa",
+        "runStrategy": "always",
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "measurements",
+        "model": "ipcc2019",
+        "value": "aboveGroundBiomass",
+        "runStrategy": "always",
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      },
+      {
+        "key": "measurements",
+        "model": "ipcc2019",
+        "value": "belowGroundBiomass",
+        "runStrategy": "always",
+        "mergeStrategy": "list",
+        "mergeArgs": {
+          "replaceThreshold": ["value", 0.01]
+        },
+        "stage": 2
+      }
+    ]
+  ]
+}

hestia_earth/models/config/__init__.py

@@ -0,0 +1,71 @@
+import os
+import json
+from hestia_earth.utils.tools import flatten
+
+CURRENT_DIR = os.path.dirname(os.path.abspath(__file__))
+
+
+def _is_aggregated_model(model: dict):
+    return isinstance(model, dict) and 'aggregated' in model.get('value', '').lower()
+
+
+def _remove_aggregated(models: list):
+    values = [
+        _remove_aggregated(m) if isinstance(m, list) else m if not _is_aggregated_model(m) else None
+        for m in models
+    ]
+    return list(filter(lambda v: v is not None, values))
+
+
+def _load_config(filename: str) -> dict:
+    with open(os.path.join(CURRENT_DIR, f"{filename}.json"), 'r') as f:
+        return json.load(f)
+
+
+def load_config(node_type: str, skip_aggregated_models: bool = False) -> dict:
+    """
+    Load the configuration associated with the Node Type.
+
+    Parameters
+    ----------
+    node_type : str
+        The Node Type to load configuration. Can be: `Cycle`, `Site`, `ImpactAssessment`.
+    skip_aggregated_models : bool
+        Include models using aggregated data. Included by default.
+    """
+    try:
+        config = _load_config(node_type)
+        models = config.get('models')
+        return config | {'models': _remove_aggregated(models) if skip_aggregated_models else models}
+    except FileNotFoundError:
+        raise Exception(f"Invalid type {node_type}.")
+
+
+def config_max_stage(config: dict):
+    """
+    Get maximum `stage` value from a configuration.
+
+    Parameters
+    ----------
+    config : dict
+        The Node configuration.
+    """
+    models = config.get('models', [])
+    return max([m.get('stage', 1) for m in flatten(models)])
+
+
+def _load_stage_config(filename: str, node_type: str, stage: int):
+    config = _load_config(filename).get(node_type, {})
+
+    if f"stage-{stage}" not in config:
+        raise Exception(f"Invalid stage configuration for {node_type}: {stage}")
+
+    return config.get(f"stage-{stage}", [])
+
+
+def load_run_config(node_type: str, stage: int):
+    return _load_stage_config('run-calculations', node_type, stage)
+
+
+def load_trigger_config(node_type: str, stage: int):
+    return _load_stage_config('trigger-calculations', node_type, stage)

hestia_earth/models/config/run-calculations.json

@@ -0,0 +1,42 @@
+{
+  "Site": {
+    "stage-1": [],
+    "stage-2": [
+      {
+        "key": "related",
+        "type": "Cycle",
+        "stage": 1
+      }
+    ]
+  },
+  "Cycle": {
+    "stage-1": [
+      {
+        "key": "nested",
+        "type": "Site",
+        "stage": 1
+      },
+      {
+        "key": "nested",
+        "type": "ImpactAssessment",
+        "stage": 1
+      }
+    ],
+    "stage-2": [
+      {
+        "key": "nested",
+        "type": "Site",
+        "stage": 2
+      }
+    ]
+  },
+  "ImpactAssessment": {
+    "stage-1": [
+      {
+        "key": "nested",
+        "type": "Cycle",
+        "stage": 2
+      }
+    ]
+  }
+}

hestia_earth/models/config/trigger-calculations.json

@@ -0,0 +1,43 @@
+{
+  "Site": {
+    "stage-1": [
+      {
+        "key": "related",
+        "type": "Cycle",
+        "stage": 1
+      }
+    ],
+    "stage-2": [
+      {
+        "key": "related",
+        "type": "Cycle",
+        "stage": 2
+      }
+    ]
+  },
+  "Cycle": {
+    "stage-1": [
+      {
+        "key": "nested",
+        "type": "Site",
+        "stage": 2
+      }
+    ],
+    "stage-2": [
+      {
+        "key": "related",
+        "type": "ImpactAssessment",
+        "stage": 1
+      }
+    ]
+  },
+  "ImpactAssessment": {
+    "stage-1": [
+      {
+        "key": "related",
+        "type": "Cycle",
+        "stage": 1
+      }
+    ]
+  }
+}

hestia_earth/models/ipcc2019/animal/hoursWorkedPerDay.py

@@ -0,0 +1,38 @@
+from .utils import should_run_by_productivity_lookup, run_animal_by_productivity
+
+REQUIREMENTS = {
+    "Cycle": {
+        "site": {
+            "@type": "Site",
+            "country": {"@type": "Term", "termType": "region"}
+        },
+        "animals": [{
+            "@type": "Animal",
+            "term.termType": "liveAnimal",
+            "none": {
+                "properties": [{
+                    "@type": "Property",
+                    "value": "",
+                    "term.@id": "hoursWorkedPerDay"
+                }]
+            }
+        }]
+    }
+}
+LOOKUPS = {
+    "region-liveAnimal-hoursWorkedPerDay": "hours worked per day"
+}
+RETURNS = {
+    "Animal": [{
+        "properties": [{
+            "@type": "Property",
+            "value": ""
+        }]
+    }]
+}
+TERM_ID = 'hoursWorkedPerDay'
+
+
+def run(cycle: dict):
+    animals = should_run_by_productivity_lookup(TERM_ID, cycle, list(LOOKUPS.keys())[0])
+    return list(map(run_animal_by_productivity(TERM_ID), animals))