Skip to main content

Spike detection and automatic clustering for spike sorting

Project description

# Klusta: automatic spike sorting up to 64 channels

[![Build Status](https://img.shields.io/travis/kwikteam/klusta.svg)](https://travis-ci.org/kwikteam/klusta) [![codecov.io](https://img.shields.io/codecov/c/github/kwikteam/klusta.svg)](http://codecov.io/github/kwikteam/klusta?branch=master) [![Documentation Status](https://readthedocs.org/projects/klusta/badge/?version=latest)](http://klusta.readthedocs.org/en/latest/) [![PyPI release](https://img.shields.io/pypi/v/klusta.svg)](https://pypi.python.org/pypi/klusta) [![GitHub release](https://img.shields.io/github/release/kwikteam/klusta.svg)](https://github.com/kwikteam/klusta/releases/latest)

[klusta](https://github.com/kwikteam/klusta) is an open source automatic spike sorting package for multielectrode neurophysiological recordings that scales to probes with up to 64 interdependent channels.

We are also working actively on more sophisticated algorithms that will scale to hundreds/thousands of channels. This work is being done within the [phy project](https://github.com/kwikteam/phy), which is still experimental at this point.

## Overview

klusta implements the following features:

  • Kwik: An HDF5-based file format that stores the results of a spike sorting session.

  • Spike detection (also known as SpikeDetekt): an algorithm designed for relatively large probes, based on a flood-fill algorithm in the adjacency graph formed by the recording sites in the probe.

  • Automatic clustering (also known as Masked KlustaKwik): an automatic clustering algorithm designed for high-dimensional structured datasets.

## GUI

You will need a GUI to visualize the spike sorting results. No GUI is included in this repository.

We have developed two GUI programs:

  • [KlustaViewa](https://github.com/klusta-team/klustaviewa): scales up to 64 channels, well-tested by many users over the last few years.

  • phy KwikGUI: scales to hundreds/thousands of channels, still experimental. We will add a link when this GUI is ready (later in 2016).

## Technical details

klusta is written in pure Python. The clustering code, written in Python and Cython, currently lives in [another repository](https://github.com/kwikteam/klustakwik2/).

## Getting started

You will find installation instructions and a quick start guide in the [documentation](http://klusta.readthedocs.org/en/latest/) (work in progress).

## Links

## Credits

klusta is developed by [Cyrille Rossant](http://cyrille.rossant.net), [Shabnam Kadir](https://iris.ucl.ac.uk/iris/browse/profile?upi=SKADI56), [Dan Goodman](http://thesamovar.net/), [Max Hunter](https://iris.ucl.ac.uk/iris/browse/profile?upi=MLDHU99), and [Kenneth Harris](https://iris.ucl.ac.uk/iris/browse/profile?upi=KDHAR02), in the [Cortexlab](https://www.ucl.ac.uk/cortexlab), University College London.

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

klusta-3.0.dev2.tar.gz (69.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

klusta-3.0.dev2-py2.py3-none-any.whl (84.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file klusta-3.0.dev2.tar.gz.

File metadata

  • Download URL: klusta-3.0.dev2.tar.gz
  • Upload date:
  • Size: 69.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for klusta-3.0.dev2.tar.gz
Algorithm Hash digest
SHA256 12b1e4b65776a3e7441a0b87a7c6c3f4c2c539d65529e39cfa972f7634caca4e
MD5 e75039ee0360e704cba522107ebfdaae
BLAKE2b-256 43732b066efbfa1c25f802e8deb441b95c868f71770e2a425ed4c6b028ec379b

See more details on using hashes here.

File details

Details for the file klusta-3.0.dev2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for klusta-3.0.dev2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 10854ffec1503672b8cfc86bd78aed89e4af401c99fe77de6dd2cbc3094515b6
MD5 c71804f9eb48c90312ad69ba27cb5e13
BLAKE2b-256 6b4f1b20864f2b181c4000aa08f5aa5b5e2663e592df514f037f95c3de51f451

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