v0.5.0

Contributors: Trevor James Smith (@Zeitsperre), Éric Dupuis (@coxipi), Juliette Lavoie (@juliettelavoie), Pascal Bourgault (@aulemahal).

Changes

• Make additional grouping dimensions optional for methods accepting the group argument, except Loci and PrincipalComponents. (GH/99, GH/144, PR/151).
• Speed up import by activating cache=True for in numba-accelerated functions from xsdba.nbutils. (PR/135).
• Added a new installation recipe (pip install xsdba[sbck]) for installing the SBCK package. (PR/139):
  • Note that SBCK support is experimental and that the pybind11 library must be installed prior to installing SBCK.
• New functions related to spectral properties in Fourier space:
  • Perform a spectral filter with xsdba.processing.spectral_filter with a low-pass filter with a cosine-squared profile by default. (PR/88).
  • New spatial diagnostic to compute the spectral variance of a given field xsdba.properties.spectral_variance. (PR/88).
• xsdba.units.convert_units_to now wraps a private function _convert_units_to. (PR/145).
• xsdba.jitter_over_thresh is available directly in training methods by passing the jitter_over_thresh_value and jitter_over_thresh_upper_bnd arguments. (PR/110).
• Throw an error if group=Grouper('5D',window) is used with a biasadjust method other than MBCn (PR/162).
• xsdba.processing.to_additive_space accepts clip_next_to_bounds, which avoids infinities by ensuring lower_bound < data < upper_bound. (GH/164, PR/165).
• Allow nan values in xsdba.measures.rmse and xsdba.measures.mae. (PR/170).
• The adaptation of frequencies through adapt_freq_thresh_value is now applied in the adjusting step as well. (PR/160).
• xsdba.adjustment.ExtremeValues now accepts a DataArray for cluster_thresh, letting specify distinct thresholds for multiple locations. (GH/177, PR/179).
• Updated minimum supported versions of SBCK (v1.4.2) and numpy (v1.25). (PR/180).

Fixes

• Fix xsdba.base.get_coordinates to avoid using a private xarray function.(PR/147, GH/148).
• Fix xsdba.processing.from_additive_space to handles units correctly by using convert_units_to instead of harmonize_units. (PR/146).
• Fix the order of clip_next_to_bounds in xsdba.processing.to_additive_space. (PR/169).

Internal changes

• The tox and CI configurations now support the installation of SBCK and Eigen3 for testing purposes. (PR/139).
• The coveralls tox keyword has been renamed to coverage to avoid confusion with the coveralls service. (PR/139).
• The order of arguments in the following private functions was changed: xsdba._adjustment.{_fit_on_cluster,_fit_cluster_and_cdf, _extremes_train_1d} (PR/179).
• Updated the package metadata to reflect development progress and list user @aulemahal as a primary developer (PR/180).