Skip to content

Release hygiene for 2.1.3: date the notes, document the entropy fix, cite upstream #476

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasMBury merged 1 commit into from
Jul 29, 2026
Merged

Release hygiene for 2.1.3: date the notes, document the entropy fix, cite upstream #476

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
All notable changes to `ewstools` are documented here.
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [2.1.3] — unreleased
## [2.1.3] — 2026-07-28

Maintenance release. **No API changes and no behavioural changes** — existing code and
notebooks run unmodified.
Expand All @@ -21,6 +21,18 @@ notebooks run unmodified.
released install still carried the break. This release ships it.
Reported in [#474](https://github.com/ThomasMBury/ewstools/issues/474).

- **`compute_entropy(method='kolmogorov')` now works on NumPy 2.** EntropyHub 2.0 — its
latest release — still uses `np.NaN`, which NumPy removed in 2.0, so `EH.K2En()` and
`EH.CoSiEn()` raised `AttributeError`. `ewstools`' own source was already clean; the
alias is restored immediately before the EntropyHub import, and `np.NaN` was only ever
a spelling of `np.nan`, so nothing changes numerically. This matters *because* of the
NumPy change below: lifting the `numpy<2` ceiling is what puts users on the stack where
the break appears, and it was a partial break — `method='sample'` worked while
`method='kolmogorov'` failed — which stays hidden until someone reaches for that method.
Verified on NumPy 2.4.6 / pandas 3.0.5 / SciPy 1.17.1: fails without the shim, passes
with it. Covered by a regression test. The shim can be dropped once EntropyHub ships a
NumPy 2 compatible release ([EntropyHub#21](https://github.com/MattWillFlood/EntropyHub/issues/21)).

### Changed

- **`numpy < 2.0` ceiling removed.** NumPy 2.x is supported and is now covered by CI. The
Expand Down Expand Up @@ -49,3 +61,7 @@ The single skip is the TensorFlow deep-learning test, which guards itself with

Against released 2.1.2 in the same container, all four spectral entry points fail; on this
branch all four pass.

These container runs predate the `compute_entropy` fix above, which adds a regression test —
hence 30 here and 31 in the suite as shipped. That fix was verified separately, on
NumPy 2.4.6 / pandas 3.0.5 / SciPy 1.17.1.
3 changes: 2 additions & 1 deletion ewstools/core.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@
# 2.0 — so EH.K2En() and EH.CoSiEn() raise AttributeError on a modern stack even
# though ewstools itself is clean. Restore the alias before importing EntropyHub;
# `np.NaN` was only ever a spelling of `np.nan`, so this is not a behaviour change.
# Remove once EntropyHub ships a NumPy 2 compatible release (reported upstream).
# Remove once EntropyHub ships a NumPy 2 compatible release; tracked upstream at
# https://github.com/MattWillFlood/EntropyHub/issues/21 (open, latest release is still 2.0).
if not hasattr(np, "NaN"): # pragma: no cover - depends on installed NumPy
np.NaN = np.nan

Expand Down
Loading