hestia-earth-models 0.64.10__py3-none-any.whl → 0.64.12__py3-none-any.whl

tests/models/hestia/test_landCover.py

@@ -0,0 +1,209 @@
+import csv
+import json
+import numpy as np
+import pytest
+from unittest.mock import patch
+
+from tests.utils import fixtures_path
+from hestia_earth.models.faostat2018.utils import MODEL as FAOSTAT_MODEL
+from hestia_earth.models.hestia.landCover import (
+    MODEL, MODEL_KEY, get_changes, _estimate_maximum_forest_change,
+    run, site_area_sum_to_100, _get_sums_of_crop_expansion
+)
+
+CLASS_PATH = f"hestia_earth.models.{MODEL}.{MODEL_KEY}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/{MODEL_KEY}"
+
+FAOSTAT_CLASS_PATH = f"hestia_earth.models.{FAOSTAT_MODEL}.utils"
+faostat_fixtures_folder = f"{fixtures_path}/{FAOSTAT_MODEL}/utils"
+
+BRAZIL_SITE = {
+    "@type": "Site",
+    "id": "Brazil-example",
+    "country": {
+        "name": "Brazil",
+        "type": "Term"
+    },
+    "siteType": "cropland",
+    "management": [
+        {
+            "term": {
+                "@id": "maizePlant",
+                "name": "Maize plant",
+                "type": "Term",
+                "termType": "landCover"
+            },
+            "value": 100,
+            "startDate": "2010-01-01",
+            "endDate": "2010-12-31",
+            "type": "Management"
+        }
+    ]
+}
+
+
+def recfromcsv_mod(filename, **kwargs):
+    def rewrite_csv_as_tab(csv_name):
+        with open(csv_name, newline='') as fp:
+            for row in csv.reader(fp, delimiter=","):
+                yield "\t".join(row)
+    return np.recfromcsv(
+        rewrite_csv_as_tab(filename), delimiter="\t", encoding=None, **kwargs)
+
+
+def _download_fixture(filepath: str):
+    return recfromcsv_mod(filename=filepath)
+
+
+@patch(f"{FAOSTAT_CLASS_PATH}.download_lookup")
+def test_get_changes(mock_lookup):
+    mock_lookup.return_value = _download_fixture(f"{faostat_fixtures_folder}/gadm-afg.csv")
+    result = get_changes(
+        country_id="GADM-AFG",
+        end_year=2010
+    )
+    assert (
+        result == {
+            "Arable land": -117.0,
+            "Cropland": -123.0,
+            "Forest land": 0,
+            "Other land": 123.0,
+            "Land area": 0,
+            "Permanent crops": -6.0,
+            "Permanent meadows and pastures": 0,
+            "Total agricultural change": -123.0
+        }
+    )
+
+
+@pytest.mark.parametrize(
+    "description,inputs,expected_output",
+    [
+        (
+            "Annual cropland gain from forest",
+            {
+                "forest_change": -1000,
+                "total_cropland_change": 1000,
+                "pasture_change": 0,
+                "total_agricultural_change": 1000
+            },
+            -1000
+        ),
+        (
+            "Pasture gain from forest",
+            {
+                "forest_change": -1000,
+                "total_cropland_change": 0,
+                "pasture_change": 1000,
+                "total_agricultural_change": 1000
+            },
+            -1000
+        ),
+        (
+            "Brazil",
+            {
+                "forest_change": -77317,
+                "total_cropland_change": 5201,
+                "pasture_change": -8267,
+                "total_agricultural_change": -3066
+            },
+            -5201
+        ),
+        (
+            "Argentina",
+            {
+                "forest_change": -4990,
+                "total_cropland_change": 11408,
+                "pasture_change": -12705,
+                "total_agricultural_change": -1297
+            },
+            -4990
+        ),
+        (
+            "Madagascar",
+            {
+                "forest_change": -1131,
+                "total_cropland_change": 275,
+                "pasture_change": 4295,
+                "total_agricultural_change": 4570
+            },
+            -1131
+        ),
+        (
+            "Afforestation",
+            {
+                "forest_change": 100,
+                "total_cropland_change": -1000,
+                "pasture_change": -50,
+                "total_agricultural_change": -1000
+            },
+            0
+        ),
+        (
+            "Pasture gain more than forest loss",
+            {
+                "forest_change": -49,
+                "total_cropland_change": -1000,
+                "pasture_change": 50,
+                "total_agricultural_change": -950
+            },
+            -49
+        )
+    ]
+)
+def test_estimate_maximum_forest_change(description, inputs, expected_output):
+    assert _estimate_maximum_forest_change(**inputs) == expected_output, description
+
+
+@pytest.mark.parametrize(
+    "description,inputs,expected_result",
+    [
+        ("All zeros, OK", {"a": 0, "b": 0, "c": 0.0, "d": 0.0}, True),
+        ("Exactly 1, OK", {"a": 0.1, "b": 0.5, "c": 0.4, "d": 0.0}, True),
+        ("Almost 1, OK", {"a": 0.1, "b": 0.5, "c": 0.4, "d": 0.01}, True),
+        ("Less than 1, Fail", {"a": 0.1, "b": 0, "c": 0.0, "d": 0.65}, False),
+        ("More than 1, Fail", {"a": 0.15, "b": 0.7, "c": 0.0, "d": 0.65}, False),
+    ]
+)
+def test_check_sum_of_percentages(description, inputs, expected_result):
+    assert site_area_sum_to_100(dict_of_percentages=inputs) == expected_result
+
+
+def test_get_sums_of_crop_expansion():
+    result = _get_sums_of_crop_expansion(
+        country_id="GADM-AFG",
+        year=2010,
+        include_negatives=True
+    )
+    assert result == (753973.3, 18354.0)
+
+    result = _get_sums_of_crop_expansion(
+        country_id="GADM-AFG",
+        year=2010,
+        include_negatives=False
+    )
+    assert result == (940270.0, 28139.0)
+
+
+@pytest.mark.parametrize(
+    "subfolder",
+    [
+        "albania_example",
+        "argentina_example",
+        "armenia_example",
+        "brazil_example",
+        "zimbabwe_example",
+        "brazil_empty_example",
+        "gbr_example"
+    ]
+)
+def test_run(subfolder):
+    folder = f"{fixtures_folder}/{subfolder}"
+    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)
+    assert result == expected

