hestia-earth-models 0.73.4__py3-none-any.whl → 0.73.5__py3-none-any.whl

hestia_earth/models/version.py

@@ -1 +1 @@
-VERSION = '0.73.4'
+VERSION = '0.73.5'

{hestia_earth_models-0.73.4.dist-info → hestia_earth_models-0.73.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hestia-earth-models
-Version: 0.73.4
+Version: 0.73.5
 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.73.4.dist-info → hestia_earth_models-0.73.5.dist-info}/RECORD

@@ -5,7 +5,7 @@ hestia_earth/models/cache_sites.py,sha256=XpXnkYt823PQzrswgP__L4CT8xZG_n7a41CIHK
 hestia_earth/models/log.py,sha256=eRuH86v7Thuw-QXdKqaqVmA_MkwnOCo0UBEwtuDq4Oc,3554
 hestia_earth/models/preload_requests.py,sha256=vK_G1UzhNMhYy7ymnCtHUz_vv3cfApCSKqv29VREEBQ,1943
 hestia_earth/models/requirements.py,sha256=eU4yT443fx7BnaokhrLB_PCizJI7Y6m4auyo8vQauNg,17363
-hestia_earth/models/version.py,sha256=jKpV57P7KcWNOm5DrfT5hkuNicj89ENgA5Alu2opwy4,19
+hestia_earth/models/version.py,sha256=gaJ7asOZglEOu1WEQGhDLAicifIKNkt5PDb2Cw4T0-8,19
 hestia_earth/models/agribalyse2016/__init__.py,sha256=WvK0qCQbnYtg9oZxrACd1wGormZyXibPtpCnIQeDqbw,415
 hestia_earth/models/agribalyse2016/fuelElectricity.py,sha256=1ngl8pdxeNhlVV8keAeWRwGorr_1uFXM9EoPUWx-uSc,4382
 hestia_earth/models/agribalyse2016/machineryInfrastructureDepreciatedAmountPerCycle.py,sha256=queToXuzq0tQ9_XuUJ2pJgSywXmbt9uX3ZoIKgqkROM,2660
@@ -37,7 +37,7 @@ hestia_earth/models/cml2001NonBaseline/eutrophicationPotentialIncludingFateAvera
 hestia_earth/models/cml2001NonBaseline/terrestrialAcidificationPotentialExcludingFate.py,sha256=xcrxfs9UoV_EWvV-XzMt35oPWCUsTzqg2SGA3j2MFIw,1091
 hestia_earth/models/config/Cycle.json,sha256=3fsz2dNEKA4noEjqrp25Or3_scDxqFS7c_7v911Gpno,59078
 hestia_earth/models/config/ImpactAssessment.json,sha256=ubAHJRHOFdX-fIYkOEBuD0CYvNZtFYSr8GSgKliVL8g,60968
-hestia_earth/models/config/Site.json,sha256=TnWIoaTspA0SUERWGpwuVf5o6x34N2riGftqzcvpCho,14086
+hestia_earth/models/config/Site.json,sha256=4DPSziHnDIngyub3Of8OvDEKa446q3Yx48R2Eobqk24,14374
 hestia_earth/models/config/__init__.py,sha256=l1WqL7ezlank86ABP4zUia_hIvM9ba-sOE3z6wNrea8,2333
 hestia_earth/models/config/run-calculations.json,sha256=e3nJ4M6CP1iFzfv8ou_ZUFbFxYkDxJgwuNDXTm4PBDc,615
 hestia_earth/models/config/trigger-calculations.json,sha256=3dmn2bRuj6QEtSTOLdIy31ho7thgUXyDsnqZzPV9rAQ,623
@@ -205,7 +205,7 @@ hestia_earth/models/hestia/freshWater.py,sha256=Q-dmFJLZfyYEyFyYkJUOjgmQR3G5YXCX
 hestia_earth/models/hestia/histosol.py,sha256=IexiWTSlSJYGjrdpYmRooW6v8LjhYATPQ8smMz1UZBA,1612
 hestia_earth/models/hestia/inorganicFertiliser.py,sha256=We4PBaTXyGwEQTfhX0-J8Xt03p-FB9i9j3tEK5JQ8uE,9026
 hestia_earth/models/hestia/irrigatedTypeUnspecified.py,sha256=VdYzfYxcRzWv21qxRkDn9HBid7-Bt_CgIv4iyXJH03g,1929
