Skip to content

2.7.0

Latest

Choose a tag to compare

@tennlee tennlee released this 05 Sep 02:54
784a64e

Release Notes (What's New)

Version 2.7.0 (September 5, 2026)

For a list of all changes in this release, see the full changelog. Below are the changes we think users may wish to be aware of.

Features

  • Added two new metrics:
    • Energy budget: scores.dynamics.energy_components_lat_lon.
    • Energy exchanges: scores.dynamics.energy_exchanges_lat_lon.
      See PR #1105 and PR #1115.
  • Added a new class and a new instance of the class:
    • scores.dynamics.PlanetConstants (a data class for representing various physical constants used in the calculation of energy budgets).
    • scores.dynamics.STANDARD_CONSTANTS (a default set of planet constants for use by scores.dynamics.energy_components_lat_lon and scores.dynamics.energy_exchanges_lat_lon).
      See PR #1105.
  • Added a new scores.dynamics section to the API. See PR #1105.
  • Implemented a small change to the handling of scaling_factors in scores.continuous.kge. The type hint has been changed from Optional[Union[list[float], np.ndarray]] to Optional[Iterable[float]] to accept a wider range of inputs. See PR #1078.

Deprecations

  • This deprecation was first introduced in Version 2.5.0. Support for include_components will be removed from threshold-weighted continuous ranked probability score (twCRPS) functions in a future version of scores. The scores development team believe using include_components=True may lead to misleading results when used with twCRPS functions. As such, the following are now deprecated:
    • support for include_components in scores.probability.tw_crps_for_ensemble,
    • support for include_components in scores.probability.tail_tw_crps_for_ensemble and
    • support for include_components in scores.probability.interval_tw_crps_for_ensemble.
      See PR #991.

Documentation

  • Added "Energy budgets" tutorial. See PR #1105 and PR #1115.
  • Fixed two broken links - for the Binder badge in the README (README.md) and for the Binder badge in the tutorials README (docs/tutorials/README.md). See PR #1096.
  • Added a maintainers field and added additional contributors to the authors field in pyproject.toml. See PR #1120 and PR #1122.

Internal Changes

  • Updated three type hints with a more specific indicator. See PR #1067.

Contributors to this Release

David Lee* (@davelee2804), Tennessee Leeuwenburg (@tennlee), Stephanie Chong (@Steph-Chong), Oisín M. Morrison (@Oisin-M), Maree Carroll (@mareecarroll), Nicholas Loveday (@nicholasloveday) and Nikeeth Ramanathan (@nikeethr).

* indicates that this release contains their first contribution to scores.