v0.7.0

v0.7.0 (2026-02-24)

Contributors to this version: Trevor James Smith (@Zeitsperre), Gabriel Rondeau-Genesse (@RondeauG), Julián Ospina (@ospinajulian), Ève Larose (@e-larose), Thomas-Charles Fortier Filion (@TC-FF).

New features and enhancements

• The xh.indicators.pmp.major_precipitation_events function now supports specifying a minimum precipitation threshold to consider an event. (PR/370).
• New objective functions have been added to the calibration module. (GH/365, PR/366).
• Added a new submodule xhydro.indicators.signatures to compute hydrological signatures. (GH/365, PR/366).

Breaking changes

• The migration from stackstac to odc-stac in xhydro.gis has led to changes in the results of xhydro.gis.land_use_classification and xhydro.gis.surface_properties due to differences in projection handling between the two libraries. (PR/403).
  • Our tests show that the differences are generally minor, but users should verify that their results remain consistent after the update.
• The Upstream Area (sq. km). column in the output of xh.gis.watershed_properties has been renamed to Upstream Area (sq. km). (PR/403).
• Features that were deprecated and planned to be removed in v0.7.0 have now been removed. This includes: (PR/408).
  • The map argument in xh.gis.watershed_delineation (now m).
  • The use_defaults and check_missing arguments in the Hydrotel class.
  • Most of the arguments in the RavenpyModel.create_rv() method, which are now expected to be given to the class itself or to the update_data() method.
  • Streamflow is now always q.
  • return_period is now the only accepted argument for return periods in the xhfa module, and the old t, rp, and return_periods arguments have been removed.
  • xhfa.regional.get_group_from_fit has been renamed to xhfa.regional.get_clusters and the old function has been removed.
  • xhfa.regional.calculate_rp_from_afr has been renamed to xhfa.regional.calculate_return_period and the old function has been removed.
  • xhfa.uncertainties.calc_q_iter has been renamed to xhfa.uncertainties.calculate_quantiles_over_boostraped_groups and the old function has been removed.

Bug fixes

• The plotting positions calculated by xhfa.local._plotting_positions are now assigned as coordinates to ensure compatibility with hvplot when combined to xarray >=2025.11.0. (PR/373).
• Fixed a bug in xh.indicators.pmp.spatial_average_storm_configurations where certain instances were incorrectly assigned the string "x" and "y" instead of the expected value x and y. (PR/370).
• Corrected the titles in the documentation of the Inputs for the Probable Maximum flood (PMF). (PR/370)
• Added specific import for exactextract to prevent issues in the GIS modules if exactextract is prensent in the environment. (PR/381)
• The version detection logic in xhydro.modelling._hydrotel should now be more robust. (PR/388).
• Added a temporary workaround in xhydro.modelling._hydrotel to avoid OverflowError when chunks are automatically estimated as -1 by xscen.estimate_chunks. (PR/388).
  • Automated chunk estimation is also now skipped if the dataset is smaller than 100 MB.
• xh.modelling.format_input now correctly handles subdaily meteorological data with Hydrotel. (GH/404, PR/405).
• xh.modelling.format_input now correctly handles station-based meteorological data with Hydrotel. (PR/405).

Internal changes

• Updated the cookiecutter template to the latest commit. (PR/371):
  • Migrated from tox.ini to tox.toml
  • pre-commit hooks have been updated
  • Python 3.13 has been set in CI workflows (replacing "3.x")
  • tox builds no longer require python-coveralls (abandoned) and CI workflows now exclusively use coverallsapp/github-action
• Addressed multiple FutureWarnings coming from xarray and pandas. (PR/403).
• The backend used to load STAC data in xhydro.gis has been changed from stackstac to odc-stac. (PR/403).
  • This change addresses compatibility issues with new versions of rasterio.
• Added an additional xfail condition to the tests calling planetary_computer to account for occasional server issues. (PR/403).
• Updated test_hydrotel.py to enable testing with the Hydrotel executable and demo project. (PR/405).
  • You need to create a .env file in the tests directory and add the three required environment variables (HYDROTEL_EXECUTABLE, HYDROTEL_DEMO, and HYDROTEL_VERSION).