Merge remote-tracking branch 'origin/develop' into feature/zenodo_attributes

Author: emanuel-schmid

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
       # Do not abort other tests if only a single one fails
       fail-fast: false
       matrix:
-        python-version: ["3.9", "3.10", "3.11"]
+        python-version: ["3.10", "3.11"]
 
     steps:
       -

.readthedocs.yml

@@ -11,7 +11,7 @@ build:
   # Append fixed Python version to requirements
   jobs:
     pre_create_environment:
-      - echo "  - python=3.9" >> requirements/env_climada.yml
+      - echo "  - python=3.11" >> requirements/env_climada.yml
 
 conda:
   environment: requirements/env_climada.yml

CHANGELOG.md

@@ -10,8 +10,41 @@ Code freeze date: YYYY-MM-DD
 
 ### Dependency Changes
 
+Added:
+
+- `osm-flex` >=1.1
+
+Updated:
+
+- `cartopy` >=0.23 → >=0.24
+- `cfgrib` >=0.9.9,<0.9.10 &rarr; >=0.9
+- `dask` >=2024.2,<2024.3 &rarr; >=2025.2
+- `eccodes` >=2.27,<2.28 &rarr; >=2.40
+- `gdal` >=3.6 &rarr; >=3.10
+- `geopandas` >=0.14 &rarr; >=0.14,<1.0
+- `h5py` >=3.8 &rarr; >=3.12
+- `haversine` >=2.8 &rarr; >=2.9
+- `matplotlib-base` >=3.9 &rarr; >=3.10
+- `netcdf4` >=1.6 &rarr; >=1.7
+- `numba` >=0.60 &rarr; >=0.61
+- `pillow` =9.4 &rarr; =11.1
+- `pyproj` >=3.5 &rarr; >=3.7
+- `pytables` >=3.7 &rarr; >=3.10
+- `python` =3.9 &rarr; =3.11
+- `rasterio` >=1.3 &rarr; >=1.4
+- `scikit-learn` >=1.5 &rarr; >=1.6
+- `scipy` >=1.13 &rarr; >=1.14,<1.15
+- `tqdm` >=4.66 &rarr; >=4.67
+- `xarray` >=2024.6 &rarr; >=2025.1
+- `xlsxwriter` >=3.1 &rarr; >=3.2
+
+Removed:
+
+- `pyepsg`
+
 ### Added
 
