Python toolkit for analysis, visualization, and comparison of spike sorting output
Project description
SpikeInterface: a unified framework for spike sorting
| Latest Release |
|
| Documentation |
|
| License |
|
| Build Status |
|
| Codecov |
|
:warning::warning::warning: New features under construction! 🚧🚧🚧: after the 0.100.0 release (and related bug fixes), the next release will contain a major API improvement: the
SortingAnalyzer. To read more about this, checkout the enhancement proposal. Please refer to the stable documentation here
SpikeInterface is a Python framework designed to unify preexisting spike sorting technologies into a single code base.
Please Star the project to support us and Watch to always stay up-to-date!
With SpikeInterface, users can:
- read/write many extracellular file formats.
- pre-process extracellular recordings.
- run many popular, semi-automatic spike sorters (also in Docker/Singularity containers).
- post-process sorted datasets.
- compare and benchmark spike sorting outputs.
- compute quality metrics to validate and curate spike sorting outputs.
- visualize recordings and spike sorting outputs in several ways (matplotlib, sortingview, jupyter, ephyviewer)
- export a report and/or export to phy
- offer a powerful Qt-based viewer in a separate package spikeinterface-gui
- have powerful sorting components to build your own sorter.
Documentation
Detailed documentation of the latest PyPI release of SpikeInterface can be found here.
Detailed documentation of the development version of SpikeInterface can be found here.
Several tutorials to get started can be found in spiketutorials.
There are also some useful notebooks on our blog that cover advanced benchmarking and sorting components.
You can also have a look at the spikeinterface-gui.
How to install spikeinterface
You can install the latest version of spikeinterface version with pip:
pip install spikeinterface[full]
The [full] option installs all the extra dependencies for all the different sub-modules.
To install all interactive widget backends, you can use:
pip install spikeinterface[full,widgets]
To get the latest updates, you can install spikeinterface from source:
git clone https://github.com/SpikeInterface/spikeinterface.git
cd spikeinterface
pip install -e .
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}
}
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file spikeinterface-0.101.0rc0.tar.gz.
File metadata
- Download URL: spikeinterface-0.101.0rc0.tar.gz
- Upload date:
- Size: 651.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f94436763f618ac9d2269b29e3627e1c6144e6421a93e93c9e5f0cea57987f2f |
|
| MD5 | 6b6d945951fbe732e3ab0e2afcc96529 |
|
| BLAKE2b-256 | 0661b83ede71564cf952d3bd298647f70da2d25b89585da1a83d097db0de042f |
Provenance
File details
Details for the file spikeinterface-0.101.0rc0-py3-none-any.whl.
File metadata
- Download URL: spikeinterface-0.101.0rc0-py3-none-any.whl
- Upload date:
- Size: 839.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ed55c2ecf906f4e71f7b8136d6f5143ebac2da9547613ecb6476944bfd2f6b59 |
|
| MD5 | 872e1f278679d4c7972739574fcaff7b |
|
| BLAKE2b-256 | 514efcb1bcfd585b7ef991182fb693a55c46c78005ad16db91f09d7fdf3cb9bb |
