https://github.com/venthur/wyrm
OFFICIAL REPOSITORY HAS MOVED TO: https://github.com/bbci/wyrm
https://github.com/venthur/wyrm
Last synced: about 1 year ago
JSON representation
OFFICIAL REPOSITORY HAS MOVED TO: https://github.com/bbci/wyrm
- Host: GitHub
- URL: https://github.com/venthur/wyrm
- Owner: venthur
- License: mit
- Created: 2013-01-17T08:23:45.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2016-06-13T08:33:31.000Z (about 10 years ago)
- Last Synced: 2025-04-07T05:11:32.482Z (about 1 year ago)
- Language: Python
- Homepage:
- Size: 1.69 MB
- Stars: 14
- Watchers: 9
- Forks: 49
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# The official repository has moved!
The official Wyrm repository has a new home at the [BBCI github account][bbci].
Please use the new one for forks, issues, etc.
[bbci]: https://github.com/bbci/wyrm
# Wyrm
Wyrm is a Brain Computer Interface (BCI) toolbox written in Python. Wyrm is
suitable for running on-line BCI experiments as well as off-line analysis of EEG
data.
Online documentation is available [here][wyrmdoc].
[wyrmdoc]: http://venthur.github.io/wyrm
## Installation
### Using git
Use distutils to install Wyrm into your `PYTHONPATH`:
```bash
$ git clone http://github.com/venthur/wyrm
$ cd wyrm
$ python setup.py install --user
```
this will always give you the latest development version of Wyrm.
### Using PyPI
Wyrm is also available on the [Python Package Index (PyPI)][pypi] and can be
easily installed via:
```bash
$ pip install wyrm
```
[pypi]: https://pypi.python.org/pypi/Wyrm
## Examples
In the `examples` directory, you'll find, among others, examples for various BCI
tasks using publicly available BCI datasets from the [BCI Competition][bcicomp].
* An example for classification of motor imagery in ECoG recordings. For that
example the [BCI Competition3, Data Set 1][bcicomp3ds1] was used.
* An example for classification with a P300 Matrix Speller in EEG recordings.
The [BCI Competition 3, Data Set 2][bcicomp3ds2] was used for that example.
You can follow those examples by downloading the data and copying the files to
the appropriate places.
[bcicomp]: http://www.bbci.de/competition
[bcicomp3ds1]: http://www.bbci.de/competition/iii/#data_set_i
[bcicomp3ds2]: http://www.bbci.de/competition/iii/#data_set_ii
## Python 3 Support
Wyrm is mainly developed under Python 2.7, however since people will eventually
move on to Python 3 we try to be forward compatible by writing the code in a way
that it runs on Python 2 and -3.
[](https://travis-ci.org/venthur/wyrm)
Whenever a new version of Wyrm is pushed to github, the [Travis continuous
integration service][travisci] will run Wyrm's whole test suite with Python 2.7,
3.3, and 3.4. If and only if all three test suites pass, the build is shown as
"passing".
[travisci]: https://travis-ci.org/venthur/wyrm
## Related Software
For a complete BCI system written in Python use Wyrm together with
[Mushu][mushu] and [Pyff][pyff]. Mushu is a BCI signal acquisition and Pyff a
BCI feedback and -stimulus framework.
[pyff]: http://github.com/venthur/pyff
[mushu]: http://github.com/venthur/mushu
Citing Us
=========
If you use Wyrm for anything that results in a publication, We humbly ask you to
cite us:
```bibtex
@Article{venthur2015,
author={Venthur, Bastian and Dähne, Sven and Höhne, Johannes and Heller, Hendrik and Blankertz, Benjamin},
title={Wyrm: A Brain-Computer Interface Toolbox in Python},
journal={Neuroinformatics},
year={2015},
volume={13},
number={4},
pages={471--486},
issn={1559-0089},
doi={10.1007/s12021-015-9271-8},
url={http://dx.doi.org/10.1007/s12021-015-9271-8}
}
```