diff --git a/CHANGES.rst b/CHANGES.rst index cff29e302..c059d400c 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,13 +2,13 @@ Changelog ========= -v0.45.0 (unreleased) +v0.45.0 (2023-09-05) -------------------- Contributors to this version: David Huard (:user:`huard`), Trevor James Smith (:user:`Zeitsperre`), Pascal Bourgault (:user:`aulemahal`), Juliette Lavoie (:user:`juliettelavoie`), Gabriel Rondeau-Genesse (:user:`RondeauG`), Marco Braun (:user:`vindelico`), Éric Dupuis (:user:`coxipi`). Announcements ^^^^^^^^^^^^^ -* `xclim` now uses `platformdirs` to write `xclim-testdata` to the user's cache directory. Dynamic paths are now used to cache data dependent on the user's operating system. Developers can now safely delete the `.xclim-testdata` folder in their home directory without affecting the functionality of `xclim`. (:pull:`1460`). +* `xclim` now uses `platformdirs` to write `xclim-testdata` to the user's cache directory. Dynamic paths are now used to cache data dependent on the user's operating system. Developers can now safely delete the ``.xclim-testdata`` folder in their home directory without affecting the functionality of `xclim`. (:pull:`1460`). New indicators ^^^^^^^^^^^^^^ @@ -21,7 +21,7 @@ New features and enhancements * New ``xclim.units.declare_relative_units`` to enable relative unit checks. This was applied to most "generic" indices. (:pull:`1414`). * Added new function ``xclim.sdba.properties.std`` to calculate the standard deviation of a variable over all years at a given time resolution. (:pull:`1445`). * Amended the documentation of ``xclim.sdba.properties.trend`` to document already existing functionality of calculating the return values of ``scipy.stats.linregress``. (:pull:`1445`). -* Add support for setting optional variables through the `ds` argument. (:issue:`1432`, :pull:`1435`). +* Add support for setting optional variables through the ``ds`` argument. (:issue:`1432`, :pull:`1435`). * New ``xclim.core.calendar.is_offset_divisor`` to test if a given freq divides another one evenly (:pull:`1446`). * Missing value objects now support input timeseries of quarterly and yearly frequencies (:pull:`1446`). * Missing value checks enabled for all "generic" indicators (``return_level``, ``fit`` and ``stats``) (:pull:`1446`). @@ -30,29 +30,29 @@ Bug fixes ^^^^^^^^^ * Fix ``kldiv`` docstring so the math formula renders to HTML. (:issue:`1408`, :pull:`1409`). * Fix the registry entries of "generic" indicators. (:issue:`1423`, :pull:`1424`). -* Fix ``jetstream_metric_woollings`` so it uses the `vertical` coordinate identified by `cf-xarray`, instead of `pressure`. (:issue:`1421`, :pull:`1422`). Add logic to handle coordinates in decreasing order, or for longitudes defined from 0-360 instead of -180 to 180. (:issue:`1429`, :pull:`1430`). +* Fix ``jetstream_metric_woollings`` so it uses the ``vertical`` coordinate identified by `cf-xarray`, instead of ``pressure`` (:issue:`1421`, :pull:`1422`). + * Add logic to handle coordinates in decreasing order, or for longitudes defined from 0-360 instead of -180 to 180. (:issue:`1429`, :pull:`1430`). * Fix virtual indicator attribute assignment causing individual indicator's realm to be ignored. (:issue:`1425`, :pull:`1426`). -* Fixes the `raise_flags` argument of ``xclim.core.dataflags.data_flags`` so that an Exception is only raised when some checkups fail (:issue:`1456`, :pull:`1457`). +* Fixes the ``raise_flags`` argument of ``xclim.core.dataflags.data_flags`` so that an `Exception` is only raised when some checkups fail. (:issue:`1456`, :pull:`1457`). * Fix ``xclim.indices.generic.get_zones`` so that `bins` can be given as input without error. (:pull:`1455`). Internal changes ^^^^^^^^^^^^^^^^ * Tolerance thresholds for error in ``test_stats::test_fit`` have been relaxed to allow for more variation in the results. Previously untested ``*_moving_yearly_window`` functions are now tested. (:issue:`1400`, :pull:`1402`). -* Increased the guess of number of quantiles needed in ExtremeValues. (:pull:`1413`). +* Increased the guess of number of quantiles needed in `ExtremeValues`. (:pull:`1413`). * Tolerance thresholds for error in ``test_processing::test_adapt_freq`` have been relaxed to allow for more variation in the results. (:issue:`1417`, :pull:`1418`). -* Added 'streamflow' to the list of known variables. (:pull:`1431`). +* Added ``"streamflow"`` to the list of known variables. (:pull:`1431`). * Refactoring of index backend calculations. (:pull:`1443`, :issue:`1386`): - * Use ``xclim.indices.generic.select_resample_op`` for `{tg|tn|tx}_{max|mean|min}` , `max_1day_precipitation_amount`, `{snw|snd}_max` - * Directly use `{cold|hot}_spell_max_length` in `maximum_consecutive_{frost|tx}_days` + * Use ``xclim.indices.generic.select_resample_op`` for ``{tg|tn|tx}_{max|mean|min}`` , ``max_1day_precipitation_amount``, ``{snw|snd}_max`` + * Directly use ``{cold|hot}_spell_max_length`` in ``maximum_consecutive_{frost|tx}_days`` * ``xclim.indices.generic.select_resample_op`` now gives an output with the correct units (``xclim.core.units.to_agg_units`` is used internally). -* Added 'streamflow' to the list of known variables. (:pull:`1431`). * Shuffle autogenerated documentation files into distinct folders that can be easily cleaned using Makefile. (:pull:`1449`). * Some docstring adjustments to existing classes. (:pull:`1449`). -* `identify` now associates Jupyter Notebooks as JSON files. Set `pre-commit` to ignore JSON-formatting of them. (:pull:`1449`). +* The `pre-commit` dependency `identify` now associates Jupyter Notebooks as JSON files. `pre-commit` is now set to ignore JSON-formatting of notebooks. (:pull:`1449`). * Added a helper module ``_finder`` in the notebooks folder so that the working directory can always be found, with redundancies in place to prevent scripts from failing if the helper file is not found. (:pull:`1449`). * Added a manual cache-cleaning workflow (based on `GitHub cache-cleaning example `_), triggered when a branch has been merged. (:pull:`1462`). * Added a workflow for posting updates to the xclim Mastodon account (using `cbrgm/mastodon-github-action `_, triggered when a new version is published. (:pull:`1462`). -* Refactor base indicator classes and fix misleading inheritance of ``return_level`` (:issue:`1263`, :pull:`1446`). +* Refactor base indicator classes and fix misleading inheritance of ``return_level``. (:issue:`1263`, :pull:`1446`). Breaking changes ^^^^^^^^^^^^^^^^ diff --git a/setup.cfg b/setup.cfg index 401f957a8..108fc4bc3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.44.23-beta +current_version = 0.45.0 commit = True tag = False parse = (?P\d+)\.(?P\d+).(?P\d+)(\-(?P[a-z]+))? diff --git a/xclim/__init__.py b/xclim/__init__.py index 46a86ebd9..efc2d79ad 100644 --- a/xclim/__init__.py +++ b/xclim/__init__.py @@ -11,7 +11,7 @@ __author__ = """Travis Logan""" __email__ = "logan.travis@ouranos.ca" -__version__ = "0.44.23-beta" +__version__ = "0.45.0" # Load official locales