tests/models/ipcc2019/animal/test_milkYieldPerAnimal.py

@@ -0,0 +1,21 @@
+from unittest.mock import patch
+import json
+from tests.utils import fixtures_path, fake_new_practice
+
+from hestia_earth.models.ipcc2019 import MODEL
+from hestia_earth.models.ipcc2019.animal.milkYieldPerAnimal import MODEL_KEY, run
+
+class_path = f"hestia_earth.models.{MODEL}.animal.{MODEL_KEY}"
+fixtures_folder = f"{fixtures_path}/{MODEL}/animal/{MODEL_KEY}"
+
+
+@patch(f"{class_path}._new_practice", side_effect=fake_new_practice)
+def test_run(*args):
+    with open(f"{fixtures_folder}/cycle.jsonld", encoding='utf-8') as f:
+        cycle = json.load(f)
+
+    with open(f"{fixtures_folder}/result.jsonld", encoding='utf-8') as f:
+        expected = json.load(f)
+
+    value = run(cycle)
+    assert value == expected

tests/models/ipcc2019/test_co2ToAirSoilOrganicCarbonStockChange.py

@@ -10,8 +10,34 @@ from tests.utils import fake_new_emission, fixtures_path, order_list
 
 class_path = f"hestia_earth.models.{MODEL}.co2ToAirSoilOrganicCarbonStockChange"
 utils_path = f"hestia_earth.models.{MODEL}.co2ToAirCarbonStockChange_utils"
