hestia-earth-models 0.58.0__py3-none-any.whl → 0.59.0__py3-none-any.whl

tests/models/site/test_organicCarbonPerHa.py

@@ -5,13 +5,19 @@ from unittest.mock import patch
 from tests.utils import fixtures_path, fake_new_measurement
 
 from hestia_earth.models.site.organicCarbonPerHa import (
-    MODEL, TERM_ID, run, _cdf, _c_to_depth, _get_last_date, _should_run_measurements
+    MODEL, TERM_ID, run, _cdf, _c_to_depth, _get_most_relevant_soc_node, _get_last_date, _should_run_calculation_group
 )
 
 class_path = f"hestia_earth.models.{MODEL}.{TERM_ID}"
 fixtures_folder = f"{fixtures_path}/{MODEL}/{TERM_ID}"
 
-SUBFOLDERS = ["calculate", "rescale", "calculate-and-rescale"]
+SUBFOLDERS = [
+    "calculate-single",
+    "calculate-multiple",
+    "rescale-single",
+    "rescale-multiple",
+    "calculate-and-rescale"
+]
 
 
 @mark.parametrize("depth, expected", [(0, 0), (1, 10.41666666666667)], ids=["0m", "1m"])
@@ -36,21 +42,55 @@ def test_cdf(depth_upper, depth_lower, expected):
         (["2020-01-01", "2020-02-28"], "2020-02-28"),
         ([], None)
     ],
-    ids=["YYYY", "YYYY-MM", "YYYY-MM-DD", "Empty list"]
+    ids=["YYYY", "YYYY-MM", "YYYY-MM-DD", "empty-list"]
 )
 def test_get_node_date(dates, expected):
     assert _get_last_date(dates) == expected
 
 
+@mark.parametrize(
+    "nodes, expected_id",
+    [
+        (
+            [
+                {"@id": "1", "depthUpper": 0, "depthLower": 10},
+                {"@id": "2", "depthUpper": 0, "depthLower": 40},
+                {"@id": "3", "depthUpper": 0, "depthLower": 100}
+            ],
+            "2"
+        ),
+        (
+            [
+                {"@id": "1", "depthUpper": 0, "depthLower": 5},
+                {"@id": "2", "depthUpper": 0, "depthLower": 10},
+                {"@id": "3", "depthUpper": 0, "depthLower": 20}
+            ],
+            "3"
+        ),
+        (
+            [
+                {"@id": "1", "depthUpper": 0, "depthLower": 20},
+                {"@id": "2", "depthUpper": 0, "depthLower": 40},
+                {"@id": "3", "depthUpper": 0, "depthLower": 100}
+            ],
+            "2"
+        )
+    ],
+    ids=["simple", "no-priority", "tie"]
+)
+def test_get_most_relevant_soc_node(nodes, expected_id):
+    assert _get_most_relevant_soc_node(nodes).get("@id") == expected_id
+
+
 @patch(f"{class_path}.find_term_match")
 def test_should_run_measurements(mock_find):
     # no measurement => no run
     mock_find.return_value = {}
-    assert not _should_run_measurements({}, [])
+    assert _should_run_calculation_group([]) is False
 
     # with measurement => run
     mock_find.return_value = {'value': [10], 'depthUpper': 0, 'depthLower': 10}
-    assert _should_run_measurements({}, []) is True
+    assert _should_run_calculation_group([]) is True
 
 
 @mark.parametrize("subfolder", SUBFOLDERS)
@@ -65,3 +105,9 @@ def test_run(_new_measurement_mock, get_source_mock, subfolder):
 
     value = run(site)
     assert value == expected
+
+
+@patch(f"{class_path}.get_source", return_value={})
+@patch(f"{class_path}._new_measurement", side_effect=fake_new_measurement)
+def test_run_empty(_new_measurement_mock, get_source_mock):
+    assert run({}) == []

tests/models/utils/test_blank_node.py

@@ -18,6 +18,7 @@ from hestia_earth.models.utils.blank_node import (
     DatetimeRange,
     get_node_value,
     group_nodes_by_year,
+    group_nodes_by_year_and_month,
     GroupNodesByYearMode
 )
 
@@ -551,7 +552,7 @@ GROUP_NODES_BY_YEAR_SCENARIO_A_CYCLES = [
 ]
 
 
