|
a |
|
b/README.md |
|
|
1 |
pyeeg |
|
|
2 |
===== |
|
|
3 |
|
|
|
4 |
Python + EEG/MEG = PyEEG |
|
|
5 |
|
|
|
6 |
Welcome to PyEEG! This is a Python module with many functions for time series analysis, including brain physiological signals. Feel free to try it with any time series: biomedical, financial, etc. |
|
|
7 |
|
|
|
8 |
Installation |
|
|
9 |
------------ |
|
|
10 |
|
|
|
11 |
### Via Git |
|
|
12 |
|
|
|
13 |
Clone the repo via HTTPS: |
|
|
14 |
|
|
|
15 |
```sh |
|
|
16 |
$ git clone https://github.com/forrestbao/pyeeg.git |
|
|
17 |
``` |
|
|
18 |
|
|
|
19 |
This will create a new directory, `pyeeg` with the repo in it. Change into that directory and execute `setup.py`: |
|
|
20 |
|
|
|
21 |
```sh |
|
|
22 |
$ cd pyeeg |
|
|
23 |
$ python setup.py install |
|
|
24 |
``` |
|
|
25 |
|
|
|
26 |
To install under your home directory, try: |
|
|
27 |
```sh |
|
|
28 |
$ python setup.py install --user |
|
|
29 |
``` |
|
|
30 |
|
|
|
31 |
### Via pip |
|
|
32 |
|
|
|
33 |
pip supports installing from a GitHub repo. Follow the [instructions for cloning](https://pip.pypa.io/en/latest/reference/pip_install.html#git). |
|
|
34 |
|
|
|
35 |
Testing |
|
|
36 |
------- |
|
|
37 |
|
|
|
38 |
Run the test suite contained in `tests/`. |
|
|
39 |
|
|
|
40 |
```sh |
|
|
41 |
$ python setup.py test |
|
|
42 |
``` |
|
|
43 |
|
|
|
44 |
Cite |
|
|
45 |
------ |
|
|
46 |
If you use PyEEG in your research, please cite this paper: |
|
|
47 |
[PyEEG: An Open Source Python Module for EEG/MEG Feature Extraction](https://www.hindawi.com/journals/cin/2011/406391/), Forrest Sheng Bao, Xin Liu, and Christina Zhang, Computational Intelligence and Neuroscience, volume 2011, Article ID 406391 |