Metadata-Version: 2.1
Name: alphawaves
Version: 0.4
Summary: Alpha Waves Dataset
Home-page: https://github.com/plcrodrigues/Alpha-Waves-Dataset
Author: Pedro Rodrigues
Author-email: pedro.rodrigues01@gmail.com
License: new BSD
Keywords: EEG neuroscience signal processing
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# Alpha Waves Dataset
Repository with basic scripts for using the Alpha Waves Dataset developed at GIPSA-lab [1]. The dataset files and their documentation are all available at 

[https://zenodo.org/record/2348892](https://zenodo.org/record/2348892#.XBdqNs9Ki3I)

The code of this repository was developed in **Python 3.8 and 3.9** using MNE-Python [2, 3] as tool for the EEG processing.

The package can be downloaded with pip:

```
pip install alphawaves
```

Alternatively, you might want to clone the github repository on your local computer, and install the package by running:

```
python setup.py develop
```

All dependencies are listed in `requirements.txt` for your interest.


Then, to ensure that your code finds the right scripts, open a python shell and type:

```
import alphawaves
```


Note that you might want to create a *virtual environment* before doing all these installations, e.g.:

```
conda create -n eegalpha python=3.8
```

# References

[1] Cattan et al. "EEG Alpha Waves dataset" [DOI](https://10.5281/zenodo.2348891)

[2] Gramfort et al. "MNE software for processing MEG and EEG data" [DOI](https://doi.org/10.1016/j.neuroimage.2013.10.027)

[3] Gramfort et al. "MEG and EEG data analysis with MNE-Python" [DOI](https://doi.org/10.3389/fnins.2013.00267)

