Skip to main content

Python toolkit for analysis, visualization, and comparison of spike sorting output

Project description

SpikeInterface: a unified framework for spike sorting

Latest Release latest release
Documentation latest documentation
License license
Build Status travis build status
Codecov codecov
Twitter @spikeinterface

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

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.

Please have a look at the eLife paper that describes in detail this project

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

Documentation

All documentation for spikeinterface can be found here.

Some useful jupyter notebook tutorials can be found in spiketutorials.

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

spikeinterface-0.96.1.tar.gz (412.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

spikeinterface-0.96.1-py3-none-any.whl (594.1 kB view details)

Uploaded Python 3

File details

Details for the file spikeinterface-0.96.1.tar.gz.

File metadata

  • Download URL: spikeinterface-0.96.1.tar.gz
  • Upload date:
  • Size: 412.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.14

File hashes

Hashes for spikeinterface-0.96.1.tar.gz
Algorithm Hash digest
SHA256 10999cd49313ae686c4a061d6ec0350bc1dd110be71f60e3870eaddd85c5bd2a
MD5 b23dc7aecc468c224cb9407832ce0249
BLAKE2b-256 89c14eb993732a018af436a254046e50adffeb08357bcc35ed58e6fcc62cd743

See more details on using hashes here.

File details

Details for the file spikeinterface-0.96.1-py3-none-any.whl.

File metadata

File hashes

Hashes for spikeinterface-0.96.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0578715ba679998502f74a44f6c2fc4b725681601866eebbf8bdf1bbc3ac1655
MD5 53e00f63cc0abae8079c2486c3960f15
BLAKE2b-256 4c303ebadeadb24c194510e74984ade39734aedc3d94def04fcf38c920150b0c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page