V0.11 Release Readiness#
Release Target#
package version:
0.11.0git tag:
v0.11.0package-index publication: deferred until
v1.0or later
v0.11.0 is a Git-tag-only release.
Do not run TestPyPI or PyPI publishing for v0.11.
Done#
M0 is complete:
v0.11was frozen as a Kuramoto-Sivashinsky feasibility-first releasev0.10was recorded as completestable KS promotion was made conditional on evidence
M1 is complete:
normalized KS semantics were frozen as
u_t + u*u_x + u_xx + u_xxxx = 0fourth-derivative requirements and feasibility diagnostics were scoped
M2 is complete:
compute_spectral_fd_derivatives(..., max_spatial_order=4)landed as the only public v0.11 API changeinternal KS feasibility generator helpers were added under tests only
API_STABILITY.mddocuments the public order-4 derivative extension
M3 is complete:
internal KS residual feasibility was validated under the frozen equation
no public KS residual evaluator landed
M4 is complete:
internal KS vertical-slice feasibility was run through fitting and held-out verification
evidence was recorded as reference-fallback-backed, not direct SVD in-tolerance recovery
M5 is complete:
stable KS runtime promotion was explicitly deferred for
v0.11public KS generator, residual, example, weak, and root exports remain absent
M6 is complete:
package metadata and release-facing docs are aligned with
0.11.0this readiness note is current
the compact
v0_11-release-gateis the current explicit release-gate CI job
Public API Notes#
New stable runtime API behavior in v0.11:
pdelie.derivatives.compute_spectral_fd_derivatives(..., max_spatial_order=4)emits:u_tu_xu_xxu_xxxu_xxxx
The default max_spatial_order=2 behavior, config, diagnostics, and derivative outputs remain preserved.
Stable KS runtime promotion is deferred:
no
pdelie.data.generate_ks_1d_field_batchno
pdelie.residuals.KSResidualEvaluatorno
pdelie.examples.run_ks_vertical_slice_exampleno root
pdelieKS exportsno weak KS API
no KS imported parity
Retained stable surfaces include:
Heat and Burgers strong paths
v0.8weak Heat/Burgers residual report APIsv0.9normalized periodic short-horizon KdV strong pathv0.10reporting helpers and nested Heat/KdV example summariesstructured
from_numpy(...)and optionalfrom_xarray(...)ingestionexisting discovery, portability, symmetry, and visualization runtime helpers
KS Feasibility Evidence#
The frozen internal KS fixture shows strong feasibility evidence:
residual max absolute value:
2.276047466221332e-09residual RMS value:
3.450580898077348e-10mass drift:
4.686823294199099e-16relative L2 drift:
0.0070894859776733715as diagnostic-onlyselected span distance:
0.0SVD span distance:
0.4178159498317849fit mode:
reference_fallbackreference fallback used:
Truefallback reason:
svd_translation_span_driftfirst-epsilon held-out verification error:
2.533384127588474e-13verification classification:
exactevidence label:
reference_fallback
Interpretation:
residual evaluation passes with large margin
mass conservation passes with large margin
held-out canonical translation verification passes
selected span passes because the canonical reference fallback is used
direct residual-based SVD fitting is out of tolerance
therefore stable KS runtime promotion is deferred for
v0.11
Explicitly Deferred#
stable KS data generator
stable KS residual evaluator
KS vertical-slice example
KS imported parity
weak KS APIs
root
pdelieexports for KS runtime APIsbroad dataset adapters
multidimensional, multivariable, or nonuniform-grid support
operator-facing APIs
manuscript-specific experiment logic
PyPI and TestPyPI publication; package-index publishing is deferred to
v1.0or later
CI Expectations#
Before tagging v0.11.0, the release PR should have these CI jobs green:
v0_11-release-gateeditable-testspackage-smoke
Historical release-gate test modules remain runnable locally and are covered by editable-tests.
Local Release Checklist#
Before tagging v0.11.0:
Inspect consistency across:
pyproject.tomlREADME.mdCHANGELOG.mddocs/releases/V0_11_RELEASE_READINESS.mddocs/releases/PUBLISHING.mddocs/specs/API_STABILITY.md
Run the full test suite:
python -m pytest
Build the package:
python -m build --sdist --wheel
Install
dist/pdelie-0.11.0-py3-none-any.whlinto a clean environment and verify:stable root imports
pdelie.reportinghelper imports from the submoduleone tiny weak Heat report
one tiny KdV strong-path residual
one tiny order-4 derivative smoke
root
pdeliedoes not export KS runtime APIs
Run examples:
python -m pdelie.examples.heat_vertical_slicepython -m pdelie.examples.kdv_vertical_slice
Run:
git diff --check
Direct Final Tag Checklist#
After local checks and CI pass:
merge the release PR into
maintag the merged
maincommit asv0.11.0do not publish to TestPyPI
do not publish to PyPI
record package-index publishing as deferred until
v1.0or later
Final Release View#
v0.11.0 is ready when the local release checklist and the current CI jobs pass.
The stable release claim is intentionally narrow:
existing Heat/Burgers/weak-report/KdV/reporting surfaces -> order-4 spectral derivatives -> internal KS feasibility evidence -> explicit stable-KS no-go/defer closeout
There is no stable public KS runtime surface in v0.11.