Release prep v0.1.0: tests, CI (test + build), fix stationary_density overflow, implement plot_trajectories, README/packaging polish#3
Merged
Conversation
Copilot
AI
changed the title
[WIP] Finalize release preparation and improve packaging ergonomics
Release prep v0.1.0: tests, CI, fix stationary_density overflow, implement plot_trajectories, README/packaging polish
Jun 17, 2026
Contributor
Author
Done. The CI workflow now has two jobs:
Also fixed the |
Copilot
AI
changed the title
Release prep v0.1.0: tests, CI, fix stationary_density overflow, implement plot_trajectories, README/packaging polish
Release prep v0.1.0: tests, CI (test + build), fix stationary_density overflow, implement plot_trajectories, README/packaging polish
Jun 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The repo was not release-ready: no tests, no CI, a stubbed public method, a numerical bug in
stationary_density, overstated README claims, and no root-level install metadata.Fixes
Bug:
stationary_densitynumerical overflowexp(-2V/σ²)overflowed when V had large negative values, producinginf/NaNin the normalised density. Fixed by shifting V toV - min(V)before exponentiation (mathematically equivalent after normalisation).plot_trajectorieswas a barepassstubImplemented with a single/dual-panel matplotlib figure (optional energy panel via
show_energy=True); returns theFigureobject.Added
Tests —
tests/test_engine.py, 27 deterministic/seeded tests:find_fixed_points: residual correctness, stability sign, structure, edge casesescape_probability: unit-interval bounds, threshold sensitivitystationary_density: normalisation, non-negativity, peak location vs. equilibriumseat_and_release: key structure, control-zeroed-after-release, raises on no bowlsimulate: reproducibility, boundedness, energy recordingplot_trajectories: returns figure, handles single/multiple realizationsCI —
.github/workflows/ci.yml,permissions: contents: read, two jobs:test: runspytest tests/ -vacross Python 3.9–3.12build(runs aftertest): builds wheel + sdist viapython -m build, verifies the wheel installs and imports cleanly, uploadsdist/as a workflow artifactRoot-level
pyproject.toml— enablespip install -e ".[dev]"from repo root;requires-pythonaligned to>=3.9(3.8 EOL Oct 2024);project.licenseuses SPDX string form to avoid setuptools deprecation warningRoot-level
.gitignore— excludesdist/,build/,*.egg-info/, caches, and virtualenvsDocs / metadata
CITATION.cff: addedversion: "0.1.0"release/CHANGELOG.md: updated