Skip to content

jaxfne v0.2.18: Infrastructure and Specification Release

jaxfne v0.2.18 is an infrastructure, documentation, and specification release. It bundles six phases of contract hardening, mathematical specification, validation tooling, and documentation consistency completed across v0.2.12 through v0.2.17.

This release does not introduce a Poisson solver implementation, new public APIs, calibrated physical-amplitude statuss, or biological validation statements. It establishes a durable contract layer and documentation foundation for reserved solver implementation and validation work.

Highlights

  • Probe report and field solution metadata contracts for multimodal output provenance.
  • Documentation equations and Plotly visualization guidance.
  • Poisson admissibility specification with five mathematical gates.
  • Documentation consistency improvements and strict MkDocs validation.
  • Tutorial smoke-test infrastructure for examples, notebooks, and documentation links.
  • Release-facing version bump from 0.2.10 to 0.2.18 to reflect bundled infrastructure maturity.

Bundled Phases

v0.2.12: Probe Report Contracts

v0.2.12 hardened report contracts for five probe operator outputs:

  • spikes
  • voltage
  • LFP
  • CSD
  • hybrid fields

It added field contract metadata with provenance tracking for solver status, physical status, and error bounds. Probe terminology was standardized around probe-forward, probe-hybrid, and field-proxy.

v0.2.13: Field Solution Metadata

v0.2.13 added field solution reporting metadata for distinguishing solver outputs, physical-status, and forward/proxy status.

The central addition was FieldSolutionReport, which records provenance for field-related outputs without implying calibrated physical amplitudes.

v0.2.14: Documentation and Visualization

v0.2.14 expanded the documentation layer with:

  • MkDocs math support through Arithmatex and MathJax.
  • Plotly visualization guide and examples.
  • Visual outputs developer guidance.
  • LaTeX equations for probe operators.
  • Tensor-field workflow documentation.

v0.2.15: Poisson Admissibility Specification

v0.2.15 introduced a specification-only Poisson admissibility contract with five mathematical gates:

  1. Symmetric positive definite conductivity tensor.
  2. Source conservation.
  3. Mean-zero gauge.
  4. Field finiteness.
  5. Convergence.

Important: v0.2.15 defines admissibility requirements but does not implement a Poisson solver. Physical amplitude statuss are not allowed in v0.2.18.

The source-level invariant remains:

"amplitude_status": False

This is intentional. Passing synthetic admissibility checks does not constitute a calibrated physical field solution.

v0.2.16: Documentation Consistency and Specification Audit

v0.2.16 corrected release and specification documentation to consistently state that Poisson admissibility is specification-only.

It also corrected tutorial path references, updated tutorial-stack descriptions, and verified that the strict MkDocs build passes without warnings.

v0.2.17: Tutorial Smoke Runner

v0.2.17 added a pure-stdlib tutorial smoke runner that validates:

  • Python example syntax.
  • Notebook structure.
  • Install and version-check cells.
  • Absence of committed notebook outputs.
  • Absence of private local paths.
  • Documentation link integrity.

The smoke runner does not require Jupyter, nbconvert, Plotly, or notebook execution dependencies.

Validation Status

The v0.2.18 release candidate passed the release validation gates:

Gate Status
jaxfne import / compilation PASS
Test suite PASS: 748 tests
Example syntax checks PASS
Notebook structure checks PASS
Tutorial smoke runner PASS
MkDocs strict build PASS
Package build PASS
Twine metadata check PASS
Branch hygiene PASS

The expected test baseline for this release is 748 passing tests.

Scope

v0.2.18 is suitable for:

  • Tutorial use.
  • Framework exploration.
  • Probe-contract and field-metadata inspection.
  • Specification-aware solver development.
  • Documentation and visualization workflows.

v0.2.18 is not a calibrated biophysical field solver release.

What v0.2.18 Does Not Include

  • No Poisson solver implementation.
  • No calibrated physical-amplitude statuss.
  • Proxy status statements.
  • No neuroscience-grounded amplitude interpretation.
  • Status note that field-proxy outputs are physically calibrated field amplitudes.

Poisson solver implementation and calibrated field validation are deferred to reserved extension work.

Terminology Discipline

Use the following release terminology:

  • field-proxy
  • probe-forward
  • probe-hybrid
  • forward-field
  • probe-field
  • specification-only
  • exploratory framework
  • mathematical specification

Avoid terminology that implies calibrated physical or biological validation. In particular, do not describe v0.2.18 outputs as biological ground status or calibrated physical-amplitude fields.

Installation

pip install jaxfne==0.2.18

Verify the installed version:

import jaxfne
print(jaxfne.__version__)

Expected output:

0.2.18

Release Assets

The v0.2.18 release includes:

  • Source distribution: jaxfne-0.2.18.tar.gz
  • Wheel distribution: jaxfne-0.2.18-py3-none-any.whl

Both artifacts pass twine check before evidence.

Publishing Approval

The v0.2.18 release candidate was approved for:

  • GitHub release evidence.
  • PyPI evidence.

Evidence occurs only after post-merge validation on main, annotated tag creation, and clean-install smoke testing from the published package.