Metadata-Version: 2.4
Name: spyking-circus
Version: 1.1.0
Summary: Fast spike sorting by template matching
Home-page: http://spyking-circus.rtfd.org
Author: Pierre Yger and Olivier Marre
Author-email: pierre.yger@inserm.fr
License: License :: OSI Approved :: CeCILL-2.1
Keywords: spike sorting template matching tetrodes extracellular
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: License :: Other/Proprietary License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: numpy
Requires-Dist: cython
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: h5py
Requires-Dist: colorama
Requires-Dist: psutil
Requires-Dist: tqdm
Requires-Dist: blosc
Requires-Dist: statsmodels
Requires-Dist: setuptools
Provides-Extra: beer
Requires-Dist: scikit-learn; extra == "beer"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

SpyKING CIRCUS
==============

.. image:: http://spyking-circus.readthedocs.io/en/latest/_images/circus.png
   :alt: SpyKING CIRCUS logo


*A fast and scalable solution for spike sorting of large-scale extracellular recordings*

SpyKING CIRCUS is a python code to allow fast spike sorting on multi channel recordings. 
A publication on the algorithm can be found at https://elifesciences.org/articles/34518
It has been tested on datasets coming from *in vitro* retina 
with 252 electrodes MEA, from *in vivo* hippocampus with tetrodes, *in vivo* and *in vitro* cortex 
data with 30 and up to 4225 channels, with good results. Synthetic tests on these data show 
that cells firing at more than 0.5Hz can be detected, and their spikes recovered with error 
rates at around 1%, even resolving overlapping spikes and synchronous firing. It seems to 
be compatible with optogenetic stimulation, based on experimental data obtained in the retina.

SpyKING CIRCUS is currently still under development. Please do not hesitate to report issues with the issue tracker

* Documentation can be found at http://spyking-circus.rtfd.org
* A Google group can be found at http://groups.google.com/forum/#!forum/spyking-circus-users
* A bug tracker can be found at https://github.com/spyking-circus/spyking-circus/issues
* Open source ground-truth datasets used in the paper https://zenodo.org/record/1205233#.WrTFtXXwaV4

:copyright: Copyright 2006-2020 by the SpyKING CIRCUS team, see AUTHORS.
:license: CeCILL, see LICENSE for details.

.. image::  https://anaconda.org/spyking-circus/spyking-circus/badges/version.svg
    :target: https://anaconda.org/spyking-circus/spyking-circus

.. image::  https://badge.fury.io/py/spyking-circus.svg
    :target: https://badge.fury.io/py/spyking-circus

.. image:: https://img.shields.io/badge/docs-latest-brightgreen.svg?style=flat
    :target: http://spyking-circus.readthedocs.io/en/latest/?badge=latest

.. image:: https://github.com/spyking-circus/spyking-circus/workflows/Tests%20on%20Linux/badge.svg
    :target: https://github.com/spyking-circus/spyking-circus/actions

.. image:: https://github.com/spyking-circus/spyking-circus/workflows/Tests%20on%20OS%20X/badge.svg
    :target: https://github.com/spyking-circus/spyking-circus/actions

.. image:: https://github.com/spyking-circus/spyking-circus/workflows/Tests%20on%20Windows/badge.svg
    :target: https://github.com/spyking-circus/spyking-circus/actions
