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

Author: spjuhel

.github/scripts/prepare_release.py

@@ -5,8 +5,6 @@
 
 - update version numbers in _version.py and setup.py
 - purge the "Unreleased" section of CHANGELOG.md and rename it to the new version number
-- copy the README.md file to doc/misc/README.md,
-  but without the badges as they interfere with the sphinx doc builder
 
 All changes are immediately commited to the repository.
 """
@@ -51,17 +49,6 @@ def bump_version_number(version_number: str, level: str) -> str:
     return ".".join([major, minor, patch])
 
 
-def update_readme(_nvn):
-    """align doc/misc/README.md with ./README.md but remove the non-markdown header lines from"""
-    with open("README.md", "r", encoding="UTF-8") as rmin:
-        lines = [line for line in rmin.readlines() if not line.startswith("[![")]
-    while not lines[0].strip():
-        lines = lines[1:]
-    with open("doc/misc/README.md", "w", encoding="UTF-8") as rmout:
-        rmout.writelines(lines)
-    return GitFile("doc/misc/README.md")
-
-
 def update_changelog(nvn):
     """Rename the "Unreleased" section, remove unused subsections and the code-freeze date,
     set the release date to today"""
@@ -108,7 +95,7 @@ def update_changelog(nvn):
                     if section_name:
                         changelog.write(f"### {section_name}\n")
                     lines = [
-                        ln.strip()
+                        ln.rstrip()
                         for ln in section
                         if "code freeze date: " not in ln.lower()
                     ]
@@ -227,7 +214,6 @@ def prepare_new_release(level):
     update_setup(new_version_number).gitadd()
     update_version(new_version_number).gitadd()
     update_changelog(new_version_number).gitadd()
-    update_readme(new_version_number).gitadd()
 
     Git().commit(new_version_number)
 

.github/scripts/setup_devbranch.sh

@@ -11,15 +11,13 @@ git pull
 
 git checkout origin/main \
     setup.py \
-    doc/misc/README.md \
     CHANGELOG.md \
     */_version.py
 
 release=`python .github/scripts/setup_devbranch.py`
 
 git add \
     setup.py \
-    doc/misc/README.md \
     CHANGELOG.md \
     */_version.py
 

.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:
       -
@@ -74,6 +74,6 @@ jobs:
     needs: build-and-test
     with:
       core_branch: ${{ github.ref }}
-      petals_branch: feature/exposures_crs
+      petals_branch: develop
     permissions:
       checks: write

.github/workflows/make-release.yml

@@ -1,7 +1,7 @@
 # This workflow will create a new release from main
 
 # the new version number is the old one increased by 1 in the given level [major, minor, patch]
-# first, some files are modified (_version.py, setup.py, CHANGELOG.md and doc/misc/README.md)
+# first, some files are modified (_version.py, setup.py and CHANGELOG.md
 # then, a new release is created on GitHub, tagged with v[new version number]
 
 name: Create a new release

.github/workflows/postrelease-setup-devbranch.yml

@@ -2,7 +2,6 @@
 
 # the version number of setup.py and _version.py will be taken from main, but have a "-dev" appendix
 # the CHANGELOG.md file will be updated and have a vanila "Unreleased" section
-# the doc/misc/README.md file is taken over from main
 
 name: Post-release develop setup
 

.readthedocs.yml

@@ -1,5 +1,8 @@
 version: 2
 
+sphinx:
+  configuration: doc/conf.py
+
 build:
   os: "ubuntu-22.04"
   tools:
@@ -8,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

.zenodo.json

@@ -0,0 +1,124 @@
+{
+  "title": "CLIMADA Core Python Package",
+
+  "description": "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.",
+
+  "creators": [
+    {
+      "name": "Gabriela Aznar Siguan",
+      "affiliation": "MeteoSwiss"
+    },
+    {
+      "name": "David N. Bresch",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Samuel Eberenz",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Jan Hartman",
+      "affiliation": "CelsiusPro"
+    },
+    {
+      "name": "Marine Perus",
+      "affiliation": "CelsiusPro"
+    },
+    {
+      "name": "Thomas R\u00f6\u00f6sli"
+    },
+    {
+      "name": "Dario Stocker"
+    },
+    {
+      "name": "Veronica Bozzini"
+    },
+    {
+      "name": "Carmen B. Steinmann"
+    },
+    {
+      "name": "Evelyn M\u00fchlhofer",
+      "affiliation": "MeteoSwiss"
+    },
+    {
+      "name": "Rachel Bungerer"
+    },
+    {
+      "name": "Inga J. Sauer"
+    },
+    {
+      "name": "Samuel L\u00fcthi",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Pui Man (Mannie) Kam",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Simona Meiler",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Alessio Ciullo",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Thomas Vogt",
+      "affiliation": "Potsdam Institute for Climate Impact Research"
+    },
+    {
+      "name": "Benoit P. Guillod",
+      "affiliation": "CLIMADA Technologies"
+    },
+    {
+      "name": "Chahan M. Kropf",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Emanuel Schmid",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Chris Fairless",
+      "affiliation": "CelsiusPro"
+    },
+    {
+      "name": "Jan W\u00fcthrich"
+    },
+    {
+      "name": "Z\u00e9lie Stalhandske",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Yue Yu"
+    },
+    {
+      "name": "Lukas Riedel",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Raphael Portmann",
+      "affiliation": "Agroscope"
+    },
+    {
+      "name": "Nicolas Colombi",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Leonie Villiger"
+    },
+    {
+      "name": "Timo Schmid"
+    },
+    {
+      "name": "Luca Severino"
+    },
+    {
+      "name": "Samuel Juhel",
+      "affiliation": "ETH Z\u00fcrich"
+    },
+    {
+      "name": "Valentin Gebhart"
+    }
+  ]
+}

AUTHORS.md

@@ -23,7 +23,7 @@
 * Emanuel Schmid
 * Chris Fairless
 * Jan Wüthrich
-* Zélie Standhanske
+* Zélie Stalhandske
 * Yue Yu
 * Lukas Riedel
 * Raphael Portmann

CHANGELOG.md

@@ -12,6 +12,71 @@ Code freeze date: YYYY-MM-DD
 
 ### Added
 
+### Changed
+- `Hazard.local_exceedance_intensity`, `Hazard.local_return_period` and `Impact.local_exceedance_impact`, `Impact.local_return_period`, using the `climada.util.interpolation` module: New default (no binning), binning on decimals, and faster implementation [#1012](https://github.com/CLIMADA-project/climada_python/pull/1012)
+### Fixed
+
+### Deprecated
+
+### Removed
+- `climada.util.interpolation.round_to_sig_digits` [#1012](https://github.com/CLIMADA-project/climada_python/pull/1012)
+
+## 6.0.1
+
+Release date: 2025-03-13
+
+### Fixed
+
+- bug in `climada.util.coordinates.bounding_box_from_countries` occurring if the country is a polygon and not a multipolygon
+  [#1018](https://github.com/CLIMADA-project/climada_python/pull/1018)
+
+## 6.0.0
+
+Release date: 2025-03-03
+
+### 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.subset_years` function [#1023](https://github.com/CLIMADA-project/climada_python/pull/1023)
+- `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.util.coordinates.bounding_box_from_countries` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)
+- `climada.util.coordinates.bounding_box_from_cardinal_bounds` function [#980](https://github.com/CLIMADA-project/climada_python/pull/980)
 - `climada.engine.impact.Impact.local_return_period` method [#971](https://github.com/CLIMADA-project/climada_python/pull/971)
 - `doc.tutorial.climada_util_local_exceedance_values.ipynb` tutorial explaining `Hazard.local_exceedance_intensity`, `Hazard.local_return_period`, `Impact.local_exceedance_impact`, and `Impact.local_return_period` methods [#971](https://github.com/CLIMADA-project/climada_python/pull/971)
 - `Hazard.local_exceedance_intensity`, `Hazard.local_return_period` and `Impact.local_exceedance_impact`, that all use the `climada.util.interpolation` module [#918](https://github.com/CLIMADA-project/climada_python/pull/918)
@@ -28,23 +93,32 @@ Code freeze date: YYYY-MM-DD
 
 ### Changed
 
+- `Centroids.append` now takes multiple arguments and provides a performance boost when doing so [#989](https://github.com/CLIMADA-project/climada_python/pull/989)
+- `climada.util.coordinates.get_country_geometries` function: Now throwing a ValueError if unregognized ISO country code is given (before, the invalid ISO code was ignored) [#980](https://github.com/CLIMADA-project/climada_python/pull/980)
 - Improved scaling factors implemented in `climada.hazard.trop_cyclone.apply_climate_scenario_knu` to model the impact of climate changes to tropical cyclones [#734](https://github.com/CLIMADA-project/climada_python/pull/734)
 - 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`).
-  - `Exposures.gdf` has been renamed to `Exposures.data` (it still works though, as it is a property now pointing to the latter)
-  - the `check` method does not add a default "IMPF_" column to the GeoDataFrame anymore
+- 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`).
+- `Exposures.gdf` has been renamed to `Exposures.data` (it still works though, as it is a property now pointing to the latter)
+- the `check` method does not add a default "IMPF_" column to the GeoDataFrame anymore
+- Updated IBTrACS version from v4.0 to v4.1 ([#976](https://github.com/CLIMADA-project/climada_python/pull/976)
+- Fix xarray future warning in TCTracks for .dims to .sizes
+- Fix hazard.concatenate type test for pathos pools
 
 ### Fixed
 
+- Resolved an issue where windspeed computation was much slower than in Climada v3 [#989](https://github.com/CLIMADA-project/climada_python/pull/989)
 - File handles are being closed after reading netcdf files with `climada.hazard` modules [#953](https://github.com/CLIMADA-project/climada_python/pull/953)
 - Avoids a ValueError in the impact calculation for cases with a single exposure point and MDR values of 0, by explicitly removing zeros in `climada.hazard.Hazard.get_mdr` [#933](https://github.com/CLIMADA-project/climada_python/pull/948)
 
 ### 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
@@ -53,8 +127,6 @@ Code freeze date: YYYY-MM-DD
 - `climada.engine.impact.Impact.local_exceedance_imp` method
 - `climada.engine.impact.Impact.plot_rp_imp` method
 
-### Removed
-
 ## 5.0.0
 
 Release date: 2024-07-19

Makefile

@@ -29,11 +29,11 @@ install_test : ## Test installation was successful
 
 .PHONY : data_test
 data_test : ## Test data APIs
-	python script/jenkins/test_data_api.py
+	pytest $(PYTEST_JUNIT_ARGS) script/jenkins/test_data_api.py
 
 .PHONY : notebook_test
 notebook_test : ## Test notebooks in doc/tutorial
-	python script/jenkins/test_notebooks.py report
+	pytest $(PYTEST_JUNIT_ARGS) script/jenkins/test_notebooks.py
 
 .PHONY : integ_test
 integ_test : ## Integration tests execution with xml reports