SpikeInterface: a unified framework for spike sorting

Latest Release
Documentation
License
Build Status
Codecov

Please Star the project to support us and Watch to always stay up-to-date!

SpikeInterface is a Python package designed to unify preexisting spike sorting technologies into a single code base. If you use SpikeInterface, you are also using code and ideas from many other projects. Our codebase would be tiny without the amazing algorithms and formats that we interface with. See them all, and how to cite them, on our references page. In the past year, we have added support for the following tools:

• dartsort DARTsort: A modular drift tracking spike sorter for high-density multi-electrode probes (docs)
• Bombcell Bombcell: automated curation and cell classification of spike-sorted electrophysiology data (docs)
• SLAy. SLAy-ing oversplitting errors in high-density electrophysiology spike sorting (docs)
• Lupin, Spykingcircus2 and Tridesclous2. Opening the black box: a modular approach to spike sorting (docs)
• rtsort. RT-Sort: An action potential propagation-based algorithm for real time spike detection and sorting with millisecond latencies (docs)
• MEDiCINe. MEDiCINe: Motion Correction for Neural Electrophysiology Recordings (docs)
• UnitRefine. UnitRefine: A Community Toolbox for Automated Spike Sorting Curation (docs)

If you would like us to add another tool, or you would like to integrate your project with our package, please open an issue.

With SpikeInterface, users can:

• read/write many extracellular file formats.
• pre-process extracellular recordings.
• run many popular, semi-automatic spike sorters (kilosort1-4, mountainsort4-5, spykingcircus, tridesclous, ironclust, herdingspikes, yass, waveclus)
• run sorters developed in house (lupin, spykingcircus2, tridesclous2, simple) that compete with kilosort4
• run these popular sorters without installation using containers (Docker/Singularity).
• post-process sorted datasets using the SortingAnalyzer
• compare and benchmark spike sorting outputs.
• compute quality metrics to validate and curate spike sorting outputs.
• visualize recordings and spike sorting outputs in several ways (matplotlib, sortingview, jupyter, ephyviewer)
• export a report and/or export to phy
• curate your sorting with several strategies (ml-based, metrics based, manual, ...)
• offer a powerful Qt-based or web-based viewer in a separate package spikeinterface-gui for manual curation that replaces phy.
• have powerful sorting components to build your own sorter.
• have a full motion/drift correction framework

Documentation

Detailed documentation of the latest PyPI release of SpikeInterface can be found here.

Detailed documentation of the development version of SpikeInterface can be found here.

Several tutorials to get started can be found in spiketutorials.

Checkout our YouTube channel for video tutorials: SpikeInterface YouTube Channel.

There are also some useful notebooks on our blog that cover advanced benchmarking and sorting components.

You can also have a look at the spikeinterface-gui.

How to install spikeinterface

You can install the latest version of spikeinterface version with pip (using quotes ensures pip install works in all terminals/shells):

pip install "spikeinterface[full]"

The [full] option installs all the extra dependencies for all the different sub-modules.

To install all interactive widget backends, you can use:

 pip install "spikeinterface[full,widgets]"

To get the latest updates, you can install spikeinterface from source:

git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
pip install -e .
cd ..

Citation

If you find SpikeInterface useful in your research, please cite:

@article{buccino2020spikeinterface,
  title={SpikeInterface, a unified framework for spike sorting},
  author={Buccino, Alessio Paolo and Hurwitz, Cole Lincoln and Garcia, Samuel and Magland, Jeremy and Siegle, Joshua H and Hurwitz, Roger and Hennig, Matthias H},
  journal={Elife},
  volume={9},
  pages={e61834},
  year={2020},
  publisher={eLife Sciences Publications Limited}
}

Please also cite other relevant papers for the specific components you use. For a full list of references, please check the references page.