Skip to content

Commit

Permalink
updated readme with basic info
Browse files Browse the repository at this point in the history
  • Loading branch information
pavanramkumar committed Jun 21, 2016
1 parent 89dfd76 commit a1f70ae
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Pavan Ramkumar

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
35 changes: 34 additions & 1 deletion README.md
@@ -1,2 +1,35 @@
# spykes
Tools of spike data analysis and visualization

Spykes is a collection of tools to make the visualization and analysis of neural data easy and reproducible.

At present, this project comes with two packages:
- ```spykes``` helps you plot beautiful spike rasters and peri-stimulus time histograms
- ```neuropop``` helps you estimate tuning curves of neural populations and decode preferred stimuli from population vectors

Documentation, tutorials and examples are coming soon!

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://github.com/KordingLab/spykes/blob/master/LICENSE)

### Installation

Clone the repository.

```bash
$ git clone http://github.com/KordingLab/spykes
```

Install `spykes` using `setup.py` as follows

```bash
$ cd spykes
$ python setup.py develop install
```

### Authors

* [Pavan Ramkumar](http:/github.com/pavanramkumar)
* [Hugo Fernandes](http:/github.com/hugoguh)

### Acknowledgments

* [Konrad Kording](http://kordinglab.com) for funding and support

0 comments on commit a1f70ae

Please sign in to comment.