Skip to main content

Python toolkit for analysis, visualization, and comparison of spike sorting output

Project description

PyPI version

SpikeInterface

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 October 8, 2019, we have released the very first beta version of spikeinterface (0.9.1)

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

Installation

You can install SpikeInterface from pip:

pip install spikeinterface

Alternatively, you can clone the repository and install from sources the development version:

git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
python setup.py develop

Important: installing with python setup.py develop DOES NOT install the latest version of the different modules. In order to get the latest updates, clone the above-mentioned repositories and install them from source.

Documentation

All documentation for SpikeInterface can be found here: https://spikeinterface.readthedocs.io/en/latest/.

You can also check out this 1-hour video tutorial for the NWB User Days 2019: https://www.youtube.com/watch?v=nWJGwFB7oII

Citation

If you find SpikeInterface useful in your research, please cite:

@article{buccino2019spikeinterface,
  title={SpikeInterface, a unified framework for spike sorting},
  author={Buccino, Alessio P and Hurwitz, Cole L and Magland, Jeremy and Garcia, Samuel and Siegle, Joshua H and Hurwitz, Roger and Hennig, Matthias H},
  journal={BioRxiv},
  pages={796599},
  year={2019},
  publisher={Cold Spring Harbor Laboratory}
}

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 24 August 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.10.0.tar.gz (7.0 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.10.0-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spikeinterface-0.10.0.tar.gz
  • Upload date:
  • Size: 7.0 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.10.0.tar.gz
Algorithm Hash digest
SHA256 9a7459ce7d40da7371bc6cc605c4efb3401934712b2683215ac5f8ddcd809166
MD5 390b901374e8c53359d9e5602b9c6eca
BLAKE2b-256 4083502f61d95047cad39b9f7297683c76031f32dfd49c207f6d2e72f357da55

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spikeinterface-0.10.0-py3-none-any.whl
  • Upload date:
  • Size: 6.2 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.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 23299d00ac889cd6a19b5af86906e69024410f75c37f1b144846be4615136b40
MD5 17c617f1ca86f40cc898320659400cea
BLAKE2b-256 e42185159512241e384fd1203d2b08d835e76b3ab30190555b215a9730dcee8b

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