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

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.98.0.tar.gz (545.6 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.98.0-py3-none-any.whl (747.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for spikeinterface-0.98.0.tar.gz
Algorithm Hash digest
SHA256 dc122faa2977d0abc9bf5320e0850cf01c92118d7b7fe168c60a203881849ff1
MD5 981355d00a578ca66e8ee25f1a3daa47
BLAKE2b-256 ef36a7034afbd01f142914ffee6d757513e0dfd311c5f481cc794a17ad1ebfde

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for spikeinterface-0.98.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f535014e5dca4dfb184f5902d9a11d691ecf2235f744904d8eaac4cb20781e1a
MD5 d6ac0379ace3f705c7936c557aea7afc
BLAKE2b-256 3292b14aea24f0a210196a028832fbceff05eabbbbac60fb46d59d8c3a6ab207

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