Metadata-Version: 2.1
Name: spikeinterface
Version: 0.100.6
Summary: Python toolkit for analysis, visualization, and comparison of spike sorting output
Author-email: Alessio Buccino <alessiop.buccino@gmail.com>, Samuel Garcia <sam.garcia.die@gmail.com>
Project-URL: homepage, https://github.com/SpikeInterface/spikeinterface
Project-URL: repository, https://github.com/SpikeInterface/spikeinterface
Project-URL: documentation, https://spikeinterface.readthedocs.io/
Project-URL: changelog, https://spikeinterface.readthedocs.io/en/latest/whatisnew.html
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: OS Independent
Requires-Python: <4.0,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: threadpoolctl >=3.0.0
Requires-Dist: tqdm
Requires-Dist: zarr >=0.2.16
Requires-Dist: neo >=0.13.0
Requires-Dist: probeinterface >=0.2.21
Provides-Extra: dev
Requires-Dist: spikeinterface[test] ; extra == 'dev'
Requires-Dist: spikeinterface[test_core] ; extra == 'dev'
Requires-Dist: spikeinterface[docs] ; extra == 'dev'
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: Sphinx ==5.1.1 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ==1.0.0 ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: ipython ; extra == 'docs'
Requires-Dist: MEArec ; extra == 'docs'
Requires-Dist: datalad ==0.16.2 ; extra == 'docs'
Requires-Dist: pandas ; extra == 'docs'
Requires-Dist: hdbscan >=0.8.33 ; extra == 'docs'
Requires-Dist: numba ; extra == 'docs'
Provides-Extra: extractors
Requires-Dist: MEArec >=1.8 ; extra == 'extractors'
Requires-Dist: pynwb >=2.6.0 ; extra == 'extractors'
Requires-Dist: hdmf-zarr >=0.5.0 ; extra == 'extractors'
Requires-Dist: pyedflib >=0.1.30 ; extra == 'extractors'
Requires-Dist: lxml ; extra == 'extractors'
Requires-Dist: scipy ; extra == 'extractors'
Requires-Dist: ONE-api >=1.19.1 ; extra == 'extractors'
Requires-Dist: ibllib >=2.21.0 ; extra == 'extractors'
Requires-Dist: pymatreader >=0.0.32 ; extra == 'extractors'
Requires-Dist: sonpy ; (python_version < "3.10") and extra == 'extractors'
Requires-Dist: zugbruecke >=0.2 ; (sys_platform != "win32") and extra == 'extractors'
Provides-Extra: full
Requires-Dist: h5py ; extra == 'full'
Requires-Dist: pandas ; extra == 'full'
Requires-Dist: xarray ; extra == 'full'
Requires-Dist: scipy ; extra == 'full'
Requires-Dist: scikit-learn ; extra == 'full'
Requires-Dist: networkx ; extra == 'full'
Requires-Dist: distinctipy ; extra == 'full'
Requires-Dist: matplotlib ; extra == 'full'
Requires-Dist: numba ; extra == 'full'
Requires-Dist: cuda-python ; (platform_system != "Darwin") and extra == 'full'
Provides-Extra: qualitymetrics
Requires-Dist: scikit-learn ; extra == 'qualitymetrics'
Requires-Dist: scipy ; extra == 'qualitymetrics'
Requires-Dist: pandas ; extra == 'qualitymetrics'
Requires-Dist: numba ; extra == 'qualitymetrics'
Provides-Extra: streaming_extractors
Requires-Dist: ONE-api >=1.19.1 ; extra == 'streaming_extractors'
Requires-Dist: ibllib >=2.21.0 ; extra == 'streaming_extractors'
Requires-Dist: fsspec ; extra == 'streaming_extractors'
Requires-Dist: aiohttp ; extra == 'streaming_extractors'
Requires-Dist: requests ; extra == 'streaming_extractors'
Requires-Dist: pynwb >=2.6.0 ; extra == 'streaming_extractors'
Requires-Dist: hdmf-zarr >=0.5.0 ; extra == 'streaming_extractors'
Requires-Dist: remfile ; extra == 'streaming_extractors'
Requires-Dist: s3fs ; extra == 'streaming_extractors'
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-dependency ; extra == 'test'
Requires-Dist: pytest-cov ; extra == 'test'
Requires-Dist: xarray ; extra == 'test'
Requires-Dist: huggingface-hub ; extra == 'test'
Requires-Dist: numba ; extra == 'test'
Requires-Dist: hdbscan >=0.8.33 ; extra == 'test'
Requires-Dist: sortingview ; extra == 'test'
Requires-Dist: datalad ==0.16.2 ; extra == 'test'
Requires-Dist: tridesclous >=1.6.8 ; extra == 'test'
Requires-Dist: pymde ; extra == 'test'
Requires-Dist: torch ; extra == 'test'
Requires-Dist: pynndescent ; extra == 'test'
Provides-Extra: test_core
Requires-Dist: pytest ; extra == 'test_core'
Requires-Dist: psutil ; extra == 'test_core'
Provides-Extra: widgets
Requires-Dist: matplotlib ; extra == 'widgets'
Requires-Dist: ipympl ; extra == 'widgets'
Requires-Dist: ipywidgets ; extra == 'widgets'
Requires-Dist: sortingview >=0.12.0 ; extra == 'widgets'

