BCI Essentials Python

External Link

BCI Essentials python is a library built to process and classify EEG data marked by a BCI Essentials front end. Modules are designed to be equivalent whether run with live data or a recording.

BCI Essentials requires Python 3.10 or later. To install for Windows, MacOS or Linux:

pip install bci-essentials

More detailed instructions on installing BCI-Essentials-Python (such as setting up a virtual environment in conda) can be found here.

As a Back End

For most application developers, the back ends implemented in example scripts will be most useful. Running any of these will provide a functional back end for a BCI Essentials front end. Both an EEG and Marker stream are required.

After downloading the example script:

python mi_unity_backend.py

Simulating an EEG Stream

Depends on data files located in the github repository.

You may not always have access to live eeg data with which to test. As a convenient alternative, you can run the eeg_lsl_sim script to open and run a stream of dummy LSL data.

python examples/eeg_lsl_sim.py [paradigm] [-n]

Tutorials

There are a number of example notebooks in the github repository demonstrating how to work with offline (recorded) data.

API Documentation

A readable summary of code and code comments automatically collected into a more readable format.