-def test_group_nodes_scenario_a():
+def test_group_nodes_by_year_scenario_a():
     """
     Datestr in format `YYYY`. Some nodes missing `startDate` field. One multi-year cycle.
 
@@ -564,34 +565,34 @@ def test_group_nodes_scenario_a():
         2002: [{
             "@id": "cycle-1a",
             "endDate": "2002",
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 1.0
         }],
         2003: [{
             "@id": "cycle-2a",
             "endDate": "2003",
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 1.0
         }],
         2004: [{
             "@id": "cycle-3a",
             "endDate": "2006",
             "startDate": "2004",
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 0.33394160583941607
         }],
         2005: [{
             "@id": "cycle-3a",
             "endDate": "2006",
             "startDate": "2004",
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 0.333029197080292
         }],
         2006: [{
             "@id": "cycle-3a",
             "endDate": "2006",
             "startDate": "2004",
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 0.333029197080292
         }]
     }
@@ -600,7 +601,7 @@ def test_group_nodes_scenario_a():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_a_with_inner_key():
+def test_group_nodes_by_year_scenario_a_with_inner_key():
 
     INNER_KEY = "inner_key"
     EXPECTED = {
@@ -608,7 +609,7 @@ def test_group_nodes_scenario_a_with_inner_key():
             INNER_KEY: [{
                 "@id": "cycle-1a",
                 "endDate": "2002",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }]
         },
@@ -616,7 +617,7 @@ def test_group_nodes_scenario_a_with_inner_key():
             INNER_KEY: [{
                 "@id": "cycle-2a",
                 "endDate": "2003",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }]
         },
@@ -625,7 +626,7 @@ def test_group_nodes_scenario_a_with_inner_key():
                 "@id": "cycle-3a",
                 "endDate": "2006",
                 "startDate": "2004",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 0.33394160583941607
             }]
         },
@@ -634,7 +635,7 @@ def test_group_nodes_scenario_a_with_inner_key():
                 "@id": "cycle-3a",
                 "endDate": "2006",
                 "startDate": "2004",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 0.333029197080292
             }]
         },
@@ -643,7 +644,7 @@ def test_group_nodes_scenario_a_with_inner_key():
                 "@id": "cycle-3a",
                 "endDate": "2006",
                 "startDate": "2004",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 0.333029197080292
             }]
         }
@@ -653,7 +654,7 @@ def test_group_nodes_scenario_a_with_inner_key():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_b():
+def test_group_nodes_by_year_scenario_b():
     """
     Datestr in format `YYYY-MM-DD`. Two concurrent cycles (`cycle-3b` & `cycle-4b`).
     """
@@ -671,7 +672,7 @@ def test_group_nodes_scenario_b():
                 "@id": "cycle-1b",
                 "endDate": "2000-12-31",
                 "startDate": "2000-01-01",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }
         ],
@@ -680,7 +681,7 @@ def test_group_nodes_scenario_b():
                 "@id": "cycle-2b",
                 "endDate": "2001-12-31",
                 "startDate": "2001-01-01",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }
         ],
@@ -689,14 +690,14 @@ def test_group_nodes_scenario_b():
                 "@id": "cycle-3b",
                 "endDate": "2002-12-31",
                 "startDate": "2002-01-01",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             },
             {
                 "@id": "cycle-4b",
                 "endDate": "2002-12-31",
                 "startDate": "2002-01-01",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }
         ]
@@ -706,7 +707,7 @@ def test_group_nodes_scenario_b():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_c():
+def test_group_nodes_by_year_scenario_c():
     """
     Multiple overlapping 6 month and 12 month cycles.
     """
@@ -725,14 +726,14 @@ def test_group_nodes_scenario_c():
                 "@id": "cycle-1c",
                 "endDate": "2000-06",
                 "startDate": "2000-01",
-                "fraction_of_year": 0.4972677595628415,
+                "fraction_of_group_duration": 0.4972677595628415,
                 "fraction_of_node_duration": 1.0
             },
             {
                 "@id": "cycle-2c",
                 "endDate": "2001-12",
                 "startDate": "2000-07",
-                "fraction_of_year": 0.5027322404371585,
+                "fraction_of_group_duration": 0.5027322404371585,
                 "fraction_of_node_duration": 0.33515482695810567
             }
         ],
@@ -741,21 +742,21 @@ def test_group_nodes_scenario_c():
                 "@id": "cycle-2c",
                 "endDate": "2001-12",
                 "startDate": "2000-07",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 0.6648451730418944
             },
             {
                 "@id": "cycle-3c",
                 "endDate": "2001-06",
                 "startDate": "2001-01",
-                "fraction_of_year": 0.4958904109589041,
+                "fraction_of_group_duration": 0.4958904109589041,
                 "fraction_of_node_duration": 1.0
             },
             {
                 "@id": "cycle-4c",
                 "endDate": "2002-06",
                 "startDate": "2001-07",
-                "fraction_of_year": 0.5041095890410959,
+                "fraction_of_group_duration": 0.5041095890410959,
                 "fraction_of_node_duration": 0.5041095890410959
             }
         ],
@@ -764,14 +765,14 @@ def test_group_nodes_scenario_c():
                 "@id": "cycle-4c",
                 "endDate": "2002-06",
                 "startDate": "2001-07",
-                "fraction_of_year": 0.4958904109589041,
+                "fraction_of_group_duration": 0.4958904109589041,
                 "fraction_of_node_duration": 0.4958904109589041
             },
             {
                 "@id": "cycle-5c",
                 "endDate": "2002-12",
                 "startDate": "2002-01",
-                "fraction_of_year": 1.0,
+                "fraction_of_group_duration": 1.0,
                 "fraction_of_node_duration": 1.0
             }
         ]
@@ -781,7 +782,7 @@ def test_group_nodes_scenario_c():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_d():
+def test_group_nodes_by_year_scenario_d():
     """
     Cases where nodes only overlap with year groups by a small amount.
     Overlaps of less than 30% of a year should be not be included in a
