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 asrc/
and atests/
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 ofclt
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: v6.5.0...v7.0.0