Merge branch 'develop' into filter_bank_classes

.github/workflows/docs.yml

@@ -16,7 +16,7 @@ jobs:
         python-version: ["3.9"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Create local data folder
         run: |
@@ -44,10 +44,10 @@ jobs:
 
       - name: Install dependencies
         if: steps.cached-dataset-docs.outputs.cache-hit != 'true'
-        run: poetry install --no-interaction --no-root --with docs,deeplearning
+        run: poetry install --no-interaction --no-root --with docs --extras deeplearning
 
       - name: Install library
-        run: poetry install --no-interaction --with docs,deeplearning
+        run: poetry install --no-interaction --with docs --extras deeplearning
 
       - name: Build docs
         run: |
@@ -69,7 +69,7 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Create local data folder
         run: |
@@ -85,7 +85,7 @@ jobs:
             docs/build
 
       - name: Checkout moabb.github.io
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: "NeuroTechX/moabb.github.io"
           path: moabb-ghio
@@ -101,7 +101,7 @@ jobs:
         os: [ubuntu-latest]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Create local data folder
         run: |
@@ -117,7 +117,7 @@ jobs:
             docs/build
 
       - name: Checkout gh pages
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           ref: gh-pages
           path: moabb-ghpages

.github/workflows/test-braindecode.yml

@@ -68,9 +68,8 @@ jobs:
       - name: Install and test braindecode
         run: |
           source $VENV
-          poetry run pip install torch
           cd braindecode
-          poetry run pip install -e .[tests]
-          poetry run pytest test/
+          pip install -e .[tests]
+          pytest test/
 
       # poetry run pip install -U https://api.github.com/repos/braindecode/braindecode/zipball/master

.github/workflows/test-devel.yml

@@ -19,7 +19,7 @@ jobs:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4
@@ -46,11 +46,11 @@ jobs:
         if: |
           (runner.os != 'Windows') &&
           (steps.cached-poetry-dependencies.outputs.cache-hit != 'true')
-        run: poetry install --no-interaction --no-root --with deeplearning
+        run: poetry install --no-interaction --no-root --extras deeplearning
 
       - name: Install library (Linux/OSX)
         if: ${{ runner.os != 'Windows' }}
-        run: poetry install --no-interaction --with deeplearning
+        run: poetry install --no-interaction --extras deeplearning
 
       - name: Install library (Windows)
         if: ${{ runner.os == 'Windows' }}

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       run:
         shell: bash
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Python
         uses: actions/setup-python@v4
@@ -46,11 +46,11 @@ jobs:
         if: |
           (runner.os != 'Windows') &&
           (steps.cached-poetry-dependencies.outputs.cache-hit != 'true')
-        run: poetry install --no-interaction --no-root --with deeplearning
+        run: poetry install --no-interaction --no-root --extras deeplearning
 
       - name: Install library (Linux/OSX)
         if: ${{ runner.os != 'Windows' }}
-        run: poetry install --no-interaction --with deeplearning
+        run: poetry install --no-interaction --extras deeplearning
 
       - name: Install library (Windows)
         if: ${{ runner.os == 'Windows' }}

.github/workflows/whats-new.yml

@@ -0,0 +1,38 @@
+name: Check What's new update
+
+on:
+  push:
+    branches: [develop]
+  pull_request:
+    branches: [develop]
+
+jobs:
+  check-whats-news:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check for file changes in PR
+        run: |
+          pr_number=${{ github.event.pull_request.number }}
+          response=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+            "https://api.github.com/repos/${{ github.repository }}/pulls/${pr_number}/files")
+
+          file_changed=false
+          file_to_check="docs/source/whats_new.rst" # Specify the path to your file
+
+          for file in $(echo "${response}" | jq -r '.[] | .filename'); do
+            if [ "$file" == "$file_to_check" ]; then
+              file_changed=true
+              break
+            fi
+          done
+
+          if $file_changed; then
+            echo "File ${file_to_check} has been changed in the PR."
+          else
+            echo "File ${file_to_check} has not been changed in the PR."
+            echo "::error::File ${file_to_check} has not been changed in the PR."
+            exit 1
+          fi
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token