@@ -833,7 +834,7 @@ def test_group_nodes_scenario_d():
                 "term.@id": "fullTillage",
                 "endDate": "2000-11",
                 "value": 100,
-                "fraction_of_year": 0.9153005464480874,
+                "fraction_of_group_duration": 0.9153005464480874,
                 "fraction_of_node_duration": 0.9153005464480874
             },
             {
@@ -841,7 +842,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2000-11",
                 "startDate": "2000-09",
                 "value": True,
-                "fraction_of_year": 0.24863387978142076,
+                "fraction_of_group_duration": 0.24863387978142076,
                 "fraction_of_node_duration": 1.0
             }
         ],
@@ -851,7 +852,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2001-07",
                 "startDate": "2000-12",
                 "value": 50,
-                "fraction_of_year": 0.5808219178082191,
+                "fraction_of_group_duration": 0.5808219178082191,
                 "fraction_of_node_duration": 0.8724279835390947
             },
             {
@@ -859,7 +860,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2001-07",
                 "startDate": "2000-12",
                 "value": 50,
-                "fraction_of_year": 0.5808219178082191,
+                "fraction_of_group_duration": 0.5808219178082191,
                 "fraction_of_node_duration": 0.8724279835390947
             },
             {
@@ -867,7 +868,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2002-01",
                 "startDate": "2001-08",
                 "value": 100,
-                "fraction_of_year": 0.4191780821917808,
+                "fraction_of_group_duration": 0.4191780821917808,
                 "fraction_of_node_duration": 0.8315217391304348
             },
             {
@@ -875,7 +876,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2002-06",
                 "startDate": "2001-07",
                 "value": True,
-                "fraction_of_year": 0.5041095890410959,
+                "fraction_of_group_duration": 0.5041095890410959,
                 "fraction_of_node_duration": 0.5041095890410959
             }
         ],
@@ -885,7 +886,7 @@ def test_group_nodes_scenario_d():
                 "endDate": "2002-06",
                 "startDate": "2001-07",
                 "value": True,
-                "fraction_of_year": 0.4958904109589041,
+                "fraction_of_group_duration": 0.4958904109589041,
                 "fraction_of_node_duration": 0.4958904109589041
             }
         ]