-hestia_earth/models/hestia/landCover.py,sha256=FHJ98zDByDL3ofziHICQNKiz_OnmrdOqJC0ZJRHif7E,32953
+hestia_earth/models/hestia/landCover.py,sha256=l0uhIxHZ9cD8ZB37RzeWUzjfh7d0iTB7GiMG7DYWddU,34937
 hestia_earth/models/hestia/landTransformation100YearAverageDuringCycle.py,sha256=hF7_DDvrs7swH6ott_ihgYx13UzEKHH6pccYCtzrN8o,1069
 hestia_earth/models/hestia/landTransformation20YearAverageDuringCycle.py,sha256=05SCH6ZjEV3mIleRusBg677zu0xgu5YK0f9FCddgNPg,1067
 hestia_earth/models/hestia/liveAnimal.py,sha256=d7HuUi40c-7TN1kecdRuqbht8PAe7x4ps0NhSuWG34Q,3868
@@ -287,6 +287,7 @@ hestia_earth/models/ipcc2019/aboveGroundBiomass.py,sha256=T50NcJoyGrHYUSzJBXJKAO
 hestia_earth/models/ipcc2019/aboveGroundCropResidueTotal.py,sha256=lT2QVV5c2LvQqZRfPEvFT_bMTayMXgIsFLnx8I6iYzw,3089
 hestia_earth/models/ipcc2019/belowGroundBiomass.py,sha256=WN3R5kUIc5Ij4HxMFcTGKeNRoPChRY6ws0x3nQNeEMw,19421
 hestia_earth/models/ipcc2019/belowGroundCropResidue.py,sha256=qbfsLBPaMIt4oQzYAzbsZdkJozTbwuztNr48TLYC5-Y,3507
+hestia_earth/models/ipcc2019/biocharOrganicCarbonPerHa.py,sha256=--qSO-v0X6qlti5NmUD5bcjGpf4tX352vPVDU0ECAI0,13276
 hestia_earth/models/ipcc2019/biomass_utils.py,sha256=NkTPGMl-0tqvhUZKZ1rxW0XTBnZOvgFJki_IPzEEyu0,15796
 hestia_earth/models/ipcc2019/carbonContent.py,sha256=XhXDu6DRQxANBsRsCEgw4f0UJDOgWsvhVyEwK1-4YT0,7263
 hestia_earth/models/ipcc2019/ch4ToAirAquacultureSystems.py,sha256=JeyF4tUPn3KIDbXwgM_MFp18hnTZjLBBqMFMH_ciZ1Q,3529
@@ -448,7 +449,7 @@ hestia_earth/models/linkedImpactAssessment/utils.py,sha256=7M-E7u35fIF0uMoA1hwcr
 hestia_earth/models/mocking/__init__.py,sha256=9VX50c-grz-snfd-7MBS0KfF7AadtbKuj7kK6PqtsgE,687
 hestia_earth/models/mocking/build_mock_search.py,sha256=p15ccEUmkmLp1RiGNznxMz3OFHbI8P1-29ExuohiQN8,1355
 hestia_earth/models/mocking/mock_search.py,sha256=ccFe_WrI73JElFmxp4hPNLCX7eeU--lBC1JFR901KJY,1069
-hestia_earth/models/mocking/search-results.json,sha256=q9-8NCcbbCa7h9SQk-gFtp3ZWLBHs2OW5OyN5RAybzY,162622
+hestia_earth/models/mocking/search-results.json,sha256=eMTxqv2Lz6tZuSuUkOWRnBLsqPIp7JIoupRI3YyIrig,162691
 hestia_earth/models/pooreNemecek2018/__init__.py,sha256=nPboL7ULJzL5nJD5q7q9VOZt_fxbKVm8fmn1Az5YkVY,417
 hestia_earth/models/pooreNemecek2018/aboveGroundCropResidueTotal.py,sha256=oXillpppAas1q9GKmODxe1YXyno3EzV-j12xhzkqtTc,2404
 hestia_earth/models/pooreNemecek2018/belowGroundCropResidue.py,sha256=_pQMPSvI--Xm00H6vXDA4ct_pQXKRGrLE2f-2tQE6y4,2323
