Metadata-Version: 2.4
Name: simianpy
Version: 0.1.11
Summary: Data analysis tools designed for working with primate neuroscientific data
Author-email: Janahan Selvanayagam <me@janahan.ca>
License-File: LICENSE.txt
Keywords: behaviour,electrophysiology,signal processing
Requires-Python: >=3.13
Requires-Dist: click
Requires-Dist: h5py
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: pyyaml
Requires-Dist: scipy
Requires-Dist: tables
Requires-Dist: tqdm
Requires-Dist: xarray
Provides-Extra: full
Requires-Dist: colorama; extra == 'full'
Requires-Dist: ipython; extra == 'full'
Requires-Dist: pyqtmgl; extra == 'full'
Description-Content-Type: text/markdown

# SimianPy

**Author**: Janahan Selvanayagam  
**E-mail**: <seljanahan@hotmail.com>  

Data analysis tools designed for working with primate neuroscientific data

```python
>>> import simianpy as simi
>>> from simianpy.analysis.spiketrain import SpikeTrainSet
>>> from simianpy.analysis.gaze import GazeData
>>> from simianpy.signal.sosfilter import sosFilter
```

# Installation  

To install directly from github, use pip (or pip3 as appropriate):
```
pip install git+https://github.com/jselvan/simianpy.git
```

Or to install locally, clone this repo and run setuptools from the command line:
```
python setup.py install
```

To install a specific version, use pip and the appropriate release tag:
```
pip install git+file:///PATH_TO_REPO/.git@0.1.1-a1
```
OR
```
pip install git+https://github.com/jselvan/simianpy.git@0.1.1-a1
```

## For developers
to install in development mode, from the repo directory, use:
```
python setup.py install develop
```
OR 
```
pip install -e .
```

# Instructions
For help on using the code, rely on docstrings built into the code.  

For example:  
```python
>>> import simianpy as simi
>>> help(simi) 
```

Sphinx autodocumentation build in progress! See docs subdirectory

# License
The MIT License

Copyright (c) 2019, Janahan Selvanayagam  

[Read here](LICENSE.txt)