+soc_utils_path = f"hestia_earth.models.{MODEL}.organicCarbonPerHa_utils"
+term_folder = "hestia_earth.models.utils.term"
 fixtures_folder = f"{fixtures_path}/{MODEL}/co2ToAirSoilOrganicCarbonStockChange"
 
+
+IRRIGATED_TERM_IDS = [
+    "rainfedDeepWater",
+    "rainfedDeepWaterWaterDepth100Cm",
+    "rainfedDeepWaterWaterDepth50100Cm",
+    "irrigatedTypeUnspecified",
+    "irrigatedCenterPivotIrrigation",
+    "irrigatedContinuouslyFlooded",
+    "irrigatedDripIrrigation",
+    "irrigatedFurrowIrrigation",
+    "irrigatedLateralMoveIrrigation",
+    "irrigatedLocalizedIrrigation",
+    "irrigatedManualIrrigation",
+    "irrigatedSurfaceIrrigationMultipleDrainagePeriods",
+    "irrigatedSurfaceIrrigationSingleDrainagePeriod",
+    "irrigatedSprinklerIrrigation",
+    "irrigatedSubIrrigation",
+    "irrigatedSurfaceIrrigationDrainageRegimeUnspecified"
+]
+
+UPLAND_RICE_LAND_COVER_TERM_IDS = [
+    "ricePlantUpland"
+]
+
 RUN_SCENARIOS = [
     ("no-overlapping-cycles", 3),
     ("overlapping-cycles", 4),
@@ -47,7 +73,20 @@ RUN_IDS = [f"{param[0]}, cycle{param[2]}" for param in RUN_PARAMS]
 @patch(f"{class_path}._new_emission", side_effect=fake_new_emission)
 @patch(f"{utils_path}.related_cycles")
 @patch(f"{utils_path}._get_site")
-def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder, num_cycles, cycle_index):
+@patch(f"{soc_utils_path}.get_upland_rice_land_cover_terms", return_value=UPLAND_RICE_LAND_COVER_TERM_IDS)
+@patch(f"{soc_utils_path}.get_irrigated_terms", return_value=IRRIGATED_TERM_IDS)
+@patch(f"{term_folder}.search")
+def test_run(
+    search_mock,
+    get_irrigated_terms_mock,
+    get_upland_rice_land_cover_terms_mock,
+    _get_site_mock,
+    related_cycles_mock,
+    _new_emission_mock,
+    subfolder,
+    num_cycles,
+    cycle_index
+):
     """
     Test `run` function for each cycle in each scenario.
     """
@@ -63,6 +102,14 @@ def test_run(_get_site_mock, related_cycles_mock, _new_emission_mock, subfolder,
     related_cycles_mock.return_value = cycles
 
     result = run(cycle)
+
+    # Ensure that API calls to retrieve term IDs are properly cached.
+    get_irrigated_terms_mock.call_count <= 1
+    get_upland_rice_land_cover_terms_mock.call_count <= 1
+
+    # Ensure that the property and term utils are properly mocked.
+    search_mock.assert_not_called()
+
     assert order_list(result) == order_list(expected)
 
 

tests/models/utils/test_impact_assessment.py

@@ -1,7 +1,7 @@
-from hestia_earth.models.utils.impact_assessment import impact_lookup_value, get_region_id
+from hestia_earth.models.utils.impact_assessment import impact_emission_lookup_value, get_region_id
 
 
-def test_impact_lookup_value():
+def test_impact_emission_lookup_value():
     impact = {
         'emissionsResourceUse': [
             {
@@ -14,7 +14,7 @@ def test_impact_lookup_value():
         ]
     }
     # multiplies the emissionsResourceUse values with a coefficient
-    assert impact_lookup_value('', '', impact, 'co2EqGwp100ExcludingClimate-CarbonFeedbacksIpcc2013') == 2800
+    assert impact_emission_lookup_value('', '', impact, 'co2EqGwp100ExcludingClimate-CarbonFeedbacksIpcc2013') == 2800
 
 
 def test_get_region_id():