+- `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)
@@ -39,6 +72,8 @@ Code freeze date: YYYY-MM-DD
 - In `climada.util.plot.geo_im_from_array`, NaNs are plotted in gray while cells with no centroid are not plotted [#929](https://github.com/CLIMADA-project/climada_python/pull/929)
 - Renamed `climada.util.plot.subplots_from_gdf` to `climada.util.plot.plot_from_gdf` [#929](https://github.com/CLIMADA-project/climada_python/pull/929)
 - `Hazard.local_exceedance_inten`, `Hazard.local_return_period`, and `Impact.local_exceedance_imp` call the corresponding new functions and a deprecation warning is added [#918](https://github.com/CLIMADA-project/climada_python/pull/918). Some inconsistencies in the previous versions are removed and the default method is changed. To reconstruct results from the previous versions, use CLIMADA v5.0.0 or less.
+- elements of `event_name` are now explicitly converted to `str` in `from_raster`, `from_xarray_raster`, `from_excel` and `from_csv`. [#951](https://github.com/CLIMADA-project/climada_python/pull/951), [#910](https://github.com/CLIMADA-project/climada_python/issues/910)
+- `event_id` and `event_name` are now explicitly converted to respectively a `np.ndarray` (`event_id`), a `list` (`event_name`) in readers. [#951](https://github.com/CLIMADA-project/climada_python/pull/951), [#950](https://github.com/CLIMADA-project/climada_python/issues/950)
 - Exposures complete overhaul. Notably
   - the _geometry_ column of the inherent `GeoDataFrame` is set up at initialization
   - latitude and longitude column are no longer present there (the according arrays can be retrieved as properties of the Exposures object: `exp.latitude` instead of `exp.gdf.latitude.values`).
@@ -56,6 +91,7 @@ Code freeze date: YYYY-MM-DD
 
 ### Deprecated
 
+- `climada.hazard.trop_cyclone.trop_cyclone_windfields.compute_angular_windspeeds.cyclostrophic` argument
 - `climada.entity.exposures.Exposures.meta` attribute
 - `climada.entity.exposures.Exposures.set_lat_lon` method
 - `climada.entity.exposures.Exposures.set_geometry_points` method

README.md

@@ -4,7 +4,9 @@
 
 # CLIMADA
 
-[CLIMADA](https://climada.ethz.ch/climada/) stands for **CLIM**ate **ADA**ptation and is a probabilistic natural catastrophe impact model, that also calculates averted damage (benefit) thanks to adaptation measures of any kind (from grey to green infrastructure, behavioural, etc.).
+[CLIMADA](https://climada.ethz.ch/climada/) (CLIMate ADAptation) is a free and open-source software framework for climate risk assessment and adaptation
+option appraisal. Designed by a large scientific community, it helps reasearchers, policymakers, and businesses analyse the impacts of natural hazards and
+explore adaptation strategies.
 
 As of today, CLIMADA provides global coverage of major climate-related extreme-weather hazards at high resolution (4x4km) via a [data API](https://climada.ethz.ch/data-api/v1/docs) For select hazards, historic and probabilistic events sets, for past, present and future climate exist at distinct time horizons.
 You will find a repository containing scientific peer-reviewed articles that explain software components implemented in CLIMADA [here](https://github.com/CLIMADA-project/climada_papers).
@@ -37,18 +39,17 @@ Follow the [tutorials](https://climada-python.readthedocs.io/en/stable/tutorial/
 
 The online documentation is available on [Read the Docs](https://climada-python.readthedocs.io/en/stable/).The documentation of each release version of CLIMADA can be accessed separately through the drop-down menu at the bottom of the left sidebar. Additionally, the version 'stable' refers to the most recent release (installed via `conda`), and 'latest' refers to the latest unstable development version (the `develop` branch).
 
-
 CLIMADA python:
 
-* [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
-* [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
-* [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
+- [online (recommended)](https://climada-python.readthedocs.io/en/latest/)
+- [PDF file](https://climada-python.readthedocs.io/_/downloads/en/stable/pdf/)
+- [core Tutorials on GitHub](https://github.com/CLIMADA-project/climada_python/tree/main/doc/tutorial)
 
 CLIMADA petals:
 
-* [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
-* [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
-* [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
+- [online (recommended)](https://climada-petals.readthedocs.io/en/latest/)
+- [PDF file](https://climada-petals.readthedocs.io/_/downloads/en/stable/pdf/)
+- [petals Tutorials on GitHub](https://github.com/CLIMADA-project/climada_petals/tree/main/doc/tutorial)
 
 The documentation can also be [built locally](https://climada-python.readthedocs.io/en/latest/README.html).
 
@@ -74,6 +75,6 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
 
 Copyright (C) 2017 ETH Zurich, CLIMADA contributors listed in AUTHORS.
 
-CLIMADA is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3, 29 June 2007 as published by the Free Software Foundation, https://www.gnu.org/licenses/gpl-3.0.html
+CLIMADA is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3, 29 June 2007 as published by the Free Software Foundation, <https://www.gnu.org/licenses/gpl-3.0.html>
 
-CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details: https://www.gnu.org/licenses/gpl-3.0.html
+CLIMADA is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details: <https://www.gnu.org/licenses/gpl-3.0.html>

climada/engine/impact.py

@@ -41,6 +41,7 @@
 import pandas as pd
 import xlsxwriter
 from deprecation import deprecated
+from pandas.api.types import is_string_dtype
 from pyproj import CRS as pyprojCRS
 from rasterio.crs import CRS as rasterioCRS  # pylint: disable=no-name-in-module
 from scipy import sparse
@@ -50,7 +51,6 @@
 import climada.util.dates_times as u_dt
 import climada.util.interpolation as u_interp
 import climada.util.plot as u_plot
-from climada import CONFIG
 from climada.entity import Exposures
 from climada.util.constants import CMAP_IMPACT, DEF_CRS, DEF_FREQ_UNIT
 from climada.util.select import get_attributes_with_matching_dimension
@@ -107,8 +107,8 @@ def __init__(
         crs=DEF_CRS,
         eai_exp=None,
         at_event=None,
-        tot_value=0.,
-        aai_agg=0.,
+        tot_value=0.0,
+        aai_agg=0.0,
         unit="",
         imp_mat=None,
         haz_type="",
@@ -216,8 +216,8 @@ def calc(
             "The use of Impact().calc() is deprecated."
             " Use ImpactCalc().impact() instead."
         )
-        from climada.engine.impact_calc import (
-            ImpactCalc,  # pylint: disable=import-outside-toplevel
+        from climada.engine.impact_calc import (  # pylint: disable=import-outside-toplevel
+            ImpactCalc,
         )
 
         impcalc = ImpactCalc(exposures, impact_funcs, hazard)
@@ -1191,6 +1191,8 @@ def write_csv(self, file_name):
         file_name : str
             absolute path of the file
         """
+        if not all((isinstance(val, str) for val in self.event_name)):
+            raise TypeError("'event_name' must be a list of strings")
         LOGGER.info("Writing %s", file_name)
         with open(file_name, "w", encoding="utf-8") as imp_file:
             imp_wr = csv.writer(imp_file)
@@ -1239,6 +1241,8 @@ def write_excel(self, file_name):
         file_name : str
             absolute path of the file
         """
+        if not all((isinstance(val, str) for val in self.event_name)):
+            raise TypeError("'event_name' must be a list of strings")
         LOGGER.info("Writing %s", file_name)
 
         def write_col(i_col, imp_ws, xls_data):
@@ -1453,7 +1457,13 @@ def from_csv(cls, file_name):
         imp.aai_agg = imp_df["aai_agg"][0]
         imp.event_id = imp_df["event_id"][~np.isnan(imp_df["event_id"])].values
         num_ev = imp.event_id.size
-        imp.event_name = imp_df["event_name"][:num_ev].values.tolist()
+        event_names = imp_df["event_name"][:num_ev]
+        if not is_string_dtype(event_names):
+            warnings.warn(
+                "Some event names are not str will be converted to str.", UserWarning
+            )
+            event_names = event_names.astype(str)
+        imp.event_name = event_names.values.tolist()
         imp.date = imp_df["event_date"][:num_ev].values
         imp.at_event = imp_df["at_event"][:num_ev].values
         imp.frequency = imp_df["event_frequency"][:num_ev].values
@@ -1475,7 +1485,7 @@ def from_csv(cls, file_name):
     def read_csv(self, *args, **kwargs):
         """This function is deprecated, use Impact.from_csv instead."""
         LOGGER.warning(
-            "The use of Impact.read_csv is deprecated." "Use Impact.from_csv instead."
+            "The use of Impact.read_csv is deprecated. Use Impact.from_csv instead."
         )
         self.__dict__ = Impact.from_csv(*args, **kwargs).__dict__
 
@@ -1494,28 +1504,32 @@ def from_excel(cls, file_name):
             Impact from excel file
         """
         LOGGER.info("Reading %s", file_name)
-        dfr = pd.read_excel(file_name)
-        imp = cls(haz_type=str(dfr["haz_type"][0]))
-
-        imp.unit = dfr["unit"][0]
-        imp.tot_value = dfr["tot_value"][0]
-        imp.aai_agg = dfr["aai_agg"][0]
+        imp_df = pd.read_excel(file_name)
+        imp = cls(haz_type=str(imp_df["haz_type"][0]))
 
-        imp.event_id = dfr["event_id"][~np.isnan(dfr["event_id"].values)].values
-        imp.event_name = dfr["event_name"][: imp.event_id.size].values
-        imp.date = dfr["event_date"][: imp.event_id.size].values
-        imp.frequency = dfr["event_frequency"][: imp.event_id.size].values
+        imp.unit = imp_df["unit"][0]
+        imp.tot_value = imp_df["tot_value"][0]
+        imp.aai_agg = imp_df["aai_agg"][0]
+        imp.event_id = imp_df["event_id"][~np.isnan(imp_df["event_id"].values)].values
+        event_names = imp_df["event_name"][~np.isnan(imp_df["event_id"].values)]
+        if not is_string_dtype(event_names):
+            warnings.warn(
+                "Some event names are not str will be converted to str", UserWarning
+            )
+            event_names = event_names.astype(str)
+        imp.event_name = event_names.values
+        imp.date = imp_df["event_date"][: imp.event_id.size].values
+        imp.frequency = imp_df["event_frequency"][: imp.event_id.size].values
         imp.frequency_unit = (
-            dfr["frequency_unit"][0] if "frequency_unit" in dfr else DEF_FREQ_UNIT
+            imp_df["frequency_unit"][0] if "frequency_unit" in imp_df else DEF_FREQ_UNIT
         )
-        imp.at_event = dfr["at_event"][: imp.event_id.size].values
-
-        imp.eai_exp = dfr["eai_exp"][~np.isnan(dfr["eai_exp"].values)].values
+        imp.at_event = imp_df["at_event"][: imp.event_id.size].values
+        imp.eai_exp = imp_df["eai_exp"][~np.isnan(imp_df["eai_exp"].values)].values
         imp.coord_exp = np.zeros((imp.eai_exp.size, 2))
-        imp.coord_exp[:, 0] = dfr["exp_lat"].values[: imp.eai_exp.size]
-        imp.coord_exp[:, 1] = dfr["exp_lon"].values[: imp.eai_exp.size]
+        imp.coord_exp[:, 0] = imp_df["exp_lat"].values[: imp.eai_exp.size]
+        imp.coord_exp[:, 1] = imp_df["exp_lon"].values[: imp.eai_exp.size]
         try:
-            imp.crs = u_coord.to_csr_user_input(dfr["exp_crs"].values[0])
+            imp.crs = u_coord.to_csr_user_input(imp_df["exp_crs"].values[0])
         except AttributeError:
             imp.crs = DEF_CRS
 
@@ -1679,8 +1693,8 @@ def video_direct_impact(
         -------
         list of Impact
         """
-        from climada.engine.impact_calc import (
-            ImpactCalc,  # pylint: disable=import-outside-toplevel
+        from climada.engine.impact_calc import (  # pylint: disable=import-outside-toplevel
+            ImpactCalc,
         )
 
         if args_exp is None:

climada/engine/test/test_impact.py

@@ -106,7 +106,7 @@ def test_from_eih_pass(self):
         self.assertEqual(imp.frequency_unit, HAZ.frequency_unit)
         self.assertEqual(imp.tot_value, tot_value)
         np.testing.assert_array_almost_equal(imp.event_id, HAZ.event_id)
-        np.testing.assert_array_almost_equal(imp.event_name, HAZ.event_name)
+        np.testing.assert_array_equal(imp.event_name, HAZ.event_name)
         np.testing.assert_array_almost_equal(imp.date, HAZ.date)
         np.testing.assert_array_almost_equal(imp.frequency, HAZ.frequency)
         np.testing.assert_array_almost_equal(imp.eai_exp, fake_eai_exp)

climada/engine/test/test_impact_calc.py

@@ -297,7 +297,7 @@ def test_empty_impact(self):
 
     def test_single_event_impact(self):
         """Check impact for single event"""
-        haz = HAZ.select([1])
+        haz = HAZ.select(event_id=[1])
         icalc = ImpactCalc(ENT.exposures, ENT.impact_funcs, haz)
         impact = icalc.impact()
         aai_agg = 0.0

climada/engine/unsequa/calc_base.py

@@ -207,7 +207,7 @@ def make_sample(self, N, sampling_method="saltelli", sampling_kwargs=None):
         sampling_method : str, optional
             The sampling method as defined in SALib. Possible choices:
             'saltelli', 'latin', 'morris', 'dgsm', 'fast_sampler', 'ff', 'finite_diff',
-             https://salib.readthedocs.io/en/latest/api.html
+            https://salib.readthedocs.io/en/latest/api.html
             The default is 'saltelli'.
         sampling_kwargs : kwargs, optional
             Optional keyword arguments passed on to the SALib sampling_method.
@@ -228,7 +228,6 @@ def make_sample(self, N, sampling_method="saltelli", sampling_kwargs=None):
         requirement. Please refer to https://salib.readthedocs.io/en/latest/api.html
         for more details.
 
-
         See Also
         --------
         SALib.sample: sampling methods from SALib SALib.sample

climada/engine/unsequa/calc_cost_benefit.py

@@ -77,8 +77,7 @@ class CalcCostBenefit(Calc):
     _metric_names : tuple(str)
         Names of the cost benefit output metrics
         ('tot_climate_risk', 'benefit', 'cost_ben_ratio',
-         'imp_meas_present', 'imp_meas_future')
-
+        'imp_meas_present', 'imp_meas_future')
     """
 
     _input_var_names = (

climada/engine/unsequa/calc_delta_climate.py

@@ -81,7 +81,7 @@ class CalcDeltaImpact(Calc):
     _input_var_names : tuple(str)
         Names of the required uncertainty input variables
         ('exp_initial_input_var', 'impf_initial_input_var', 'haz_initial_input_var',
-         'exp_final_input_var', 'impf_final_input_var', 'haz_final_input_var'')
+        'exp_final_input_var', 'impf_final_input_var', 'haz_final_input_var'')
     _metric_names : tuple(str)
         Names of the impact output metrics
         ('aai_agg', 'freq_curve', 'at_event', 'eai_exp')