Dareplane c-VEP Decoder

This is a module compatible with the Dareplane platform. It provides a decoding module to classify the code-modulated visual evoked potential (c-VEP) from the EEG.

Installation

To download the dp-cvep-speller, use:

git clone https://github.com/thijor/dp-cvep-decoder.git

Make sure that requirements are installed, ideally in a separate conda environment:

conda create --name dp-cvep-decoder python=3.10
conda activate dp-cvep-decoder
pip install -r requirements.txt

Getting started

To run the dp-cvep-speller module in isolation, use:

python -m cvep_decoder.decoder.py

This will run a minimal example using defaults as specified in configs/decoder.toml.

Citation

If you use Dareplane or this model for your work, please cite both the following two references:

@article{dold2025,
    title = {Dareplane: a modular open-source software platform for {BCI} research with application in closed-loop deep brain stimulation},
    author = {Dold, Matthias and Pereira, Joana and Sajonz, Bastian and Coenen, Volker A and Thielen, Jordy and Janssen, Marcus L F and Tangermann, Michael},
    journal = {Journal of Neural Engineering},
    year = {2025},
    month = {mar},
    publisher = {IOP Publishing},
    volume = {22},
    number = {2},
    pages = {026029},
    doi = {10.1088/1741-2552/adbb20},
    url = {https://doi.org/10.1088/1741-2552/adbb20},
}

@article{thielen2021,
    title = {From full calibration to zero training for a code-modulated visual evoked potentials for brain--computer interface},
    author = {Thielen, Jordy and Marsman, Pieter and Farquhar, Jason and Desain, Peter},
    journal = {Journal of Neural Engineering},
    publisher = {IOP Publishing Ltd},
    volume = {18},
    number = {5},
    pages = {056007},
    year = {2021},
    doi = {10.1088/1741-2552/abecef},
    url = {https://doi.org/10.1088/1741-2552/abecef}
}