@@ -844,7 +845,7 @@ tests/models/hestia/test_freshWater.py,sha256=v2UD69csKrniKP3MXkOEHxQeE6O3-lvIVi
 tests/models/hestia/test_histosol.py,sha256=7g-3wQPZok2O8mExcnKZxO_T2Ye_h3UHv3HG3Kn8orM,888
 tests/models/hestia/test_inorganicFertiliser.py,sha256=v2Zs1Ig-ChOaq9gXuurcBt12izkH2bRUUuzW6rh3rqQ,643
 tests/models/hestia/test_irrigatedTypeUnspecified.py,sha256=bluZADFagxfXW4QyI0CIJzG97D2V33w333Z9Vwjqo0M,2015
-tests/models/hestia/test_landCover.py,sha256=YLu-fttf0tGGT8IAPGo8BZDsSyRoW7f-JU8Ra0Pp-dA,7494
+tests/models/hestia/test_landCover.py,sha256=rGJq9WtaAOKYmUA_sLRHyHZgxo2heoODpB9Jo7jC9Pc,9076
 tests/models/hestia/test_landTransformation100YearAverageDuringCycle.py,sha256=3qa4rWUFqP1VM5-vm_182rhiBYJDxPqJwWtBqJ5K028,956
 tests/models/hestia/test_landTransformation20YearAverageDuringCycle.py,sha256=bUByojQuVeuCfko1_2YtNJi1PT9yktHlcbPi_p-MPvk,1001
 tests/models/hestia/test_liveAnimal.py,sha256=3K9cL1fwr6LlBl1_D8zIaeCOuiExqkDEU7BXx1JK_dk,2139
@@ -919,6 +920,7 @@ tests/models/ipcc2019/test_aboveGroundBiomass.py,sha256=zzsE1zr8qYWgc1EWNrCZggjk
 tests/models/ipcc2019/test_aboveGroundCropResidueTotal.py,sha256=HrTsqm1r5c5di5JONu7P4_95JMp1kbDuKfQjWLE0Jhs,2573
 tests/models/ipcc2019/test_belowGroundBiomass.py,sha256=Cu41RM63R-xti0qi_mLD0J5TClo61OkjsR4FI3caNxs,7579
 tests/models/ipcc2019/test_belowGroundCropResidue.py,sha256=no71pfxgOhn_tEWc_EwuWvlKRtHFqlIqNIvnP7cj0Tc,2568
+tests/models/ipcc2019/test_biocharOrganicCarbonPerHa.py,sha256=19SX8sCKjyqThydHBh7jE9S46Y6SBd-pJx_RUmuZ0nU,3785
 tests/models/ipcc2019/test_biomass_utils.py,sha256=I2q4pDGAD0aY_kpZCMPJoC-KbRYxdzY1rhr4xtJFWIA,3592
 tests/models/ipcc2019/test_carbonContent.py,sha256=_GWF5nGy-PxiqBZ5V7W_sHMz75YRzmxr79R-sZZg7yk,4146
 tests/models/ipcc2019/test_ch4ToAirAquacultureSystems.py,sha256=hG1zunH2gCeix8fxxkoGfl_I0GRyAcLbwEtwWVE9i5M,1925
@@ -1249,8 +1251,8 @@ tests/orchestrator/strategies/run/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeR
 tests/orchestrator/strategies/run/test_add_blank_node_if_missing.py,sha256=K4xg4UAXfNhSaLyknKVPO7MGBF44Z_gD7CuZ_pe28gU,3512
 tests/orchestrator/strategies/run/test_add_key_if_missing.py,sha256=hKwvk1ohcBVnQUCTiDhRW99J0xEa29BpwFi1KC0yWLE,329
 tests/orchestrator/strategies/run/test_always.py,sha256=w5-Dhp6yLzgZGAeMRz3OrqZbbAed9gZ1O266a3z9k7w,134
