Skip to content

Latest commit

 

History

History
106 lines (83 loc) · 2.92 KB

README.md

File metadata and controls

106 lines (83 loc) · 2.92 KB
Raw

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:

  • breaks backward compatibility with 0.10/0.11/0.12/0.13 series.
  • has been first released in July 2021 (0.90.0)
  • is not a meta-package anymore
  • it doesn't depend on spikeextractors/spiketoolkit/spikesorters/spikecomparison/spikewidgets anymore

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

You can also have a look at the spikeinterface-gui.

Documentation

All documentation for spikeinterface 0.90 can be found here.

Documentation of current API release 0.12.0 is here.

How to install new SI version (0.90)

You can install the new spikeinterface version with pip:

pip install spikeinterface==0.90

To get the latest updates, you can install spikeinterface from sources:

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

To install the olde spikeinterface API, you can use pip and point to the old version:

pip install spikeinterface==0.13

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