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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

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