hestia-earth-models 0.74.10__py3-none-any.whl → 0.74.12__py3-none-any.whl

tests/models/hestia/test_landCover_utils.py

@@ -0,0 +1,233 @@
+import pytest
+
+from hestia_earth.models.hestia.utils import (
+    FOREST_LAND, PERMANENT_PASTURE, PERMANENT_CROPLAND, ANNUAL_CROPLAND, OTHER_LAND
+)
+from hestia_earth.models.hestia.landCover_utils import (
+    _get_changes, _estimate_maximum_forest_change,
+    _site_area_sum_to_100, _get_sums_of_crop_expansion, _get_sum_for_land_category, _scale_values_to_one,
+    _get_most_common_or_alphabetically_first, _get_land_cover_lookup_suffix, _get_ratio_between_land_use_types
+)
+
+
+@pytest.mark.parametrize(
+    "terms,expected_output",
+    [
+        (   # Only term
+            ["Annual crops", "Annual crops"],
+            "Annual crops"
+        ),
+        (  # Most common
+            ["Perennial crops", "Perennial crops", "Annual crops"],
+            "Perennial crops"
+        ),
+        (   # Tied frequency, Alphabetically first
+            ["Perennial crops", "Perennial crops", "Annual crops", "Annual crops"],
+            "Annual crops"
+        )
+    ]
+)
+def test_get_most_common_or_alphabetically_first(terms, expected_output):
+    actual_result = _get_most_common_or_alphabetically_first(terms)
+    assert actual_result == expected_output
+
+
+def test_get_changes():
+    result, missing_values = _get_changes(
+        country_id="GADM-AFG",
+        reference_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)
+
+
+def test_get_sum_for_land_category():
+    values = {
+        "mangoes_guavas_and_mangosteens": "2022:5",
+        "kiwi_fruit": "2020:4",
+        "maize_corn": "2020:3",
+        "other_beans_green": "2021:2",
+        "olives": "2020:-1"
+    }
+    fao_stat_to_ipcc_type = {
+            "mangoes_guavas_and_mangosteens": "Perennial crops",
+            'kiwi_fruit': "Perennial crops",
+            'maize_corn': "Annual crops",
+            'other_beans_green': "Annual crops",
+            'olives': "Perennial crops"
+    }
+    result = _get_sum_for_land_category(
+        values=values,
+        year=2020,
+        ipcc_land_use_category="Perennial crops",
+        fao_stat_to_ipcc_type=fao_stat_to_ipcc_type,
+        include_negatives=True
+    )
+    assert result == 3.0
+
+
+@pytest.mark.parametrize(
+    "dictionary,expected_result",
+    [
+        (
+            {"a": 0, "b": 0, "c": 0},
+            {"a": 0, "b": 0, "c": 0}
+        ),
+        (
+            {"a": 1000},
+            {"a": 1}
+        ),
+        (
+            {"a": 10, "b": 5, "c": 3},
+            {"a": 0.5556, "b": 0.2778, "c": 0.1667}
+        )
+    ]
+)
+def test_scale_values_to_one(dictionary, expected_result):
+    result = _scale_values_to_one(dictionary)
+    for k, v in result.items():
+        assert k in expected_result
+        assert round(v, 3) == round(expected_result[k], 3)
+
+
+@pytest.mark.parametrize(
+    "land_type,expected",
+    [
+        (FOREST_LAND, "forest"),
+        (ANNUAL_CROPLAND, "annualCropland"),
+        (PERMANENT_CROPLAND, "permanentCropland"),
+        (PERMANENT_PASTURE, "permanentPasture"),
+        (OTHER_LAND, "otherLand"),
+    ]
+)
+def test_get_land_cover_lookup_suffix(land_type: str, expected: str):
+    assert _get_land_cover_lookup_suffix(land_type=land_type) == expected, land_type
+
+
+def test_get_ratio_between_land_use_types():
+    result = _get_ratio_between_land_use_types(
+        country_id="GADM-ZWE",
+        reference_year=2004,
+        first_land_use_term="Arable land",
+        second_land_use_term="Permanent crops"
+    )
+    assert result == (3800.0, 57.417)

tests/models/hestia/test_slope.py

@@ -0,0 +1,23 @@
+from unittest.mock import patch, Mock
+
+from hestia_earth.models.hestia.slope import run
+
+class_path = 'hestia_earth.models.hestia.slope'
+
+
+@patch(f"{class_path}.related_cycles")
+def test_not_run(mock_related_cycles: Mock):
+    mock_related_cycles.return_value = [
+        {'products': [{'primary': True, 'term': {'@id': 'wheatGrain'}}]}
+    ]
+    result = run({})
+    assert not result
+
+
+@patch(f"{class_path}.related_cycles")
+def test_run(mock_related_cycles: Mock):
+    mock_related_cycles.return_value = [
+        {'products': [{'primary': True, 'term': {'@id': 'riceGrainInHuskFlooded'}}]}
+    ]
+    result = run({})
+    assert result[0]['value'] == [0]

tests/models/hestia/test_slopeLength.py

