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 CI build status
Codecov codecov

Twitter Mastodon

:rocket::rocket::rocket: New features!: after months of development and testing, we are happy to announce that the latest release (0.101.0) includes a major API improvement: the SortingAnalyzer! To read more about why we did this, checkout the SpikeInterface Enhancement Proposal. Please follow this guide to transition from the old API to the new one: Updating from legacy.

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, jupyter, ephyviewer)
  • export a report and/or export to phy
  • offer a powerful Qt-based viewer in a separate package spikeinterface-gui
  • have powerful sorting components to build your own sorter.

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 ful list of references, please check the references page.

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.102.3.tar.gz (795.9 kB view details)

Uploaded Source

Built Distribution

spikeinterface-0.102.3-py3-none-any.whl (1.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikeinterface-0.102.3.tar.gz
  • Upload date:
  • Size: 795.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for spikeinterface-0.102.3.tar.gz
Algorithm Hash digest
SHA256 c820986112b3561a8b40728767ad7b00c9af096f04cbaa6a07c4bb8a9d2964a5
MD5 4984286bee071686cd6a2ca5db2a239b
BLAKE2b-256 505992da08702250b24d2d853cd65812cc611bdc08b0977572a9060bd870ce80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spikeinterface-0.102.3-py3-none-any.whl
Algorithm Hash digest
SHA256 28581af2bf4445275713d4b5d8d6afd02a7167544ac2fc8eed10dc860b691532
MD5 0aa32a485d61e56983bef288ceedea7d
BLAKE2b-256 b73c1a5ef63d8ffa8a151249f1e876db9b05e3038cc0d4946f4355bf0ea03743

See more details on using hashes here.

Supported by

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