@@ -895,7 +896,7 @@ def test_group_nodes_scenario_d():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_e():
+def test_group_nodes_by_year_scenario_e():
     """
     Edge case where nodes with short durations are equally split between two
     year groups. In this case, they should be categorised as the later of the
@@ -918,7 +919,7 @@ def test_group_nodes_scenario_e():
                 "endDate": "2001-01",
                 "startDate": "2000-12",
                 "value": 100,
-                "fraction_of_year": 0.08493150684931507,
+                "fraction_of_group_duration": 0.08493150684931507,
                 "fraction_of_node_duration": 0.50
             }
         ]
@@ -943,19 +944,19 @@ def test_group_nodes_by_year_missing_dates():
         2001: [{
             "value": [3],
             "dates": ["2001-12-31"],
-            "fraction_of_year": 0.0027397260273972603,
+            "fraction_of_group_duration": 0.0027397260273972603,
             "fraction_of_node_duration": 1.0
         }],
         2002: [{
             "value": [4],
             "dates": ["2002"],
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "fraction_of_node_duration": 1.0
         }],
         2003: [{
             "value": [5],
             "dates": ["2003-06"],
-            "fraction_of_year": 0.0821917808219178,
+            "fraction_of_group_duration": 0.0821917808219178,
             "fraction_of_node_duration": 1.0
         }]
     }
@@ -981,28 +982,87 @@ def test_group_nodes_by_year_multiple_values_and_dates():
         2000: [{
             "dates": ["2000-01", "2000-06"],
             "fraction_of_node_duration": 0.32475598935226263,
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "value": [1, 2]
         }],
         2001: [{
             "dates": ["2001-02"],
             "fraction_of_node_duration": 0.323868677905945,
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "value": [3]
         }],
         2002: [{
             "dates": ["2002-03"],
             "fraction_of_node_duration": 0.323868677905945,
-            "fraction_of_year": 1.0,
+            "fraction_of_group_duration": 1.0,
             "value": [4]
         }],
         2003: [{
             "dates": ["2003-01"],
             "fraction_of_node_duration": 0.027506654835847383,
-            "fraction_of_year": 0.08493150684931507,
+            "fraction_of_group_duration": 0.08493150684931507,
             "value": [5]
         }]
     }
 
     result = group_nodes_by_year(NODES, mode=GroupNodesByYearMode.DATES)
     assert result == EXPECTED
+
+
+def test_group_nodes_by_year_and_month():
+    MANAGEMENT = [
+        {
+            "term.@id": "fullTillage",
+            "endDate": "2001-01",
+            "startDate": "2000-12",
+            "value": 100
+        },
+        {
+            "term.@id": "reducedTillage",
+            "endDate": "2001-10",
+            "startDate": "2001-09",
+            "value": 100
+        }
+    ]
+
+    EXPECTED = {
+        2000: {
+            12: [
+                {
+                    "term.@id": "fullTillage",
+                    "endDate": "2001-01",
+                    "startDate": "2000-12",
+                    "value": 100,
+                }
+            ]
+        },
+        2001: {
+            1: [
+                {
+                    "term.@id": "fullTillage",
+                    "endDate": "2001-01",
+                    "startDate": "2000-12",
+                    "value": 100,
+                }
+            ],
+            9: [
+                {
+                    "term.@id": "reducedTillage",
+                    "endDate": "2001-10",
+                    "startDate": "2001-09",
+                    "value": 100,
+                }
+            ],
+            10: [
+                {
+                    "term.@id": "reducedTillage",
+                    "endDate": "2001-10",
+                    "startDate": "2001-09",
+                    "value": 100,
+                }
+            ],
+        }
+    }
+
+    result = group_nodes_by_year_and_month(MANAGEMENT)
+    assert result == EXPECTED

tests/models/utils/test_term.py

@@ -4,7 +4,7 @@ from hestia_earth.models.utils.term import (
     get_liquid_fuel_terms, get_irrigation_terms, get_urea_terms, get_excreta_N_terms, get_excreta_VS_terms,
     get_generic_crop, get_rice_paddy_terms, get_tillage_terms, get_crop_residue_terms, get_cover_crop_property_terms,
     get_crop_residue_incorporated_or_left_on_field_terms, get_irrigated_terms, get_residue_removed_or_burnt_terms,
-    get_rice_plant_upland_terms
+    get_upland_rice_land_cover_terms, get_upland_rice_crop_terms, get_long_fallow_land_cover_terms
 )
 
 class_path = 'hestia_earth.models.utils.term'
@@ -102,7 +102,21 @@ def test_get_residue_removed_or_burnt_terms(mock_find_node):
 
 
 @patch(f"{class_path}.search")
-def test_get_rice_plant_upland_terms(mock_find_node):
+def test_get_upland_rice_land_cover_terms(mock_find_node):
     id = 'term-id'
     mock_find_node.return_value = [{'@id': id}]
-    assert get_rice_plant_upland_terms() == [id]
+    assert get_upland_rice_land_cover_terms() == [id]
+
+
+@patch(f"{class_path}.search")
+def test_get_upland_rice_crop_terms(mock_find_node):
+    id = 'term-id'
+    mock_find_node.return_value = [{'@id': id}]
+    assert get_upland_rice_crop_terms() == [id]
+
+
+@patch(f"{class_path}.search")
+def test_get_long_fallow_land_cover_terms(mock_find_node):
+    id = 'term-id'
+    mock_find_node.return_value = [{'@id': id}]
+    assert get_long_fallow_land_cover_terms() == [id]