-hestia_earth_models-0.73.4.dist-info/LICENSE,sha256=TD25LoiRJsA5CPUNrcyt1PXlGcbUGFMAeZoBcfCrCNE,1154
-hestia_earth_models-0.73.4.dist-info/METADATA,sha256=Acqy7een93J-4E9V-DI_J5-n-_Lb9lzOnoHcCbKGO5U,4065
-hestia_earth_models-0.73.4.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
-hestia_earth_models-0.73.4.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
-hestia_earth_models-0.73.4.dist-info/RECORD,,
+hestia_earth_models-0.73.5.dist-info/LICENSE,sha256=TD25LoiRJsA5CPUNrcyt1PXlGcbUGFMAeZoBcfCrCNE,1154
+hestia_earth_models-0.73.5.dist-info/METADATA,sha256=waCb4T4IfTXsSP5YtJg9ac3PfcnmIDejSOW2sgFDf4I,4065
+hestia_earth_models-0.73.5.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+hestia_earth_models-0.73.5.dist-info/top_level.txt,sha256=1dqA9TqpOLTEgpqa-YBsmbCmmNU1y56AtfFGEceZ2A0,19
+hestia_earth_models-0.73.5.dist-info/RECORD,,

tests/models/hestia/test_landCover.py

@@ -1,3 +1,4 @@
+import logging
 import os
 import json
 import pytest
