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

tests/models/utils/test_blank_node.py

@@ -17,7 +17,9 @@ from hestia_earth.models.utils.blank_node import (
     DatestrGapfillMode,
     DatetimeRange,
     get_node_value,
-    group_nodes_by_year
+    group_nodes_by_year,
+    group_nodes_by_year_and_month,
+    GroupNodesByYearMode
 )
 
 
@@ -456,6 +458,11 @@ def test_get_date_month_day():
     assert _get_datestr_format(DATESTR_MONTH_DAY), DatestrFormat.MONTH_DAY
 
 
+def test_get_datestr_format_no_zero_padding():
+    DATE_STR = "2000-1"
+    assert _get_datestr_format(DATE_STR) is None
+
+
 # --- test _gapfill_datestr ---
 
 
@@ -545,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.
 
@@ -558,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
         }]
     }
@@ -594,7 +601,60 @@ def test_group_nodes_scenario_a():
     assert result == EXPECTED
 
 
-def test_group_nodes_scenario_b():
+def test_group_nodes_by_year_scenario_a_with_inner_key():
+
+    INNER_KEY = "inner_key"
+    EXPECTED = {
+        2002: {
+            INNER_KEY: [{
+                "@id": "cycle-1a",
+                "endDate": "2002",
+                "fraction_of_group_duration": 1.0,
+                "fraction_of_node_duration": 1.0
+            }]
+        },
+        2003: {
+            INNER_KEY: [{
+                "@id": "cycle-2a",
+                "endDate": "2003",
+                "fraction_of_group_duration": 1.0,
+                "fraction_of_node_duration": 1.0
+            }]
+        },
+        2004: {
+            INNER_KEY: [{
+                "@id": "cycle-3a",
+                "endDate": "2006",
+                "startDate": "2004",
+                "fraction_of_group_duration": 1.0,
+                "fraction_of_node_duration": 0.33394160583941607
+            }]
+        },
+        2005: {
+            INNER_KEY: [{
+                "@id": "cycle-3a",
+                "endDate": "2006",
+                "startDate": "2004",
+                "fraction_of_group_duration": 1.0,
+                "fraction_of_node_duration": 0.333029197080292
+            }]
+        },
+        2006: {
+            INNER_KEY: [{
+                "@id": "cycle-3a",
+                "endDate": "2006",
+                "startDate": "2004",
+                "fraction_of_group_duration": 1.0,
+                "fraction_of_node_duration": 0.333029197080292
+            }]
+        }
+    }
+
+    result = group_nodes_by_year(GROUP_NODES_BY_YEAR_SCENARIO_A_CYCLES, inner_key=INNER_KEY)
+    assert result == EXPECTED
+
+
+def test_group_nodes_by_year_scenario_b():
     """
     Datestr in format `YYYY-MM-DD`. Two concurrent cycles (`cycle-3b` & `cycle-4b`).
     """
@@ -612,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
             }
         ],
@@ -621,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
             }
         ],
@@ -630,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
             }
         ]
@@ -647,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.
     """
@@ -666,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
             }
         ],
@@ -682,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
             }
         ],
@@ -705,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
             }
         ]
@@ -722,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
@@ -774,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
             },
             {
@@ -782,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
             }
         ],
@@ -792,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
             },
             {
@@ -800,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
             },
             {
@@ -808,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
             },
             {
@@ -816,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
             }
         ],
@@ -826,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
             }
         ]
@@ -836,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
@@ -859,14 +919,150 @@ 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
             }
         ]
     }
 
-    result = group_nodes_by_year(
-        MANAGEMENT,
-        # gapfill_incomplete_datestrs=False
-    )
+    result = group_nodes_by_year(MANAGEMENT)
+    assert result == EXPECTED
+
+
+def test_group_nodes_by_year_missing_dates():
+
+    NODES = [
+        {"value": [0], "endDate": "2000-12-31", "startDate": "2000-01-01"},
+        {"value": [1], "endDate": "2000-12-31", "startDate": "2000-01-01"},
+        {"value": [2], "endDate": "2001-12-31", "startDate": "2001-01-01"},
+        {"value": [3], "dates": ["2001-12-31"]},
+        {"value": [4], "dates": ["2002"]},
+        {"value": [5], "dates": ["2003-06"]}
+    ]
+
+    EXPECTED = {
+        2001: [{
+            "value": [3],
+            "dates": ["2001-12-31"],
+            "fraction_of_group_duration": 0.0027397260273972603,
+            "fraction_of_node_duration": 1.0
+        }],
+        2002: [{
+            "value": [4],
+            "dates": ["2002"],
+            "fraction_of_group_duration": 1.0,
+            "fraction_of_node_duration": 1.0
+        }],
+        2003: [{
+            "value": [5],
+            "dates": ["2003-06"],
+            "fraction_of_group_duration": 0.0821917808219178,
+            "fraction_of_node_duration": 1.0
+        }]
+    }
+
+    result = group_nodes_by_year(NODES, mode=GroupNodesByYearMode.DATES)
+    assert result == EXPECTED
+
+
+def test_group_nodes_by_year_multiple_values_and_dates():
+
+    NODES = [{
+        "value": [1, 2, 3, 4, 5],
+        "dates": [
+            "2000-01",
+            "2000-06",
+            "2001-02",
+            "2002-03",
+            "2003-01"
+        ]
+    }]
+
+    EXPECTED = {
+        2000: [{
+            "dates": ["2000-01", "2000-06"],
+            "fraction_of_node_duration": 0.32475598935226263,
+            "fraction_of_group_duration": 1.0,
+            "value": [1, 2]
+        }],
+        2001: [{
+            "dates": ["2001-02"],
+            "fraction_of_node_duration": 0.323868677905945,
+            "fraction_of_group_duration": 1.0,
+            "value": [3]
+        }],
+        2002: [{
+            "dates": ["2002-03"],
+            "fraction_of_node_duration": 0.323868677905945,
+            "fraction_of_group_duration": 1.0,
+            "value": [4]
+        }],
+        2003: [{
+            "dates": ["2003-01"],
+            "fraction_of_node_duration": 0.027506654835847383,
+            "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]