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.1

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.1
File Size Uploaded
spikeinterface-0.98.1.tar.gz 547.0 kB Details

Built distribution (wheel)

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

Total release size: 1.3 MB

Release files / spikeinterface-0.98.1.tar.gz

Download URL spikeinterface-0.98.1.tar.gz
Size 547.0 kB
Tags Source
SHA-256 checksum
How to use checksums
b78da126f870572e5027bfe34937265a02fb227572278a6b0de1d09d3b11aaca
BLAKE2b-256 checksum
How to use checksums
763295c82d7d246032b7314fe381fa2761d194eb7b6383b8683278c1628452d5
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.1-py3-none-any.whl

Download URL spikeinterface-0.98.1-py3-none-any.whl
Size 749.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a5a419d5bdebafe506ca208de0d6b93229024d978f64f34b5c99f302c149f5bd
BLAKE2b-256 checksum
How to use checksums
a2e09db7bee7464dc33b094a3b1b427ca0cdf96e862c718eabcbb65648c292f8
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

0.98.2

2 release files

This release

0.98.1 This release

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