summaryrefslogtreecommitdiff
path: root/Readme.md
blob: bf80553fac98e2a491a8bd7e797a7db19ed38fe4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# PySpike

PySpike is a Python library for numerical analysis of spike train similarity. 
Its core functionality is the implementation of the bivariate [ISI and SPIKE distance](http://www.scholarpedia.org/article/Measures_of_spike_train_synchrony). 
Additionally, it allows to compute multi-variate spike train distances, averaging and general spike train processing.

All source codes are published under the liberal [MIT License](http://opensource.org/licenses/MIT).

## Requirements and Installation

To use PySpike you need Python installed with the following additional packages:

- numpy
- scipy
- matplotlib
- cython
- nosetests (for running the tests)

In particular, make sure that [cython](http://www.cython.org) is configured properly and able to locate a C compiler.

To install PySpike, simply download the source, i.e. via git, and run the setup.py script:

    git clone ...
    cd PySpike
    python setup.py build_ext --inplace

Then you can run the tests using the `nosetests` test framework:

    cd test
    nosetests

## Loading spike trains


## Computing bi-variate distances


## Computing multi-variate distances


## Plotting


## Averaging