Skip to content

v0.4.1

Latest
Compare
Choose a tag to compare
@RondeauG RondeauG released this 07 Nov 20:38
· 32 commits to main since this release
22bdee4

v0.4.1 (2024-11-07)

Contributors to this version: Gabriel Rondeau-Genesse (@RondeauG), Trevor James Smith (@Zeitsperre), Louise Arnal (@lou-a).

New features and enhancements

  • A periods parameter was added to frequency_analysis.local.fit to compute multiple separate periods with a single call. (PR/219).
  • In xhydro.cc.sampled_indicators, the delta_type argument can now be a dictionary or None, in which case the attribute delta_kind is used. (PR/220).
  • In xhydro.cc.sampled_indicators, weights along a time or horizon dimension will no longer reduce that dimension. (PR/220).

Bug fixes

  • Fixed a bug in xhydro.modelling.format_input where the function would fail if the input data was a dask array. (PR/214).
  • The executable parameter in the Hydrotel model class is now always required. (PR/214).

Breaking changes

  • The xhydro testing utilities have been rewritten to use pooch for downloading and caching testing datasets from hydrologie/xhydro-testdata. (PR/212).
  • The xhydro testing utilities now require pytest-xdist as a development dependency. (PR/212).
  • Many core dependencies have been updated to more modern versions. (PR/218, PR/228).
  • The delta_type argument in xhydro.cc.sampled_indicators has been renamed to delta_kind and is no longer positional. (PR/220).
  • The xhydro.pmp module has been moved to xhydro.indicators.pmp. (PR/226).

Internal changes

  • Updated the notebooks to reduce the load on ReadTheDocs. (PR/211).
  • Tests can now be run using the pytest-xdist plugin for distributed testing. See the pytest-xdist documentation <https://pytest-xdist.readthedocs.io/en/stable/>_ for more information. (PR/212).
  • Several tests reliant on online servers and services have been marked as online to prevent them from running in contexts where internet access is limited. (PR/212).
  • Many function docstrings and type hints have been updated for accuracy and precision. (PR/212).
  • The xHydro project now has a set of logos for use in documentation, the readme, and other materials. (PR/217).
  • xhydro.indicators is now a package with submodules for different types of indicators. Previous functions have been moved to a generic submodule and are imported at the top level for backwards compatibility. (PR/226).
  • xh.testing.utils.publish_release_notes now has a latest parameter to print only the latest release notes. (PR/228).