jaxfne
JAX-based simulation of Tensor-Field Neural Equations — emitter-to-source-to-field readouts for computational electrophysiology. Define a circuit (single column or multi-area hierarchy), run it, and inspect population activity, layer-targeted drive, and field readouts in one pipeline.
jaxfne works at the population/field scale — layer-resolved circuits, spectrolaminar readouts, a tensor-algebraic source-to-sensor-proxy chain. For single/multi-compartment biophysical detail, Jaxley is the natural complement, not a competing tool: Jaxley models plug directly into jaxfne as emitters (see the Jaxley bridge in Quickstart).
Install
pip install jaxfne
pip install "jaxfne[viz]" # matplotlib/plotly readouts
Development checkout: pip install -e ".[dev,viz]" after cloning.
Minimal example
import jaxfne as jtfne
jtfne.enable_x64()
tensor = jtfne.load_canonical_neuronal_tensor("canonical-v1-column-1000n")
model = jtfne.construct(tensor, jtfne.RuntimeConfiguration(seed=0, duration_ms=1000.0, dt_ms=0.5))
signals = jtfne.simulate(model)
jtfne.vis.raster(signals) # population raster
jtfne.vis.spectrolaminar_suite(signals) # laminar PSD readout
Canonical import: import jaxfne as jtfne. More paths (fluent Configuration,
multi-trial sweeps, HDP plasticity, Jaxley bridge): Quickstart.
Scope & status
Every jaxfne output is labeled Relative or Absolute. Relative values are the default and require no external evidence; Absolute (physically calibrated) values require an explicit, evidenced calibration step. Reference: Scope & status.
Exported but not yet implemented: GLIFEmitter, LIFEmitter, write_nwb, read_nwb.
Documentation
| Resource | Link |
|---|---|
| Quickstart (three build paths, canonical column, Jaxley) | docs/quickstart.md |
| Full docs site | jaxfne.readthedocs.io |
| Tutorials & études | docs/tutorials/ |
| Changelog | docs/changelog.md |
| Contributing | docs/contributing.md |
| AI agents | docs/for_ai_agents.md |
Documentation for AI coding agents (skills/, docs/for_ai_agents.md) is a deliberate design choice, not incidental repo clutter — it's verified against the same source of truth as the human-facing docs above, not a separate, drifting spec.
Citation
Machine-readable metadata: CITATION.cff (GitHub Cite this repository).
BibTeX and Zenodo DOI setup: docs/citation.md.
1 maintainer
Release files for jaxfne 0.4.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| jaxfne-0.4.8.tar.gz | 16.3 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| jaxfne-0.4.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.7 MB
Release files / jaxfne-0.4.8.tar.gz
| Download URL | jaxfne-0.4.8.tar.gz |
|---|---|
| Size | 16.3 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5f8b50c6e3627a67d5d3920ccf1ce4b73dd70b4457b29f48c5b9ca1f3a445ef
|
|
BLAKE2b-256 checksum How to use checksums |
36b0a94f9f9c51d5b17adcbeeb688cdbd0bd8aa9d0094ffb61c9722818c80aa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 22, 2026.
Transparency logRelease files / jaxfne-0.4.8-py3-none-any.whl
| Download URL | jaxfne-0.4.8-py3-none-any.whl |
|---|---|
| Size | 460.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d2de3782089b7ee477dba8635243066782e4b077abfdb3a329e2b334146032f
|
|
BLAKE2b-256 checksum How to use checksums |
03ba9b9289db720c2cde8a31c1cd402791abe75af5b61493ebd7aeef0ca41539
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 22, 2026.
Transparency log
