Getting Started

Getting Started

Generated with Grok Build: Grok 4.5 · xAI Imagine (/imagine)

Install

[dependencies]
neuromod = "0.5.0"
# optional: neuromod = { version = "0.5.0", features = ["sentry"] }

cargo test
cargo run --example basic
cargo run --example rstdp_demo

Default network

use neuromod::{NeuroModulators, SpikingNetwork};

let mut network = SpikingNetwork::new(); // 16 LIF, 5 Izhikevich, 16 channels
let stimuli = [0.5_f32; 16];
let modulators = NeuroModulators::default();
let spikes = network.step(&stimuli, &modulators).unwrap(); // indices that fired

Dynamic dimensions

let mut network = SpikingNetwork::with_dimensions(518, 5, 518);
let stimuli = vec![0.25_f32; 518];
let spikes = network.step(&stimuli, &NeuroModulators::default()).unwrap();

Shape validation

step requires stimuli.len() == num_channels or returns StepError::InputLenMismatch { expected, got }.

Next

• SpikingNetwork
• Neuron Models
• Neuromodulators

---

Last updated: July 29, 2026 Updated by: Grok Build: Grok 4.5 Package tip reference: 67c1573 (main, v0.5.0) Cubic: page-intro Devin DeepWiki: neuromod @ 67c1573