@@ -0,0 +1,23 @@
+from unittest.mock import patch, Mock
+
+from hestia_earth.models.hestia.slopeLength import run
+
+class_path = 'hestia_earth.models.hestia.slopeLength'
+
+
+@patch(f"{class_path}.related_cycles")
+def test_not_run(mock_related_cycles: Mock):
+    mock_related_cycles.return_value = [
+        {'products': [{'primary': True, 'term': {'@id': 'wheatGrain'}}]}
+    ]
+    result = run({})
+    assert not result
+
+
+@patch(f"{class_path}.related_cycles")
+def test_run(mock_related_cycles: Mock):
+    mock_related_cycles.return_value = [
+        {'products': [{'primary': True, 'term': {'@id': 'riceGrainInHuskFlooded'}}]}
+    ]
+    result = run({})
+    assert result[0]['value'] == [0]

tests/models/ipcc2019/test_no3ToGroundwaterExcreta.py

@@ -48,6 +48,7 @@ def test_run_cropland_dry(*args):
         expected = json.load(f)
 
     value = run(cycle)
+    print(json.dumps(value, indent=2))
     assert value == expected
 
 

tests/models/poschEtAl2008/test_terrestrialAcidificationPotentialAccumulatedExceedance.py

@@ -1,20 +1,15 @@
 import json
 from unittest.mock import patch
 
-from hestia_earth.models.poschEtAl2008.terrestrialAcidificationPotentialAccumulatedExceedance import MODEL, TERM_ID, \
-    run
+from hestia_earth.models.poschEtAl2008.terrestrialAcidificationPotentialAccumulatedExceedance import (
+    MODEL, TERM_ID, run
+)
 from tests.utils import fixtures_path, fake_new_indicator
 
 class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
 
-def fake_rounded_indicator(value: float):
-    indicator = fake_new_indicator(TERM_ID, MODEL)
-    indicator['value'] = round(value, 7)
-    return indicator
-
-
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run(*args):
     with open(f"{fixtures_folder}/impact-assessment.jsonld", encoding='utf-8') as f:
@@ -27,7 +22,7 @@ def test_run(*args):
     assert value == expected
 
 
-@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_lookup_to_bad_country(*args):
     """
     Should default to region-world value

tests/models/poschEtAl2008/test_terrestrialEutrophicationPotentialAccumulatedExceedance.py

@@ -1,20 +1,15 @@
 import json
 from unittest.mock import patch
 
-from hestia_earth.models.poschEtAl2008.terrestrialEutrophicationPotentialAccumulatedExceedance import MODEL, TERM_ID, \
-    run
+from hestia_earth.models.poschEtAl2008.terrestrialEutrophicationPotentialAccumulatedExceedance import (
+    MODEL, TERM_ID, run
+)
 from tests.utils import fixtures_path, fake_new_indicator
 
 class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
 
-def fake_rounded_indicator(value: float):
-    indicator = fake_new_indicator(TERM_ID, MODEL)
-    indicator['value'] = round(value, 7)
-    return indicator
-
-
 @patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_run(*args):
     with open(f"{fixtures_folder}/impact-assessment.jsonld", encoding='utf-8') as f:
@@ -27,7 +22,7 @@ def test_run(*args):
     assert value == expected
 
 
-@patch(f"{class_path}._indicator", side_effect=fake_rounded_indicator)
+@patch(f"{class_path}._new_indicator", side_effect=fake_new_indicator)
 def test_lookup_to_bad_country(*args):
     """
     Should default to region-world value

tests/models/utils/test_indicator.py

@@ -10,15 +10,17 @@ class_path = 'hestia_earth.models.utils.indicator'
 @patch(f"{class_path}.download_term", return_value=TERM)
 def test_new_indicator(*args):
     # with a Term as string
-    indicator = _new_indicator('term')
+    indicator = _new_indicator('term', value=0)
     assert indicator == {
         '@type': 'Indicator',
-        'term': TERM
+        'term': TERM,
+        'value': 0
     }
 
     # with a Term as dict
-    indicator = _new_indicator(TERM)
+    indicator = _new_indicator(TERM, value=0)
     assert indicator == {
         '@type': 'Indicator',
-        'term': TERM
+        'term': TERM,
+        'value': 0
     }

tests/models/utils/test_measurement.py

@@ -12,21 +12,23 @@ class_path = 'hestia_earth.models.utils.measurement'
 fixtures_folder = f"{fixtures_path}/utils/measurement"
 
 
-@patch(f"{class_path}.include_method", side_effect=lambda n, **kwargs: n)
+@patch(f"{class_path}.include_method", side_effect=lambda n, *args: n)
 @patch(f"{class_path}.download_term", return_value=TERM)
 def test_new_measurement(*args):
     # with a Term as string
-    measurement = _new_measurement('term')
+    measurement = _new_measurement(term='term', value=[0])
     assert measurement == {
         '@type': 'Measurement',
-        'term': TERM
+        'term': TERM,
+        'value': [0]
     }
 
     # with a Term as dict
-    measurement = _new_measurement(TERM)
+    measurement = _new_measurement(term=TERM, value=[0])
     assert measurement == {
         '@type': 'Measurement',
-        'term': TERM
+        'term': TERM,
+        'value': [0]
     }