Merge remote-tracking branch 'origin/develop' into feature/conftest-for-common-fixtures

Author: spjuhel

CHANGELOG.md

@@ -12,6 +12,8 @@ Code freeze date: YYYY-MM-DD
 
 ### Added
 
+- Better type hints and overloads signatures for ImpactFuncSet [#1250](https://github.com/CLIMADA-project/climada_python/pull/1250)
+
 ### Changed
 - Updated Impact Calculation Tutorial (`doc.climada_engine_Impact.ipynb`) [#1095](https://github.com/CLIMADA-project/climada_python/pull/1095).
 
@@ -23,7 +25,7 @@ Code freeze date: YYYY-MM-DD
 
 ### Removed
 - `climada.util.earth_engine.py` Google Earth Engine methods did not facilitate direct use of GEE data in CLIMADA. Code was relocated to [climada-snippets](https://github.com/CLIMADA-project/climada-snippets). [#1109](https://github.com/CLIMADA-project/climada_python/pull/1109)
-- `doc.climada_util_earth_engine.ipynb` Tutorial about GEE not relevant to CLIMADA Core. Tutorial notebook was relocated to [climada-snippets](https://github.com/CLIMADA-project/climada-snippets).[#1109](https://github.com/CLIMADA-project/climada_python/pull/1109)
+- `doc.climada_util_earth_engine.ipynb` Tutorial about GEE not relevant to CLIMADA Core. Tutorial notebook was relocated to [climada-snippets](https://github.com/CLIMADA-project/climada-snippets). [#1109](https://github.com/CLIMADA-project/climada_python/pull/1109)
 
 ## 6.1.0
 
@@ -156,9 +158,9 @@ Removed:
 - `climada.entity.impact_funcs.trop_cyclone.ImpfSetTropCyclone.get_impf_id_regions_per_countries` function [#1034](https://github.com/CLIMADA-project/climada_python/pull/1034)
 - `climada.hazard.tc_tracks.BasinBoundsStorm` Enum class `climada.hazard.tc_tracks.subset_by_basin` function [#1031](https://github.com/CLIMADA-project/climada_python/pull/1031)
 - `climada.hazard.tc_tracks.TCTracks.subset_years` function [#1023](https://github.com/CLIMADA-project/climada_python/pull/1023)
--`climada.hazard.tc_tracks.compute_track_density` function, `climada.hazard.tc_tracks.compute_genesis_density` function, `climada.hazard.plot.plot_track_density` function
+- `climada.hazard.tc_tracks.compute_track_density` function, `climada.hazard.tc_tracks.compute_genesis_density` function, `climada.hazard.plot.plot_track_density` function
  [#1003](https://github.com/CLIMADA-project/climada_python/pull/1003)
--`climada.hazard.tc_tracks.TCTracks.from_FAST` function, add Australia basin (AU) [#993](https://github.com/CLIMADA-project/climada_python/pull/993)
+- `climada.hazard.tc_tracks.TCTracks.from_FAST` function, add Australia basin (AU) [#993](https://github.com/CLIMADA-project/climada_python/pull/993)
 - Add `osm-flex` package to CLIMADA core [#981](https://github.com/CLIMADA-project/climada_python/pull/981)
 - `doc.tutorial.climada_entity_Exposures_osm.ipynb` tutorial explaining how to use `osm-flex` with CLIMADA
 - `climada.util.coordinates.bounding_box_global` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)

climada/data/system/entity_template.xlsx

@@ -41,22 +41,18 @@
 from climada.entity import Exposures, ImpactFunc, ImpactFuncSet
 from climada.entity.entity_def import Entity
 from climada.hazard import Hazard
-from climada.util.api_client import Client
+from climada.test import get_test_file
 from climada.util.constants import (
     ENT_DEMO_FUTURE,
     ENT_DEMO_TODAY,
-    EXP_DEMO_H5,
     HAZ_DEMO_H5,
     TEST_UNC_OUTPUT_COSTBEN,
     TEST_UNC_OUTPUT_IMPACT,
 )
 
-test_unc_output_impact = Client().get_dataset_file(
-    name=TEST_UNC_OUTPUT_IMPACT, status="test_dataset"
-)
-test_unc_output_costben = Client().get_dataset_file(
-    name=TEST_UNC_OUTPUT_COSTBEN, status="test_dataset"
-)
+EXP_DEMO_H5 = get_test_file("exp_demo_today", file_format="hdf5")
+test_unc_output_impact = get_test_file(TEST_UNC_OUTPUT_IMPACT)
+test_unc_output_costben = get_test_file(TEST_UNC_OUTPUT_COSTBEN)
 
 
 def impf_dem(x_paa=1, x_mdd=1):
@@ -578,7 +574,7 @@ def test_calc_sensitivity_all_pass(self):
                 "sensitivity_kwargs": {"S": 10, "seed": 12345},
                 "test_param_name": ["x_exp", 0],
                 "test_si_name": ["CV", 16],
-                "test_si_value": [0.25000, 2],
+                "test_si_value": [0.250000, 2],
             },
             "hdmr": {
                 "sampling_method": "saltelli",
@@ -587,7 +583,7 @@ def test_calc_sensitivity_all_pass(self):
                 "sensitivity_kwargs": {},
                 "test_param_name": ["x_exp", 2],
                 "test_si_name": ["Sa", 4],
-                "test_si_value": [0.004658, 3],
+                "test_si_value": [0.004649, 3],
             },
             "ff": {
                 "sampling_method": "ff",
@@ -618,7 +614,7 @@ def test_calc_sensitivity_all_pass(self):
                 },
                 "test_param_name": ["x_exp", 0],
                 "test_si_name": ["dgsm", 8],
-                "test_si_value": [1.697516e-01, 9],
+                "test_si_value": [0.1697516, 9],
             },
             "fast": {
                 "sampling_method": "fast_sampler",
@@ -627,7 +623,7 @@ def test_calc_sensitivity_all_pass(self):
                 "sensitivity_kwargs": {"M": 4, "seed": 12345},
                 "test_param_name": ["x_exp", 0],
                 "test_si_name": ["S1_conf", 8],
-                "test_si_value": [0.671396, 1],
+                "test_si_value": [0.671546, 1],
             },
             "rbd_fast": {
                 "sampling_method": "saltelli",
@@ -636,7 +632,7 @@ def test_calc_sensitivity_all_pass(self):
                 "sensitivity_kwargs": {"M": 4, "seed": 12345},
                 "test_param_name": ["x_exp", 0],
                 "test_si_name": ["S1_conf", 4],
-                "test_si_value": [0.152609, 4],
+                "test_si_value": [0.129919, 4],
             },
             "morris": {
                 "sampling_method": "morris",
@@ -645,7 +641,7 @@ def test_calc_sensitivity_all_pass(self):
                 "sensitivity_kwargs": {},
                 "test_param_name": ["x_exp", 0],
                 "test_si_name": ["mu", 1],
-                "test_si_value": [5066460029.63911, 8],
+                "test_si_value": [7935400297.813827, 8],
             },
         }
 
@@ -700,7 +696,7 @@ def test_sensitivity_method(
                 haz_unc,
                 sensitivity_method,
                 method_params,
-                places=2 if sensitivity_method == "rbd_fast" else 5,
+                places=5,
             )
 
 

climada/engine/unsequa/test/test_unsequa.py

@@ -403,6 +403,9 @@ def __init__(
 
         self.description = self._consolidate(meta, "description", description)
         self.ref_year = self._consolidate(meta, "ref_year", ref_year, DEF_REF_YEAR)
+
+        if geodata.shape[0] > 0:
+            value_unit = self._consolidate(geodata.iloc[0], "value_unit", value_unit)
         self.value_unit = self._consolidate(
             meta, "value_unit", value_unit, DEF_VALUE_UNIT
         )
@@ -644,15 +647,17 @@ def assign_centroids(
 
         Caution: nearest neighbourg matching can introduce serious artefacts
         such as:
-            - exposure and hazard centroids with shifted grids can lead
-            to systematically wrong assignements.
-            - hazard centroids covering larger areas than exposures may lead
-            to sub-optimal matching if the threshold is too large
-            - projected crs often diverge at the anti-meridian and close points
-            on either side will be at a large distance. For proper handling
-            of the anti-meridian please use degree coordinates in EPSG:4326.
-            This might be relevant for countries like the Fidji or the US that
-            cross the anti-meridian.
+
+        - exposure and hazard centroids with shifted grids can lead
+          to systematically wrong assignements.
+        - hazard centroids covering larger areas than exposures may lead
+          to sub-optimal matching if the threshold is too large
+        - projected crs often diverge at the anti-meridian and close points
+          on either side will be at a large distance. For proper handling
+          of the anti-meridian please use degree coordinates in EPSG:4326.
+          This might be relevant for countries like the Fidji or the US that
+          cross the anti-meridian.
+
 
         Users are free to implement their own matching alrogithm and save the
         matching centroid index in the appropriate column ``centr_[hazard.HAZ_TYPE]``.

climada/entity/exposures/base.py

@@ -182,7 +182,7 @@ def test__init__mda_in_kwargs(self):
     def test_read_raster_pass(self):
         """from_raster"""
         exp = Exposures.from_raster(
-            HAZ_DEMO_FL, window=Window(10, 20, 50, 60), attrs={"value_unit": "USD"}
+            HAZ_DEMO_FL, window=Window(10, 20, 50, 60), attrs={"value_unit": "PKR"}
         )
         exp.check()
         self.assertTrue(u_coord.equal_crs(exp.crs, DEF_CRS))
@@ -204,7 +204,7 @@ def test_read_raster_pass(self):
         self.assertAlmostEqual(
             exp.gdf["value"].values.reshape((60, 50))[25, 12], 0.056825936
         )
-        self.assertEqual(exp.value_unit, "USD")
+        self.assertEqual(exp.value_unit, "PKR")
 
     def test_assign_raster_pass(self):
         """Test assign_centroids with raster hazard"""
@@ -429,16 +429,23 @@ def test_read_template_pass(self):
         exp_df = Exposures(df)
         # set metadata
         exp_df.ref_year = 2020
-        exp_df.value_unit = "XSD"
+        exp_df.value_unit = "PAK"
         exp_df.check()
 
+    def test_handling_unit_conflicts_pass(self):
+        """Check that the value_unit is correctly set when there are conflicting value_unit definitions in the data frame and the meta attribute."""
+        df = pd.read_excel(ENT_TEMPLATE_XLS)
+        exp_df = Exposures(df, meta={"value_unit": "XSD"}, value_unit="XSD")
+        exp_df.check()
+        self.assertEqual(exp_df.value_unit, "XSD")
+        with self.assertRaises(ValueError) as cm:
+            exp_df = Exposures(df, meta={"value_unit": "XSD"}, value_unit="PAK")
+
     def test_io_hdf5_pass(self):
         """write and read hdf5"""
-        exp = Exposures(pd.read_excel(ENT_TEMPLATE_XLS), crs="epsg:32632")
-
-        # set metadata
-        exp.ref_year = 2020
-        exp.value_unit = "XSD"
+        exp = Exposures(
+            pd.read_excel(ENT_TEMPLATE_XLS), crs="epsg:32632", ref_year=2020
+        )
 
         # add another geometry column
         exp.data["geocol2"] = exp.data.geometry.copy(deep=True)

climada/entity/exposures/test/test_base.py

@@ -189,7 +189,7 @@ def from_step_impf(
         haz_type: str,
         mdd: tuple[float, float] = (0, 1),
         paa: tuple[float, float] = (1, 1),
-        impf_id: int = 1,
+        impf_id: int | str = 1,
         **kwargs,
     ):
         """Step function type impact function.
@@ -207,7 +207,7 @@ def from_step_impf(
             (min, max) mdd values. The default is (0, 1)
         paa: tuple(float, float)
             (min, max) paa values. The default is (1, 1)
-        impf_id : int, optional, default=1
+        impf_id : int|str, optional, default=1
             impact function id
         kwargs :
             keyword arguments passed to ImpactFunc()
@@ -250,7 +250,7 @@ def from_sigmoid_impf(
         k: float,
         x0: float,
         haz_type: str,
-        impf_id: int = 1,
+        impf_id: int | str = 1,
         **kwargs,
     ):
         r"""Sigmoid type impact function hinging on three parameter.
@@ -320,7 +320,7 @@ def from_poly_s_shape(
         scale: float,
         exponent: float,
         haz_type: str,
-        impf_id: int = 1,
+        impf_id: int | str = 1,
         **kwargs,
     ):
         r"""S-shape polynomial impact function hinging on four parameter.

climada/entity/impact_funcs/base.py

@@ -24,7 +24,7 @@
 import copy
 import logging
 from itertools import repeat
-from typing import Iterable, Optional
+from typing import Iterable, Optional, Union, overload
 
 import matplotlib.pyplot as plt
 import numpy as np
@@ -119,7 +119,7 @@ def clear(self):
         """Reinitialize attributes."""
         self._data = dict()  # {hazard_type : {id:ImpactFunc}}
 
-    def append(self, func):
+    def append(self, func: ImpactFunc):
         """Append a ImpactFunc. Overwrite existing if same id and haz_type.
 
         Parameters
@@ -141,7 +141,9 @@ def append(self, func):
             self._data[func.haz_type] = dict()
         self._data[func.haz_type][func.id] = func
 
-    def remove_func(self, haz_type=None, fun_id=None):
+    def remove_func(
+        self, haz_type: Optional[str] = None, fun_id: Optional[str | int] = None
+    ):
         """Remove impact function(s) with provided hazard type and/or id.
         If no input provided, all impact functions are removed.
 
@@ -173,7 +175,29 @@ def remove_func(self, haz_type=None, fun_id=None):
         else:
             self._data = dict()
 
-    def get_func(self, haz_type=None, fun_id=None):
+    @overload
+    def get_func(
+        self, haz_type: None = None, fun_id: None = None
+    ) -> dict[str, dict[Union[int, str], ImpactFunc]]: ...
+
+    @overload
+    def get_func(
+        self, haz_type: None = ..., fun_id: int | str = ...
+    ) -> list[ImpactFunc]: ...
+
+    @overload
+    def get_func(
+        self, haz_type: str = ..., fun_id: None = None
+    ) -> list[ImpactFunc]: ...
+
+    @overload
+    def get_func(self, haz_type: str = ..., fun_id: int | str = ...) -> ImpactFunc: ...
+
+    def get_func(
+        self, haz_type: Optional[str] = None, fun_id: Optional[int | str] = None
+    ) -> Union[
+        ImpactFunc, list[ImpactFunc], dict[str, dict[Union[int, str], ImpactFunc]]
+    ]:
         """Get ImpactFunc(s) of input hazard type and/or id.
         If no input provided, all impact functions are returned.
 
@@ -209,7 +233,7 @@ def get_func(self, haz_type=None, fun_id=None):
         else:
             return self._data
 
-    def get_hazard_types(self, fun_id=None):
+    def get_hazard_types(self, fun_id: Optional[str | int] = None) -> list[str]:
         """Get impact functions hazard types contained for the id provided.
         Return all hazard types if no input id.
 
@@ -231,7 +255,15 @@ def get_hazard_types(self, fun_id=None):
                 haz_types.append(vul_haz)
         return haz_types
 
-    def get_ids(self, haz_type=None):
+    @overload
+    def get_ids(self, haz_type: None = None) -> dict[str, list[str | int]]: ...
+
+    @overload
+    def get_ids(self, haz_type: str) -> list[int | str]: ...
+
+    def get_ids(
+        self, haz_type: Optional[str] = None
+    ) -> dict[str, list[str | int]] | list[int | str]:
         """Get impact functions ids contained for the hazard type provided.
         Return all ids for each hazard type if no input hazard type.
 
@@ -256,7 +288,9 @@ def get_ids(self, haz_type=None):
         except KeyError:
             return list()
 
-    def size(self, haz_type=None, fun_id=None):
+    def size(
+        self, haz_type: Optional[str] = None, fun_id: Optional[str | int] = None
+    ) -> int:
         """Get number of impact functions contained with input hazard type and
         /or id. If no input provided, get total number of impact functions.
 
@@ -279,6 +313,7 @@ def size(self, haz_type=None, fun_id=None):
             return 1
         if (haz_type is not None) or (fun_id is not None):
             return len(self.get_func(haz_type, fun_id))
+
         return sum(len(vul_list) for vul_list in self.get_ids().values())
 
     def check(self):
@@ -300,7 +335,7 @@ def check(self):
                     )
                 vul.check()
 
-    def extend(self, impact_funcs):
+    def extend(self, impact_funcs: "ImpactFuncSet"):
         """Append impact functions of input ImpactFuncSet to current
         ImpactFuncSet. Overwrite ImpactFunc if same id and haz_type.
 
@@ -323,7 +358,13 @@ def extend(self, impact_funcs):
             for _, vul in vul_dict.items():
                 self.append(vul)
 
-    def plot(self, haz_type=None, fun_id=None, axis=None, **kwargs):
+    def plot(
+        self,
+        haz_type: Optional[str] = None,
+        fun_id: Optional[str | int] = None,
+        axis=None,
+        **kwargs,
+    ):
         """Plot impact functions of selected hazard (all if not provided) and
         selected function id (all if not provided).
 

climada/entity/impact_funcs/impact_func_set.py

@@ -36,10 +36,12 @@
 from climada.entity.measures.measure_set import MeasureSet
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
-from climada.util.constants import EXP_DEMO_H5, HAZ_DEMO_H5
+from climada.util.constants import HAZ_DEMO_H5
 
 DATA_DIR = CONFIG.measures.test_data.dir()
 
+EXP_DEMO_H5 = get_test_file("exp_demo_today", file_format="hdf5")
+
 HAZ_TEST_TC: Path = get_test_file("test_tc_florida", file_format="hdf5")
 """
 Hazard test file from Data API: Hurricanes from 1851 to 2011 over Florida with 100 centroids.