Metadata-Version: 2.1
Name: bstadlbauer.p300speller
Version: 0.1.1
Summary: P300 speller based on LSL
Home-page: https://github.com/bstadlbauer/lsl-p300-speller
License: GPL-3.0-only
Author: Bernhard Stadlbauer
Author-email: b.stadlbauer@gmx.net
Requires-Python: >=3.6.1,<4.0.0
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: Pillow (>=8.0.1,<9.0.0)
Requires-Dist: numpy (>=1.19.2,<2.0.0)
Requires-Dist: pylsl (>=1.13.6,<2.0.0)
Project-URL: Repository, https://github.com/bstadlbauer/lsl-p300-speller
Description-Content-Type: text/markdown

# LSL P300 speller
This repository contains a P300 speller based on [LSL](https://github.com/sccn/labstreaminglayer) and tkinter.

## Installation

### Dependencies
This project uses [poetry](https://python-poetry.org/) to manage its dependencies. Visit their website on how to install
poetry for you operating system. The whole projects supports `python>=3.6.1`.

### Installing the package
Run the following to install the `bstadlbauer.p300speller` package:
```
git clone https://github.org/bstadlbauer/lsl-p300-speller
poetry install
```
which will setup a new virtual environment for the project and install the necessary dependencies.

## Getting Started
After installation, an entrypoint is avaibable to start the speller
```
poetry run start-speller
```

## Questions and Issues
If there are any questions or you run into an issue, please file a 'Issue' at the top.

## Contributing
If you want to contribute, please file also file an issue first where the new feature can be discussed, in general
contribution is welcome!

To setup the development environment, do the following:
```
git clone https://github.org/bstadlbauer/lsl-p300-speller
poetry install
pre-commit install
```
To ensure consistent formatting and linting pre-commit hooks (managed through [`pre-commit`](https://pre-commit.com/))
are used.

# Acknowledgement
This tool was developed by myself as part of a project done at the
[Institute of Neural Engineering](https://www.tugraz.at/institutes/ine/home/).
The work was supervised by Assoc.Prof. Dipl.-Ing. Dr.techn. Reinhold Scherer.

