# Mother of all BCI Benchmarks
<p align=center>
<img alt="banner" src="/images/M.png/">
</p>
<p align=center>
Build a comprehensive benchmark of popular Brain-Computer Interface (BCI) algorithms applied on an extensive list of freely available EEG datasets.
</p>
## Disclaimer
**This is an open science project that may evolve depending on the need of the
community.**
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10034224.svg)](https://doi.org/10.5281/zenodo.10034224)
[![Build Status](https://github.com/NeuroTechX/moabb/workflows/Test/badge.svg)](https://github.com/NeuroTechX/moabb/actions?query=branch%3Amaster)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![codecov](https://codecov.io/gh/NeuroTechX/moabb/graph/badge.svg?token=NwHD3ethB5)](https://codecov.io/gh/NeuroTechX/moabb)
[![PyPI](https://img.shields.io/pypi/v/moabb?color=blue&style=plastic)](https://img.shields.io/pypi/v/moabb)
[![Downloads](https://pepy.tech/badge/moabb)](https://pepy.tech/project/moabb)
## Welcome!
First and foremost, Welcome! :tada: Willkommen! :confetti_ball: Bienvenue!
:balloon::balloon::balloon:
Thank you for visiting the Mother of all BCI Benchmark repository.
This document is a hub to give you some information about the project. Jump straight to
one of the sections below, or just scroll down to find out more.
- [What are we doing? (And why?)](#what-are-we-doing)
- [Installation](#installation)
- [Running](#running)
- [Supported datasets](#supported-datasets)
- [Who are we?](#who-are-we)
- [Get in touch](#contact-us)
- [Documentation][link_moabb_docs]
- [Architecture and main concepts](#architecture-and-main-concepts)
- [Citing MOABB and related publications](#citing-moabb-and-related-publications)
## What are we doing?
### The problem
[Brain-Computer Interfaces](https://en.wikipedia.org/wiki/Brain%E2%80%93computer_interface)
allow to interact with a computer using brain signals. In this project, we focus mostly on
electroencephalographic signals
([EEG](https://en.wikipedia.org/wiki/Electroencephalography)), that is a very active
research domain, with worldwide scientific contributions. Still:
- Reproducible Research in BCI has a long way to go.
- While many BCI datasets are made freely available, researchers do not publish code, and
reproducing results required to benchmark new algorithms turns out to be trickier than
it should be.
- Performances can be significantly impacted by parameters of the preprocessing steps,
toolboxes used and implementation “tricks” that are almost never reported in the
literature.
As a result, there is no comprehensive benchmark of BCI algorithms, and newcomers are
spending a tremendous amount of time browsing literature to find out what algorithm works
best and on which dataset.
### The solution
The Mother of all BCI Benchmarks allows to:
- Build a comprehensive benchmark of popular BCI algorithms applied on an extensive list
of freely available EEG datasets.
- The code is available on GitHub, serving as a reference point for the future algorithmic
developments.
- Algorithms can be ranked and promoted on a website, providing a clear picture of the
different solutions available in the field.
This project will be successful when we read in an abstract “ … the proposed method
obtained a score of 89% on the MOABB (Mother of All BCI Benchmarks), outperforming the
state of the art by 5% ...”.
## Installation
### Pip installation
To use MOABB, you could simply do: \
`pip install MOABB` \
See [Troubleshooting](#Troubleshooting) section if you have a problem.
### Manual installation
You could fork or clone the repository and go to the downloaded directory, then run:
1. install `poetry` (only once per machine):\
`curl -sSL https://install.python-poetry.org | python3 -`\
or [checkout installation instruction](https://python-poetry.org/docs/#installation) or
use [conda forge version](https://anaconda.org/conda-forge/poetry)
1. (Optional, skip if not sure) Disable automatic environment creation:\
`poetry config virtualenvs.create false`
1. install all dependencies in one command (have to be run in the project directory):\
`poetry install`
See [contributors' guidelines](CONTRIBUTING.md) for detailed explanation.
### Requirements we use
See `pyproject.toml` file for full list of dependencies
## Running
### Verify Installation
To ensure it is running correctly, you can also run
```
python -m unittest moabb.tests
```
once it is installed.
### Use MOABB
First, you could take a look at our [tutorials](./tutorials) that cover the most important
concepts and use cases. Also, we have a several [examples](./examples/) available.
You might be interested in [MOABB documentation][link_moabb_docs]
### Moabb and docker
Moabb has a default image to run the benchmark. You have two options to download this
image: build from scratch or pull from the docker hub. **We recommend pulling from the
docker hub**.
If this were your first time using docker, you would need to **install the docker** and
**login** on docker hub. We recommend the
[official](https://docs.docker.com/desktop/install/linux-install/) docker documentation
for this step, it is essential to follow the instructions.
After installing docker, you can pull the image from the docker hub:
```bash
docker pull baristimunha/moabb
# rename the tag to moabb
docker tag baristimunha/moabb moabb
```
If you want to build the image from scratch, you can use the following command at the
root. You may have to login with the API key in the
[NGC Catalog](https://catalog.ngc.nvidia.com/) to run this command.
```bash
bash docker/create_docker.sh
```
With the image downloaded or rebuilt from scratch, you will have an image called `moabb`.
To run the default benchmark, still at the root of the project, and you can use the
following command:
```bash
mkdir dataset
mkdir results
mkdir output
bash docker/run_docker.sh PATH_TO_ROOT_FOLDER
```
An example of the command is:
```bash
cd /home/user/project/moabb
mkdir dataset
mkdir results
mkdir output
bash docker/run_docker.sh /home/user/project/moabb
```
Note: It is important to use an absolute path for the root folder to run, but you can
modify the run_docker.sh script to save in another path beyond the root of the project. By
default, the script will save the results in the project's root in the folder `results`,
the datasets in the folder `dataset` and the output in the folder `output`.
## Supported datasets
The list of supported datasets can be found here :
https://neurotechx.github.io/moabb/datasets.html
Detailed information regarding datasets (electrodes, trials, sessions) are indicated on
the wiki: https://github.com/NeuroTechX/moabb/wiki/Datasets-Support
### Submit a new dataset
you can submit a new dataset by mentioning it to this
[issue](https://github.com/NeuroTechX/moabb/issues/1). The datasets currently on our radar
can be seen [here](https://github.com/NeuroTechX/moabb/wiki/Datasets-Support).
## Who are we?
The founders of the Mother of all BCI Benchmarks are [Alexander Barachant][link_alex_b]
and [Vinay Jayaram][link_vinay]. This project is under the umbrella of
[NeuroTechX][link_neurotechx], the international community for NeuroTech enthusiasts. The
project is currently maintained by [Sylvain Chevallier][link_sylvain].
### What do we need?
**You**! In whatever way you can help.
We need expertise in programming, user experience, software sustainability, documentation
and technical writing and project management.
We'd love your feedback along the way.
Our primary goal is to build a comprehensive benchmark of popular BCI algorithms applied
on an extensive list of freely available EEG datasets, and we're excited to support the
professional development of any and all of our contributors. If you're looking to learn to
code, try out working collaboratively, or translate your skills to the digital domain,
we're here to help.
### Get involved
If you think you can help in any of the areas listed above (and we bet you can) or in any
of the many areas that we haven't yet thought of (and here we're _sure_ you can) then
please check out our [contributors' guidelines](CONTRIBUTING.md) and our
[roadmap](ROADMAP.md).
Please note that it's very important to us that we maintain a positive and supportive
environment for everyone who wants to participate. When you join us we ask that you follow
our [code of conduct](CODE_OF_CONDUCT.md) in all interactions both on and offline.
## Contact us
If you want to report a problem or suggest an enhancement, we'd love for you to
[open an issue](../../issues) at this GitHub repository because then we can get right on
it.
For a less formal discussion or exchanging ideas, you can also reach us on the [Gitter
channel][link_gitter] or join our weekly office hours! This an open video meeting
happening on a [regular basis](https://github.com/NeuroTechX/moabb/issues/191), please ask
the link on the gitter channel. We are also on [NeuroTechX Slack #moabb
channel][link_neurotechx_signup].
## Architecture and Main Concepts
<p align="center">
<img alt="banner" src="/images/architecture.png/" width="400">
</p>
There are 4 main concepts in the MOABB: the datasets, the paradigm, the evaluation, and the pipelines. In addition, we offer statistical and visualization utilities to simplify the workflow.
### Datasets
A dataset handles and abstracts low-level access to the data. The dataset will read data
stored locally, in the format in which they have been downloaded, and will convert them
into a MNE raw object. There are options to pool all the different recording sessions per
subject or to evaluate them separately.
### Paradigm
A paradigm defines how the raw data will be converted to trials ready to be processed by a
decoding algorithm. This is a function of the paradigm used, i.e. in motor imagery one can
have two-class, multi-class, or continuous paradigms; similarly, different preprocessing
is necessary for ERP vs ERD paradigms.
### Evaluations
An evaluation defines how we go from trials per subject and session to a generalization
statistic (AUC score, f-score, accuracy, etc) -- it can be either within-recording-session
accuracy, across-session within-subject accuracy, across-subject accuracy, or other
transfer learning settings.
### Pipelines
Pipeline defines all steps required by an algorithm to obtain predictions. Pipelines are
typically a chain of sklearn compatible transformers and end with a sklearn compatible
estimator. See
[Pipelines](http://scikit-learn.org/stable/modules/generated/sklearn.pipeline.Pipeline.html)
for more info.
### Statistics and visualization
Once an evaluation has been run, the raw results are returned as a DataFrame. This can be
further processed via the following commands to generate some basic visualization and
statistical comparisons:
```
from moabb.analysis import analyze
results = evaluation.process(pipeline_dict)
analyze(results)
```
## Citing MOABB and related publications
If you use MOABB in your experiments, please cite this library when
publishing a paper to increase the visibility of open science initiatives:
```
Aristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J., Narayanan, D., Bjareholt, E., Barthelemy, Q., Reinmar, K., Schirrmeister, R. T.,Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant,A., & Chevallier, S.
Mother of all BCI Benchmarks (MOABB), 2023. DOI: 10.5281/zenodo.10034223.
```
and here is the Bibtex version:
```bibtex
@software{Aristimunha_Mother_of_all,
author = {Aristimunha, Bruno and Carrara, Igor and Guetschel, Pierre and Sedlar, Sara and Rodrigues, Pedro and Sosulski, Jan and Narayanan, Divyesh and Bjareholt, Erik and Barthelemy, Quentin and Kobler, Reinmar and Schirrmeister, Robin Tibor and Kalunga, Emmanuel and Darmet, Ludovic and Gregoire, Cattan and Abdul Hussain, Ali and Gatti, Ramiro and Goncharenko, Vladislav and Thielen, Jordy and Moreau, Thomas and Roy, Yannick and Jayaram, Vinay and Barachant, Alexandre and Chevallier, Sylvain},
doi = {10.5281/zenodo.10034223},
title = {{Mother of all BCI Benchmarks}},
url = {https://github.com/NeuroTechX/moabb},
version = {1.1.0},
year = {2024}
}
```
If you want to cite the scientific contributions of MOABB, you could use the following paper:
> Sylvain Chevallier, Igor Carrara, Bruno Aristimunha, Pierre Guetschel, Sara Sedlar, Bruna Junqueira Lopes, Sébastien Velut, Salim Khazem, Thomas Moreau
> ["The largest EEG-based BCI reproducibility study for open science: the MOABB benchmark"](https://cnrs.hal.science/hal-04537061/)
> HAL: hal-04537061.
> Vinay Jayaram and Alexandre Barachant.
> ["MOABB: trustworthy algorithm benchmarking for BCIs."](http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta)
> Journal of neural engineering 15.6 (2018): 066011.
> [DOI](https://doi.org/10.1088/1741-2552/aadea0)
If you publish a paper using MOABB, please contact us on [gitter][link_gitter] or open an
issue, and we will add your paper to the
[dedicated wiki page](https://github.com/NeuroTechX/moabb/wiki/MOABB-bibliography).
## Thank You
Thank you so much (Danke schön! Merci beaucoup!) for visiting the project and we do hope
that you'll join us on this amazing journey to build a comprehensive benchmark of popular
BCI algorithms applied on an extensive list of freely available EEG datasets.
[link_alex_b]: http://alexandre.barachant.org/
[link_vinay]: https://ei.is.tuebingen.mpg.de/~vjayaram
[link_neurotechx]: http://neurotechx.com/
[link_sylvain]: https://sylvchev.github.io/
[link_neurotechx_signup]: https://neurotechx.com/
[link_gitter]: https://app.gitter.im/#/room/#moabb_dev_community:gitter.im
[link_moabb_docs]: https://neurotechx.github.io/moabb/
[link_arxiv]: https://arxiv.org/abs/1805.06427
[link_jne]: http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta
Raw data
{
"_id": null,
"home_page": "https://github.com/NeuroTechX/moabb",
"name": "moabb",
"maintainer": "Sylvain Chevallier",
"docs_url": null,
"requires_python": "<3.13,>=3.9",
"maintainer_email": "sylvain.chevallier@universite-paris-saclay.fr",
"keywords": "eeg, datasets, reproducibility, bci, benchmark",
"author": "Alexandre Barachant",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/08/14/950581a631b5816275e840c7e95db8cb841cbc732c792bad016aa08a6182/moabb-1.1.1.tar.gz",
"platform": null,
"description": "# Mother of all BCI Benchmarks\n\n<p align=center>\n <img alt=\"banner\" src=\"/images/M.png/\">\n</p>\n<p align=center>\n Build a comprehensive benchmark of popular Brain-Computer Interface (BCI) algorithms applied on an extensive list of freely available EEG datasets.\n</p>\n\n## Disclaimer\n\n**This is an open science project that may evolve depending on the need of the\ncommunity.**\n\n\n\n[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10034224.svg)](https://doi.org/10.5281/zenodo.10034224)\n[![Build Status](https://github.com/NeuroTechX/moabb/workflows/Test/badge.svg)](https://github.com/NeuroTechX/moabb/actions?query=branch%3Amaster)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![codecov](https://codecov.io/gh/NeuroTechX/moabb/graph/badge.svg?token=NwHD3ethB5)](https://codecov.io/gh/NeuroTechX/moabb)\n[![PyPI](https://img.shields.io/pypi/v/moabb?color=blue&style=plastic)](https://img.shields.io/pypi/v/moabb)\n[![Downloads](https://pepy.tech/badge/moabb)](https://pepy.tech/project/moabb)\n\n## Welcome!\n\nFirst and foremost, Welcome! :tada: Willkommen! :confetti_ball: Bienvenue!\n:balloon::balloon::balloon:\n\nThank you for visiting the Mother of all BCI Benchmark repository.\n\nThis document is a hub to give you some information about the project. Jump straight to\none of the sections below, or just scroll down to find out more.\n\n- [What are we doing? (And why?)](#what-are-we-doing)\n- [Installation](#installation)\n- [Running](#running)\n- [Supported datasets](#supported-datasets)\n- [Who are we?](#who-are-we)\n- [Get in touch](#contact-us)\n- [Documentation][link_moabb_docs]\n- [Architecture and main concepts](#architecture-and-main-concepts)\n- [Citing MOABB and related publications](#citing-moabb-and-related-publications)\n\n## What are we doing?\n\n### The problem\n\n[Brain-Computer Interfaces](https://en.wikipedia.org/wiki/Brain%E2%80%93computer_interface)\nallow to interact with a computer using brain signals. In this project, we focus mostly on\nelectroencephalographic signals\n([EEG](https://en.wikipedia.org/wiki/Electroencephalography)), that is a very active\nresearch domain, with worldwide scientific contributions. Still:\n\n- Reproducible Research in BCI has a long way to go.\n- While many BCI datasets are made freely available, researchers do not publish code, and\n reproducing results required to benchmark new algorithms turns out to be trickier than\n it should be.\n- Performances can be significantly impacted by parameters of the preprocessing steps,\n toolboxes used and implementation \u201ctricks\u201d that are almost never reported in the\n literature.\n\nAs a result, there is no comprehensive benchmark of BCI algorithms, and newcomers are\nspending a tremendous amount of time browsing literature to find out what algorithm works\nbest and on which dataset.\n\n### The solution\n\nThe Mother of all BCI Benchmarks allows to:\n\n- Build a comprehensive benchmark of popular BCI algorithms applied on an extensive list\n of freely available EEG datasets.\n- The code is available on GitHub, serving as a reference point for the future algorithmic\n developments.\n- Algorithms can be ranked and promoted on a website, providing a clear picture of the\n different solutions available in the field.\n\nThis project will be successful when we read in an abstract \u201c \u2026 the proposed method\nobtained a score of 89% on the MOABB (Mother of All BCI Benchmarks), outperforming the\nstate of the art by 5% ...\u201d.\n\n## Installation\n\n### Pip installation\n\nTo use MOABB, you could simply do: \\\n`pip install MOABB` \\\nSee [Troubleshooting](#Troubleshooting) section if you have a problem.\n\n### Manual installation\n\nYou could fork or clone the repository and go to the downloaded directory, then run:\n\n1. install `poetry` (only once per machine):\\\n `curl -sSL https://install.python-poetry.org | python3 -`\\\n or [checkout installation instruction](https://python-poetry.org/docs/#installation) or\n use [conda forge version](https://anaconda.org/conda-forge/poetry)\n1. (Optional, skip if not sure) Disable automatic environment creation:\\\n `poetry config virtualenvs.create false`\n1. install all dependencies in one command (have to be run in the project directory):\\\n `poetry install`\n\nSee [contributors' guidelines](CONTRIBUTING.md) for detailed explanation.\n\n### Requirements we use\n\nSee `pyproject.toml` file for full list of dependencies\n\n## Running\n\n### Verify Installation\n\nTo ensure it is running correctly, you can also run\n\n```\npython -m unittest moabb.tests\n```\n\nonce it is installed.\n\n### Use MOABB\n\nFirst, you could take a look at our [tutorials](./tutorials) that cover the most important\nconcepts and use cases. Also, we have a several [examples](./examples/) available.\n\nYou might be interested in [MOABB documentation][link_moabb_docs]\n\n### Moabb and docker\n\nMoabb has a default image to run the benchmark. You have two options to download this\nimage: build from scratch or pull from the docker hub. **We recommend pulling from the\ndocker hub**.\n\nIf this were your first time using docker, you would need to **install the docker** and\n**login** on docker hub. We recommend the\n[official](https://docs.docker.com/desktop/install/linux-install/) docker documentation\nfor this step, it is essential to follow the instructions.\n\nAfter installing docker, you can pull the image from the docker hub:\n\n```bash\ndocker pull baristimunha/moabb\n# rename the tag to moabb\ndocker tag baristimunha/moabb moabb\n```\n\nIf you want to build the image from scratch, you can use the following command at the\nroot. You may have to login with the API key in the\n[NGC Catalog](https://catalog.ngc.nvidia.com/) to run this command.\n\n```bash\nbash docker/create_docker.sh\n```\n\nWith the image downloaded or rebuilt from scratch, you will have an image called `moabb`.\nTo run the default benchmark, still at the root of the project, and you can use the\nfollowing command:\n\n```bash\nmkdir dataset\nmkdir results\nmkdir output\nbash docker/run_docker.sh PATH_TO_ROOT_FOLDER\n```\n\nAn example of the command is:\n\n```bash\ncd /home/user/project/moabb\nmkdir dataset\nmkdir results\nmkdir output\nbash docker/run_docker.sh /home/user/project/moabb\n```\n\nNote: It is important to use an absolute path for the root folder to run, but you can\nmodify the run_docker.sh script to save in another path beyond the root of the project. By\ndefault, the script will save the results in the project's root in the folder `results`,\nthe datasets in the folder `dataset` and the output in the folder `output`.\n\n## Supported datasets\n\nThe list of supported datasets can be found here :\nhttps://neurotechx.github.io/moabb/datasets.html\n\nDetailed information regarding datasets (electrodes, trials, sessions) are indicated on\nthe wiki: https://github.com/NeuroTechX/moabb/wiki/Datasets-Support\n\n### Submit a new dataset\n\nyou can submit a new dataset by mentioning it to this\n[issue](https://github.com/NeuroTechX/moabb/issues/1). The datasets currently on our radar\ncan be seen [here](https://github.com/NeuroTechX/moabb/wiki/Datasets-Support).\n\n## Who are we?\n\nThe founders of the Mother of all BCI Benchmarks are [Alexander Barachant][link_alex_b]\nand [Vinay Jayaram][link_vinay]. This project is under the umbrella of\n[NeuroTechX][link_neurotechx], the international community for NeuroTech enthusiasts. The\nproject is currently maintained by [Sylvain Chevallier][link_sylvain].\n\n### What do we need?\n\n**You**! In whatever way you can help.\n\nWe need expertise in programming, user experience, software sustainability, documentation\nand technical writing and project management.\n\nWe'd love your feedback along the way.\n\nOur primary goal is to build a comprehensive benchmark of popular BCI algorithms applied\non an extensive list of freely available EEG datasets, and we're excited to support the\nprofessional development of any and all of our contributors. If you're looking to learn to\ncode, try out working collaboratively, or translate your skills to the digital domain,\nwe're here to help.\n\n### Get involved\n\nIf you think you can help in any of the areas listed above (and we bet you can) or in any\nof the many areas that we haven't yet thought of (and here we're _sure_ you can) then\nplease check out our [contributors' guidelines](CONTRIBUTING.md) and our\n[roadmap](ROADMAP.md).\n\nPlease note that it's very important to us that we maintain a positive and supportive\nenvironment for everyone who wants to participate. When you join us we ask that you follow\nour [code of conduct](CODE_OF_CONDUCT.md) in all interactions both on and offline.\n\n## Contact us\n\nIf you want to report a problem or suggest an enhancement, we'd love for you to\n[open an issue](../../issues) at this GitHub repository because then we can get right on\nit.\n\nFor a less formal discussion or exchanging ideas, you can also reach us on the [Gitter\nchannel][link_gitter] or join our weekly office hours! This an open video meeting\nhappening on a [regular basis](https://github.com/NeuroTechX/moabb/issues/191), please ask\nthe link on the gitter channel. We are also on [NeuroTechX Slack #moabb\nchannel][link_neurotechx_signup].\n\n## Architecture and Main Concepts\n\n<p align=\"center\">\n <img alt=\"banner\" src=\"/images/architecture.png/\" width=\"400\">\n</p>\nThere are 4 main concepts in the MOABB: the datasets, the paradigm, the evaluation, and the pipelines. In addition, we offer statistical and visualization utilities to simplify the workflow.\n\n### Datasets\n\nA dataset handles and abstracts low-level access to the data. The dataset will read data\nstored locally, in the format in which they have been downloaded, and will convert them\ninto a MNE raw object. There are options to pool all the different recording sessions per\nsubject or to evaluate them separately.\n\n### Paradigm\n\nA paradigm defines how the raw data will be converted to trials ready to be processed by a\ndecoding algorithm. This is a function of the paradigm used, i.e. in motor imagery one can\nhave two-class, multi-class, or continuous paradigms; similarly, different preprocessing\nis necessary for ERP vs ERD paradigms.\n\n### Evaluations\n\nAn evaluation defines how we go from trials per subject and session to a generalization\nstatistic (AUC score, f-score, accuracy, etc) -- it can be either within-recording-session\naccuracy, across-session within-subject accuracy, across-subject accuracy, or other\ntransfer learning settings.\n\n### Pipelines\n\nPipeline defines all steps required by an algorithm to obtain predictions. Pipelines are\ntypically a chain of sklearn compatible transformers and end with a sklearn compatible\nestimator. See\n[Pipelines](http://scikit-learn.org/stable/modules/generated/sklearn.pipeline.Pipeline.html)\nfor more info.\n\n### Statistics and visualization\n\nOnce an evaluation has been run, the raw results are returned as a DataFrame. This can be\nfurther processed via the following commands to generate some basic visualization and\nstatistical comparisons:\n\n```\nfrom moabb.analysis import analyze\n\nresults = evaluation.process(pipeline_dict)\nanalyze(results)\n```\n\n## Citing MOABB and related publications\n\nIf you use MOABB in your experiments, please cite this library when\npublishing a paper to increase the visibility of open science initiatives:\n\n```\nAristimunha, B., Carrara, I., Guetschel, P., Sedlar, S., Rodrigues, P., Sosulski, J., Narayanan, D., Bjareholt, E., Barthelemy, Q., Reinmar, K., Schirrmeister, R. T.,Kalunga, E., Darmet, L., Gregoire, C., Abdul Hussain, A., Gatti, R., Goncharenko, V., Thielen, J., Moreau, T., Roy, Y., Jayaram, V., Barachant,A., & Chevallier, S.\nMother of all BCI Benchmarks (MOABB), 2023. DOI: 10.5281/zenodo.10034223.\n```\nand here is the Bibtex version:\n```bibtex\n@software{Aristimunha_Mother_of_all,\n author = {Aristimunha, Bruno and Carrara, Igor and Guetschel, Pierre and Sedlar, Sara and Rodrigues, Pedro and Sosulski, Jan and Narayanan, Divyesh and Bjareholt, Erik and Barthelemy, Quentin and Kobler, Reinmar and Schirrmeister, Robin Tibor and Kalunga, Emmanuel and Darmet, Ludovic and Gregoire, Cattan and Abdul Hussain, Ali and Gatti, Ramiro and Goncharenko, Vladislav and Thielen, Jordy and Moreau, Thomas and Roy, Yannick and Jayaram, Vinay and Barachant, Alexandre and Chevallier, Sylvain},\n doi = {10.5281/zenodo.10034223},\n title = {{Mother of all BCI Benchmarks}},\n url = {https://github.com/NeuroTechX/moabb},\n version = {1.1.0},\n year = {2024}\n }\n```\nIf you want to cite the scientific contributions of MOABB, you could use the following paper:\n\n> Sylvain Chevallier, Igor Carrara, Bruno Aristimunha, Pierre Guetschel, Sara Sedlar, Bruna Junqueira Lopes, S\u00e9bastien Velut, Salim Khazem, Thomas Moreau\n> [\"The largest EEG-based BCI reproducibility study for open science: the MOABB benchmark\"](https://cnrs.hal.science/hal-04537061/)\n> HAL: hal-04537061.\n\n> Vinay Jayaram and Alexandre Barachant.\n> [\"MOABB: trustworthy algorithm benchmarking for BCIs.\"](http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta)\n> Journal of neural engineering 15.6 (2018): 066011.\n> [DOI](https://doi.org/10.1088/1741-2552/aadea0)\n\nIf you publish a paper using MOABB, please contact us on [gitter][link_gitter] or open an\nissue, and we will add your paper to the\n[dedicated wiki page](https://github.com/NeuroTechX/moabb/wiki/MOABB-bibliography).\n\n## Thank You\n\nThank you so much (Danke sch\u00f6n! Merci beaucoup!) for visiting the project and we do hope\nthat you'll join us on this amazing journey to build a comprehensive benchmark of popular\nBCI algorithms applied on an extensive list of freely available EEG datasets.\n\n[link_alex_b]: http://alexandre.barachant.org/\n[link_vinay]: https://ei.is.tuebingen.mpg.de/~vjayaram\n[link_neurotechx]: http://neurotechx.com/\n[link_sylvain]: https://sylvchev.github.io/\n[link_neurotechx_signup]: https://neurotechx.com/\n[link_gitter]: https://app.gitter.im/#/room/#moabb_dev_community:gitter.im\n[link_moabb_docs]: https://neurotechx.github.io/moabb/\n[link_arxiv]: https://arxiv.org/abs/1805.06427\n[link_jne]: http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Mother of All BCI Benchmarks",
"version": "1.1.1",
"project_urls": {
"Documentation": "https://neurotechx.github.io/moabb",
"Homepage": "https://github.com/NeuroTechX/moabb",
"Repository": "https://github.com/NeuroTechX/moabb"
},
"split_keywords": [
"eeg",
" datasets",
" reproducibility",
" bci",
" benchmark"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e988bcfde0dc16632dafb22d1fd29c84ae6276790e9e066dea0c41f1148e95b1",
"md5": "39a69beda04efd56d0b73e1c93c131d4",
"sha256": "af0dab6c3597d85a4859335a83a085c881fb7eac6340d1fe7825ef7cfdc167a5"
},
"downloads": -1,
"filename": "moabb-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "39a69beda04efd56d0b73e1c93c131d4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.9",
"size": 269294,
"upload_time": "2024-09-18T11:27:46",
"upload_time_iso_8601": "2024-09-18T11:27:46.695653Z",
"url": "https://files.pythonhosted.org/packages/e9/88/bcfde0dc16632dafb22d1fd29c84ae6276790e9e066dea0c41f1148e95b1/moabb-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0814950581a631b5816275e840c7e95db8cb841cbc732c792bad016aa08a6182",
"md5": "ca6b26539aadb5b2a240543820581b92",
"sha256": "878f4d2a66ad982a1f7e63dcd6b4910147aa1a94a618a2615d5cf5efb7f44acd"
},
"downloads": -1,
"filename": "moabb-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "ca6b26539aadb5b2a240543820581b92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.9",
"size": 204110,
"upload_time": "2024-09-18T11:27:49",
"upload_time_iso_8601": "2024-09-18T11:27:49.627453Z",
"url": "https://files.pythonhosted.org/packages/08/14/950581a631b5816275e840c7e95db8cb841cbc732c792bad016aa08a6182/moabb-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-18 11:27:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "NeuroTechX",
"github_project": "moabb",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "moabb"
}