Skip to content

Getting Started

Raul Montoya Cardenas edited this page Jul 29, 2026 · 2 revisions

Getting Started

Installation

using Pkg
Pkg.add("SpikeStream")
# or git / path for unreleased work:
# Pkg.add(url="https://github.com/Limen-Neural/SpikeStream.jl")

From a clone:

julia --project=. -e 'using Pkg; Pkg.instantiate()'
julia --project=. -e 'using Pkg; Pkg.test()'

Minimal example

using SpikeStream

spike_times = [0.001, 0.005, 0.009, 0.040, 0.042, 0.044, 0.090]

count = spike_count(spike_times)
density = spike_density(spike_times; t_start=0.0, t_end=0.1)
stats = isi_stats(spike_times)
bursts = detect_bursts(spike_times; max_isi=0.004, min_spikes=3)
windows = windowed_spike_features(spike_times; window_size=0.03, step=0.03)
vec = normalized_feature_vector(spike_times; t_start=0.0, t_end=0.1, max_density=200.0)

Timestamps are numeric seconds (or any consistent unit). Most APIs sort a copy of the input.

Format check (local, matches CI)

julia -e 'using Pkg; Pkg.activate(; temp=true); Pkg.add("JuliaFormatter"); using JuliaFormatter; format(".", overwrite=true, verbose=true)'
git diff --exit-code

Next


Last updated: July 29, 2026 Updated by: Grok Build: Grok 4.5 Package tip reference: d2229e2 (main)

Clone this wiki locally