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
Gitter

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

spikeinterface is a meta-package that wraps 5 other Python packages from the SpikeInterface team:

  • spikeextractors: Data file I/O and probe handling. Build Status
  • spiketoolkit: Toolkit for pre-processing, post-processing, validation, and automatic curation. Build Status
  • spikesorters: Python wrappers to spike sorting algorithms. Build Status
  • spikecomparison: Comparison of spike sorting output (with and without ground-truth). Build Status
  • spikewidgets: Data visualization widgets. Build Status

On December 10, 2020, a new version of spikeinterface has been released (0.11.0). Check out the release notes

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

Installation

You can install SpikeInterface from pip:

pip install spikeinterface

The pip installation will install a specific and fixed version of the spikeinterface packages.

To use the latest updates, install spikeinterface and the related packages from source:

git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
python setup.py install (or develop)

Then you can install the latest releases of the spikeinterface packages:

pip install --upgrade spikeextractors spiketoolkit spikesorters spikecomparison spikewidgets

You can also install the five packages from sources (e.g. for spikeextractors):

git clone https://github.com/SpikeInterface/spikeextractors.git
cd spikeextractors
python setup.py install (or develop)

Documentation

All documentation for SpikeInterface can be found here.

You can also check out this 1-hour video tutorial for the NWB User Days 2020:

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

SpikeInterface contributors

For any correspondence, contact Alessio Buccino (alessiop.buccino@gmail.com), Cole Hurwitz (colehurwitz@gmail.com), Samuel Garcia (samuel.garcia@cnrs.fr), Jeremy Magland (jmagland@flatironinstitute.org) or Matthias Hennig (m.hennig@ed.ac.uk), or just write an issue!

The following people have contributed code to the project as of 10 Nov 2020:

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

Uploaded Source

Built Distribution

spikeinterface-0.11.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikeinterface-0.11.0.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

File hashes

Hashes for spikeinterface-0.11.0.tar.gz
Algorithm Hash digest
SHA256 3a807b3a7d836fbea2e57281008bcf0256b85debfe23922a535e10e617054d60
MD5 101669a9536506dccf4bfd3d3380d7c4
BLAKE2b-256 2f299734e37c1f47c78f379cef87d2c45b5897c8102caad18886fef8057ac10c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: spikeinterface-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 6.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0.post20200714 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

File hashes

Hashes for spikeinterface-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5a79e209ad4cc0265e8129083dce00c16f88858b1dabd11d9f91b06d613ffd9f
MD5 61db416697db3bde6e7c612b270e3d91
BLAKE2b-256 2cc8bd12a8d30959e6a08e1d91321c75f67adecd8d931c32013dba416d0201b4

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