@@ -13,7 +14,10 @@ from hestia_earth.models.hestia.landCover import (
 
 CLASS_PATH = f"hestia_earth.models.{MODEL}.{MODEL_KEY}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{MODEL_KEY}"
-_folders = [d for d in os.listdir(fixtures_folder) if os.path.isdir(os.path.join(fixtures_folder, d))]
+_folders = [
+    d for d in os.listdir(fixtures_folder)
+    if os.path.isdir(os.path.join(fixtures_folder, d)) and not d.startswith("_")
+]
 
 FAOSTAT_CLASS_PATH = f"hestia_earth.models.{FAOSTAT_MODEL}.utils"
 faostat_fixtures_folder = f"{fixtures_path}/{FAOSTAT_MODEL}/utils"
@@ -254,3 +258,31 @@ def test_run(mock, subfolder: str):
 
     result = run(site)
     assert result == expected
+
+
+def fake_region_lookup(lookup_name: str, term_id: str, column: str, **log_args):
+    """Returns obviously-wrong mock results from Brazil to be distinct from model."""
+    return ("2010:55.0")
+
+
+@patch(f"{CLASS_PATH}.get_region_lookup_value", side_effect=fake_region_lookup)
+@patch(f"{CLASS_PATH}._new_management", side_effect=fake_new_management)
+def test_landCover_from_lookup_run(mock_mgmt, mock_region_lookup, caplog):
+    caplog.set_level(logging.INFO)
+    folder = f"{fixtures_folder}/_from_lookups"
+    with open(f"{folder}/site.jsonld", encoding='utf-8') as f:
+        site = json.load(f)
+
+    with open(f"{folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    result = run(site)
+    expected_message = ("site=Brazil-example, requirements=true, model=hestia, model_key=landCover, "
+                        "has_management_nodes=True, land_use_type=Arable land, allowed_land_use_types=Arable land;"
+                        "Permanent crops;Permanent meadows and pastures, has_no_prior_land_cover_data=True, "
+                        "management_nodes=value:100_id:maizePlant_land-use-type:Arable land_endDate:2010-12-31"
+                        "_startDate:2010-01-01, landCover_from_lookups={'Forest land': 0.55, 'Arable land': 0.55, "
+                        "'Permanent crops': 0.55, 'Permanent meadows and pastures': 0.55, 'Other land': 0.55}, "
+                        "should_run_nodes=True")
+    assert expected_message in [r.msg for r in caplog.records]
+    assert result == expected

tests/models/ipcc2019/test_biocharOrganicCarbonPerHa.py

@@ -0,0 +1,131 @@
+import json
+from os.path import isfile
+from pytest import mark
+from unittest.mock import MagicMock, patch
+
+from hestia_earth.models.ipcc2019.biocharOrganicCarbonPerHa import _should_run, MODEL, run, TERM_ID
+
+from tests.utils import fake_new_measurement, fixtures_path
+
+class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
+property_path = "hestia_earth.models.utils.property"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
+
+_DEFAULT_PROPERTIES = {
+    "biocharManureGasification": {
+        "organicCarbonContent": {
+            "value": 9,
+            "sd": 2.4,
+            "min": 0,
+            "max": 100
+        }
+    },
+    "biocharBambooLowTemperaturePyrolysis": {
+        "organicCarbonContent": {
+            "value": 77,
+            "sd": 16.5,
+            "min": 0,
+            "max": 100
+        }
+    },
+    "biocharStrawHighTemperaturePyrolysis": {
+        "organicCarbonContent": {
+            "value": 65,
+            "sd": 14.9,
+            "min": 0,
+            "max": 100
+        }
+    },
+    "biocharPaperSludgeMediumTemperaturePyrolysis": {
+        "organicCarbonContent": {
+            "value": 35,
+            "sd": 7.1,
+            "min": 0,
+            "max": 100
+        }
+    },
+    "biocharUnspecifiedFeedstockUnspecifiedProductionMethod": {
+        "organicCarbonContent": {
+            "value": 40.6,
+            "sd": 10.5,
+            "min": 0,
+            "max": 100
+        }
+    }
+}
+
+
+def fake_find_term_property(term: dict, property: str, *_):
+    term_id = term.get('@id', None)
+    return _DEFAULT_PROPERTIES.get(term_id, {}).get(property, {})
+
+
+def _load_fixture(path: str, default=None):
+    if isfile(path):
+        with open(path, encoding="utf-8") as f:
+            return json.load(f)
+    return default
+
+
+# subfolder, should_run
+PARAMS_SHOULD_RUN = [
+    ("with-stats", True),
+    ("no-biochar", True),
+    ("no-cycles", False),
+    ("with-organic-soils", False),
+    ("with-relative-func-unit", False),
+    ("with-site-type-forest", False)
+]
+IDS_SHOULD_RUN = [p[0] for p in PARAMS_SHOULD_RUN]
+
+
+@mark.parametrize("subfolder, should_run", PARAMS_SHOULD_RUN, ids=IDS_SHOULD_RUN)
+@patch(f"{property_path}.find_term_property", side_effect=fake_find_term_property)
+@patch(f"{property_path}.download_term")
+@patch(f"{class_path}.related_cycles")
+def test_should_run(
+    related_cycles_mock: MagicMock,
+    download_term_mock: MagicMock,
+    _find_term_property_mock: MagicMock,
+    subfolder: str,
+    should_run: bool
+):
+    folder = f"{fixtures_folder}/{subfolder}"
+
+    site = _load_fixture(f"{folder}/site.jsonld", {})
+    related_cycles_mock.return_value = _load_fixture(f"{folder}/cycles.jsonld", [])
+
+    result, *_ = _should_run(site)
+    assert result == should_run
+
+    # Ensure that the property utils are properly mocked.
+    download_term_mock.assert_not_called()
+
+
+PARAMS_RUN = [subfolder for subfolder, should_run in PARAMS_SHOULD_RUN if should_run]
+
+
+@mark.parametrize("subfolder", PARAMS_RUN)
+@patch(f"{property_path}.find_term_property", side_effect=fake_find_term_property)
+@patch(f"{property_path}.download_term")
+@patch(f"{class_path}.related_cycles")
+@patch(f"{class_path}._new_measurement", side_effect=fake_new_measurement)
+def test_run(
+    _new_measurement_mock: MagicMock,
+    related_cycles_mock: MagicMock,
+    download_term_mock: MagicMock,
+    _find_term_property_mock: MagicMock,
+    subfolder: str
+):
+    folder = f"{fixtures_folder}/{subfolder}"
+
+    site = _load_fixture(f"{folder}/site.jsonld", {})
+    related_cycles_mock.return_value = _load_fixture(f"{folder}/cycles.jsonld", [])
+
+    expected = _load_fixture(f"{folder}/result.jsonld", [])
+
+    result = run(site)
+    assert result == expected
+
+    # Ensure that the property utils are properly mocked.
+    download_term_mock.assert_not_called()