# SpikeInterface: a unified framework for spike sorting

<table>
<tr>
  <td>Latest Release</td>
  <td>
    <a href="https://pypi.org/project/spikeinterface/">
    <img src="https://img.shields.io/pypi/v/spikeinterface.svg" alt="latest release" />
    </a>
  </td>
</tr>
<tr>
  <td>Documentation</td>
  <td>
    <a href="https://spikeinterface.readthedocs.io/">
    <img src="https://readthedocs.org/projects/spikeinterface/badge/?version=latest" alt="latest documentation" />
    </a>
  </td>
</tr>
<tr>
  <td>License</td>
  <td>
    <a href="https://github.com/SpikeInterface/spikeinterface/blob/master/LICENSE">
    <img src="https://img.shields.io/pypi/l/spikeinterface.svg" alt="license" />
    </a>
</td>
</tr>
<tr>
  <td>Build Status</td>
  <td>
    <a href="https://github.com/SpikeInterface/spikeinterface/actions/workflows/full-test-with-codecov.yml/badge.svg">
    <img src="https://github.com/SpikeInterface/spikeinterface/actions/workflows/full-test-with-codecov.yml/badge.svg" alt="CI build status" />
    </a>
  </td>
</tr>
<tr>
	<td>Codecov</td>
	<td>
		<a href="https://codecov.io/github/spikeinterface/spikeinterface">
		<img src="https://codecov.io/gh/spikeinterface/spikeinterface/branch/main/graphs/badge.svg" alt="codecov" />
		</a>
	</td>
</tr>
</table>

[![Twitter](https://img.shields.io/badge/@spikeinterface-%231DA1F2.svg?style=for-the-badge&logo=Twitter&logoColor=white)](https://twitter.com/spikeinterface) [![Mastodon](https://img.shields.io/badge/-@spikeinterface-%232B90D9?style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@spikeinterface)


> :warning::warning::warning: **PRs with new features are frozen!**: after the 0.100.0 release, we will not accept PRs with new features (only bug fixes) until February 21st 2024.


SpikeInterface is a Python framework designed to unify preexisting spike sorting technologies into a single code base.

Please [Star](https://github.com/SpikeInterface/spikeinterface/stargazers) the project to support us and [Watch](https://github.com/SpikeInterface/spikeinterface/subscription) 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](https://github.com/SpikeInterface/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](https://spikeinterface.readthedocs.io/en/0.100.0).

Detailed documentation of the development version of SpikeInterface can be found [here](https://spikeinterface.readthedocs.io/en/latest).

Several tutorials to get started can be found in [spiketutorials](https://github.com/SpikeInterface/spiketutorials).

There are also some useful notebooks [on our blog](https://spikeinterface.github.io) that cover advanced benchmarking
and sorting components.

You can also have a look at the [spikeinterface-gui](https://github.com/SpikeInterface/spikeinterface-gui).


## How to install spikeinterface

You can install the latest version of `spikeinterface` version with pip:

```bash
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:

```bash
 pip install spikeinterface[full,widgets]
```


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

```bash
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:

```bibtex
@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}
}
```
