Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wsarce authored Aug 22, 2021
1 parent 2768b19 commit 1184e9a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ Developer: Walker Arce<br>
### Motivation
This Python library was written to facilitate closed-loop experimental protocol for motor related research.

### Installation
Clone this repository, cd into the directory using either your virtual environment or your local environment, and run:
`python setup.py install`

### Usage
```
from pywoodway.treadmill import SplitBelt, find_treadmills
Expand Down Expand Up @@ -48,3 +52,14 @@ for port in ports:
```

Write down the serial number for each treadmill (if using a split belt these are marked A and B) and pass those as arguments to the `find_treadmills()` function.

### Citation
```
@misc{Arce_pyWoodway_2021,
author = {Arce, Walker and Gehringer, James},
month = {8},
title = {{pyWoodway}},
url = {https://github.com/Munroe-Meyer-Institute-VR-Laboratory/pyWoodway},
year = {2021}
}
```

0 comments on commit 1184e9a

Please sign in to comment.