Skip to main content

SpikeInterface: a unified framework for spike sorting

Latest Release latest release
Documentation latest documentation
License license
Build Status CI build status
Codecov codecov

Twitter Mastodon

SpikeInterface is a Python framework designed to unify preexisting spike sorting technologies into a single code base.

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

With SpikeInterface, users can:

  • read/write many extracellular file formats.
  • pre-process extracellular recordings.
  • run many popular, semi-automatic spike sorters (also in Docker/Singularity containers).
  • post-process sorted datasets.
  • 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, in jupyter)
  • export report and export to phy
  • offer a powerful Qt-based viewer in separate package spikeinterface-gui
  • have some powerful sorting components to build your own sorter.

Documentation

Detailed documentation for spikeinterface can be found here.

Several tutorials to get started can be found in spiketutorials.

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 spikeinteface

You can install the new spikeinterface version with pip:

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 sources:

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}
}

Metadata

Release files for spikeinterface 0.98.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spikeinterface 0.98.2
File Size Uploaded
spikeinterface-0.98.2.tar.gz 547.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for spikeinterface 0.98.2
File Interpreter ABI Platform
spikeinterface-0.98.2-py3-none-any.whl Python 3 none any Details

Total release size: 1.3 MB

Release files / spikeinterface-0.98.2.tar.gz

Download URL spikeinterface-0.98.2.tar.gz
Size 547.1 kB
Tags Source
SHA-256 checksum
How to use checksums
69d2c835c5033e54d2f88e08b610f604da17fb0540feae14760a613d4ade8f44
BLAKE2b-256 checksum
How to use checksums
afea496aa73c7841bb745512e99fccd0b33dafa6128cc97ee7da5e65bfe12c9d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release files / spikeinterface-0.98.2-py3-none-any.whl

Download URL spikeinterface-0.98.2-py3-none-any.whl
Size 749.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ce5c95985b7a14af180ec06ad90ca473ac29ade6a9e0a38343a328c614cfb454
BLAKE2b-256 checksum
How to use checksums
60b27dce105e8e260f9f64792dc5921f67564b6ccd97a2d3842ff0e41e51e2e0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.17

Release history Release notifications | RSS feed

0.99.1

2 release files

This release

0.98.2 This release

2 release files

0.98.1

2 release files

0.97.1

2 release files

0.97.0

2 release files

0.96.1

2 release files

0.96.0

2 release files

0.94.0

2 release files

0.90.1

2 release files

0.90.0

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.0

2 release files

0.9.9

2 release files

0.9.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page