API Reference

API Reference#

Complete API reference for brainpy.state, organized by model family. The library exposes two families that share the same state-based substrate:

BrainPy-style — composable, differentiable neurons, synapses, projections, outputs, plasticity, readouts, and input generators.
NEST-compatible — JAX re-implementations that preserve NEST parameter names and semantics, plus the spatial and network-builder layers.

Both families are usable from the single public brainpy.state namespace.

BrainPy-style#

The native modeling layer: compose neurons, synapses, and projections, and train them end to end with surrogate gradients.

Base Classes

Abstract base classes shared by all models: Dynamics, Neuron, Synapse.

base.html

Neurons

Spiking neuron models (LIF, ALIF, AdEx, HH, Izhikevich, …).

brainpy-neurons.html

Synapses

Synaptic dynamics (Expon, DualExpon, Alpha, AMPA, GABAa, BioNMDA).

brainpy-synapses.html

Projections

Connect neural populations (AlignPostProj, DeltaProj, CurrentProj, gap junctions, AlignPre/AlignPost helpers).

brainpy-projections.html

Synaptic Outputs

Convert conductances to currents (COBA, CUBA, MgBlock).

brainpy-synouts.html

Short-Term Plasticity

Short-term synaptic plasticity (STP, STD).

brainpy-plasticity.html

Readouts

Readout layers (LeakyRateReadout).

brainpy-readouts.html

Input Generators

Spike and current generators (PoissonSpike, SpikeTime, PoissonInput).

brainpy-inputs.html

NEST-compatible#

JAX re-implementations preserving NEST parameter names, plus the spatial and network-builder layers. Parity with a live NEST install is documented on the validation status page.

Base Classes

NESTNeuron, NESTSynapse, NESTPlasticity, NESTDevice.

nest-base.html

Neurons

IAF, AdEx, GIF, GLIF, HH, Izhikevich, rate, and binary neurons.

nest-neurons.html

Synapses

Static synapses, gap junctions, and special connections.

nest-synapses.html

Plasticity

STDP, Tsodyks-Markram STP, and voltage-based learning rules.

nest-plasticity.html