.pre-commit-config.yaml

@@ -15,7 +15,7 @@ exclude: ".*svg"
 
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
       - id: check-yaml
       - id: check-json
@@ -35,7 +35,7 @@ repos:
 
 
   - repo: https://github.com/psf/black
-    rev: 23.9.1
+    rev: 24.3.0
     hooks:
       - id: black
         language_version: python3.8
@@ -49,12 +49,12 @@ repos:
           exclude: ^.github/
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 5.13.2
     hooks:
       - id: isort
 
   - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
+    rev: 7.0.0
     hooks:
       - id: flake8
         additional_dependencies: [
@@ -69,7 +69,7 @@ repos:
         exclude: ^docs/ | ^setup\.py$ |
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.0.292
+    rev: v0.3.5
     hooks:
       - id: ruff
         args: [ --fix, --exit-non-zero-on-fix, --ignore, E501 ]
@@ -86,7 +86,7 @@ repos:
         exclude: ^tests/|generated/
 
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.32.0
+    rev: v1.35.1
     hooks:
       - id: yamllint
         exclude: >

CITATION.cff

@@ -68,6 +68,6 @@ authors:
   orcid: "https://orcid.org/0000-0003-3027-8241"
 title: "Mother of all BCI Benchmarks"
 version: 1.0.0
-doi: 10.5281/zenodo.XXXXX
+doi: 10.5281/zenodo.10034223
 date-released: 2023-10-12
 url: "https://github.com/NeuroTechX/moabb"

README.md

@@ -12,8 +12,12 @@
 **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)
 
@@ -289,7 +293,24 @@ analyze(results)
 
 ## Citing MOABB and related publications
 
-To cite MOABB, you could use the following paper:
+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., Quentin, B., 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:
+
+> @software{Aristimunha_Mother_of_all_2023,
+> 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 Quentin, Barthelemy 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.0.0},
+> year = {2023}
+> }
+
+If you want to cite the scientific contributions of MOABB, you could use the following paper:
 
 > Vinay Jayaram and Alexandre Barachant.
 > ["MOABB: trustworthy algorithm benchmarking for BCIs."](http://iopscience.iop.org/article/10.1088/1741-2552/aadea0/meta)

bash/meta_requirements.txt

@@ -1,5 +1,5 @@
 mne
-#if you want used a specific branch instead of branch devolop
+#if you want used a specific branch instead of branch develop
 #changing the branch name git+REPOSITORY_LINK@BRANCH#egg=MOABB
 git+https://github.com/NeuroTechX/moabb#egg=moabb
 gdown

docs/source/README.md

@@ -12,8 +12,10 @@
 **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)
 

docs/source/cite.rst

@@ -1,8 +1,26 @@
 Citing MOABB and related publications
 ============================================
 
-To cite MOABB, you could use the following paper, *specifying the version*:
+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., Quentin, B., 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:
+
+.. code-block:: bibtex
+
+   @software{Aristimunha_Mother_of_all_2023,
+     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 Quentin, Barthelemy 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.0.0},
+     year = {2023}
+   }
+
+If you want to cite the scientific contributions of MOABB, you could use the following paper:
 
 -  Vinay Jayaram and Alexandre Barachant. MOABB: trustworthy algorithm
    benchmarking for BCIs. Journal of neural engineering 15.6 (2018):

docs/source/dataset_summary.rst

@@ -61,7 +61,7 @@ P300/ERP
    :class:`Cattan2019_VR`, 21, 16, 600 NT / 120 T, 1s, 512Hz, 2
    :class:`Huebner2017`, 13, 31, 364 NT / 112 T, 0.9s, 1000Hz, 3
    :class:`Huebner2018`, 12, 31, 364 NT / 112 T, 0.9s, 1000Hz, 3
