Metadata-Version: 2.4
Name: axobench
Version: 0.1.0
Summary: Single-neuron surrogate benchmark and dataset generation workbench.
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: matplotlib>=3.8
Requires-Dist: numpy>=1.24
Requires-Dist: requests>=2.32
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Provides-Extra: sim
Requires-Dist: arbor==0.11.0; extra == "sim"
Provides-Extra: plots

# AxoBench

AxoBench is the extracted benchmark and dataset-generation workbench for
single-neuron surrogate evaluation. It owns dataset generation, data/schema
utilities, diagnostic suites, and benchmark reporting.

The package keeps simulator-backed generation code under
`src/axobench/generation/`: Arbor, NEURON/Hay, CoreNEURON/Hay, SWC-template
preparation, morphology-candidate ranking, throughput probes, and the v1
parallel dataset generator. `scripts/` is reserved for thin operational entry
points such as launch scripts and data-download helpers.

Model implementations, training loops, checkpoint formats, and model-specific
experiments stay in `bnn_sim`. AxoBench evaluates caller-supplied prediction
functions or stored prediction/diagnostic artifacts; it does not ship BranchELM,
Mamba, RNN, or training code.

The active exploration arc lives in `docs/benchmark/`, which is ignored by Git
while the benchmark audit is still exploratory.
