Skip to content

Latest commit

 

History

History
102 lines (82 loc) · 2.78 KB

README.md

File metadata and controls

102 lines (82 loc) · 2.78 KB

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 version 0.90.0:

  • break backward compatility with 0.10/0.11/0.12 series.
  • will be release summer 2021
  • is no more a metapackage
  • no more depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets

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

Documentation

All documentation for spikeinterface work-in-progress can be found here.

Documentation of current API release 0.12.0 is here.

How to install work-in-progress version

Here a simple recipe to install work-in-progress version (0.90.0.dev0):

git clone https://github.com/NeuralEnsemble/python-neo.git
cd python-neo
python setup.py install (or develop)
cd ..

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

git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
python setup.py install (or develop)
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}
}