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

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

Uploaded Source

Built Distribution

spikeinterface-0.97.1-py3-none-any.whl (671.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikeinterface-0.97.1.tar.gz
  • Upload date:
  • Size: 481.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for spikeinterface-0.97.1.tar.gz
Algorithm Hash digest
SHA256 60f3b11d435d1958940aa58704d57c689f63159c558c41f8711d6f7a87eb8a94
MD5 a80c8ad36959b0e8745dcd41251fe3a6
BLAKE2b-256 65c55fa495bf46091ecda52442acb0bf38b35a93b5eeed19f60f263173687add

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for spikeinterface-0.97.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0c2d01191ddd27757b6aff8af25c05c0e1243281d447e39fbf6c15f073413c3
MD5 84fccc8346afb5b9e9168cce692157dc
BLAKE2b-256 334d5f7f818bd78d6113bd13704ac933212aac8930bcfb63127d8cf8f1ef4f76

See more details on using hashes here.

Provenance

Supported by

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