Icclim

What's Changed
=============

date: 2024-03

Breaking Changes Summary
----------------------------------------

- New package architecture.
- New toolchain with flit and ruff.
- ``clt`` standard variable uint changed.
- ``clone`` method added to Indicators.

Changes Details
-----------------------

- [maint] **BREAKING CHANGE**
Created a `_core` package which should not be used outside icclim source.
Its content may change without deprecation warnings.

- [enh] Added DCSC indices under `icclim.dcsc` namespace.

- [doc] Adapt Christian's notebooks from ISENES and add them as
tutorials in our documentation.

- [doc] Add nbshpinx extension to render jupyter notebooks in
the online documentation.

- [maint] Migrate from [black, blackdoc, flake8, isort, pyupgrade,
pydocstyle] to ruff

- [maint] Migrate from setup.py to pyproject.toml

- [maint] Make readthedocs build fail when there are warnings

- [maint] Fix warnings in doc build

- [maint] **BREAKING CHANGE**
Update architecture to have a `src/` and a `tests/` directory at root level

- [maint] **BREAKING CHANGE**
Migrate build toolchain from setuptools to flit

- [maint] Remove version number from `constants` module as it was
causing the build process to import icclim. The version number is now
statically set in src/icclim/__init__.py

- [fix] Force xarray to read dataset sequentially to avoid a netcdf-c
threading issue causing seg faults.

- [enh] Add `publish-to-pypi.yml` github action to automatically build
and publish icclim to pypi. This action is triggered by a github
release being published. This action requires a manual approval on
github.

- [enh] Add the following ECAD indices: PP (average of pressure),
SS (sum of sunshine) and RH (average of humidity).

- [fix] **BREAKING CHANGE**
the default unit of ``clt`` standard variable is now % as expected
(was a wind strenght unit).

- [maint] **BREAKING CHANGE**
Rework architecture to have a ``_core`` **private** package
containing the core logic of icclim. Idea taken from numpy 2.0.

- [doc] Add docstring to almost all functions, classes and modules.
This has been done to improve the generated documentation.
co-authored: Github's copilot.

- [maint] Add missing type hints.

- [doc] Make use of readthedocs' autoapi library to generate the API
documentation.

- [maint] Improve maintainability of ``tools/extract-icclim-funs.py`` to
ease adding new registries (still not perfect).

- [fix] Add ``clone`` method to Indicators to avoid modifying the original instance
when setting templating metadata.

**Full Changelog**: https://github.com/cerfacs-globc/icclim/compare/v6.5.0...v7.0.0

Breaking changes

- Pin xclim between 0.45 and 0.47
- [281] Adapt icclim to xclim 0.45 by updating excess and deficit generic functions
- Drop support for python 3.8

Fixes

- [273] Avoid resampling to compute time_bounds on SPI3 and SPI6 indices
- [256] Fix unit conversion issue for fraction_of_total generic indices (used by RxxpTOT family of indices)

Minor release to support latest xclim version (0.43.x).

BREAKING CHANGES
- [fix] The indicators based on the difference between two variables (ecad: DTR, ETR, vDTR and anomaly) gave wrong values due to a bad unit conversion of the output. This was for example the case when the input variables are in Kelvin, the difference between the two variables is still in Kelvin but it cannot be converted to degree Celsius with the ususal +273.15. To workaround this issue, we first convert inputs to the expected output unit and then we compute the index.
- [fix] Indices based on both a percentile threshold and a threshold_min_value (for ecad: r75p, r75pTOT, r95p, r95pTOT, r99p, r99pTOT) are now computing the exceedance rate on values above threshold_min_value as well. Previously this threshold_min_value was used to compute the percentile and the total (for rxxpTOT indices) but not the exceedance rate.
- [maint] The only compatible version of icclim 6.3.0 is xclim 0.42

Maintenance release to update icclim according to latest changes on xclim 0.40:
* Moved PercentileDataArray from xclim to icclim.
* Adapted the unit conversion to use the hydro context.

icclim v6.1.5 is a small release again, to fix a problem assuming datasets having latitude and longitude not as lat and lon but as the full names, when creating the output file metadata.

Bug fix
- Supports either lat or latitude, and lon or longitude, in put datasets.