-   :class:`Sosulski2019`, 13, 31, 75 NT / 15 T, 1.2s, 1000Hz, 3
+   :class:`Sosulski2019`, 13, 31, 7500 NT / 1500 T, 1.2s, 1000Hz, 1
    :class:`EPFLP300`, 8, 32, 2753 NT / 551 T, 1s, 2048Hz, 4
    :class:`Lee2019_ERP`, 54, 62, 6900 NT / 1380 T, 1s, 1000Hz, 2
 
@@ -74,15 +74,14 @@ SSVEP
    :header: Dataset, #Subj, #Chan, #Classes, #Trials / class, Trials length, Sampling rate, #Sessions
    :class: sortable
 
-   :class:`Lee2019_SSVEP`,54,16,4,25,1s,1000Hz,1
+   :class:`Lee2019_SSVEP`,54,62,4,50,4s,1000Hz,2
    :class:`Kalunga2016`,12,8,4,16,2s,256Hz,1
    :class:`MAMEM1`,10,256,5,12-15,3s,250Hz,1
    :class:`MAMEM2`,10,256,5,20-30,3s,250Hz,1
    :class:`MAMEM3`,10,14,4,20-30,3s,128Hz,1
    :class:`Nakanishi2015`,9,8,12,15,4.15s,256Hz,1
    :class:`Wang2016`,34,62,40,6,5s,250Hz,1
 
-
 c-VEP
 ======================
 
@@ -97,10 +96,15 @@ potentials (c-VEP): A literature review. Journal of Neural Engineering, 18(6), 0
 DOI: https://doi.org/10.1088/1741-2552/ac38cf
 
 .. csv-table::
-   :header: Dataset, #Subj, #Chan, #Classes, #Trials / class, Trials length, #Epochs / class, Sampling rate, #Sessions, Codes, Presentation rate
+   :header: Dataset, #Subj, #Sessions, Sampling rate, #Chan, Trials length, #Trial classes, #Trials / class, #Epochs classes, #Epochs / class, Codes, Presentation rate
    :class: sortable
 
-   :class:`Thielen2021`,30,8,20,5,31.5s,18900 NT / 18900 T,512Hz,1,Gold codes,60Hz
+   :class:`Thielen2015`,12,1,2048Hz,64,4.2s,36,3,2,27216 NT / 27216 T,Gold codes,120Hz
+   :class:`Thielen2021`,30,1,512Hz,8,31.5s,20,5,2,18900 NT / 18900 T,Gold codes,60Hz
+   :class:`CastillosCVEP100`,    12,1,500Hz,32,2.2s,4,15/15/15/15,2,3525 NT / 3495 T,Burst-CVEP,60Hz
+   :class:`CastillosCVEP40`,     12,1,500Hz,32,2.2s,4,15/15/15/15,2,3525 NT / 3495 T,Burst-CVEP,60Hz
+   :class:`CastillosBurstVEP40`, 12,1,500Hz,32,2.2s,4,15/15/15/15,2,5820 NT / 1200 T,Burst-CVEP,60Hz
+   :class:`CastillosBurstVEP100`,12,1,500Hz,32,2.2s,4,15/15/15/15,2,5820 NT / 1200 T,Burst-CVEP,60Hz
 
 
 Resting States

docs/source/datasets.rst

@@ -75,6 +75,7 @@ SSVEP Datasets
     Lee2019_SSVEP
 
 
+
 --------------
 c-VEP Datasets
 --------------
@@ -83,8 +84,12 @@ c-VEP Datasets
     :toctree: generated/
     :template: class.rst
 
+    Thielen2015
     Thielen2021
-
+    CastillosBurstVEP40
+    CastillosBurstVEP100
+    CastillosCVEP40
+    CastillosCVEP100
 
 ----------------------
 Resting State Datasets

docs/source/install/install_pip.rst

@@ -5,6 +5,9 @@ Installing from PyPI
 
 MOABB can be installed via pip from `PyPI <https://pypi.org/project/moabb>`__.
 
+.. warning::
+    MOABB is only compatible with **Python 3.8, 3.9, 3.10 and 3.11**.
+
 .. note::
     We recommend the most updated version of pip to install from PyPI.