NeuroTechX · bruAristimunha · Mar 7, 2025 · Feb 12, 2025 · Feb 12, 2025 · Feb 12, 2025
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -21,7 +21,8 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-latest ]
-        python-version: [ "3.9" ]
+        python-version: [ "3.10" ]
+        # the doc can only be generated by python 3.10 or above
 
     steps:
       - uses: actions/checkout@v4

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -56,15 +56,6 @@ pull request to the master branch referencing the specific issue you addressed.
 
 ## Setup development environment
 
-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. (Optional) Install the optional dependency
-1. install all dependencies in one command (have to be run in thibe project directory):\
-   `poetry install`
 1. install `pre-commit` hooks to git repo:\
    `pre-commit install`
 1. you are ready to code!
@@ -73,42 +64,13 @@ _Note 1:_\
 Your first commit will trigger `pre-commit` to download [Code Quality tools](#tools-used).
 That's OK and it is intended behavior. This will be done once per machine automatically.
 
-_Note 2:_\
-By default `poetry` creates separate Python virtual environment for every project ([more details in documentation](https://python-poetry.org/docs/managing-environments/)).
-If you use `conda` or any other way to manage different environments by hand - you need to
-disable `poetry` environment creation. Also in this case be careful with version of Python
-in your environment - it has to satisfy requirements stated in `pyproject.toml`. In case you
-disable `poetry` you are in charge of this.
-
-_Note 3 (deep learning):_\
-In case you want to install the optional deep learning dependencies (i.e. `poetry install --with deeplearning`),
-you will need to do the following additional steps if you want `tensorflow` to detect your
-GPU:
-
-```bash
-# Instructions for tensorflow==2.12
-conda install -c conda-forge cudatoolkit=11.8.0
-mkdir -p $CONDA_PREFIX/etc/conda/activate.d
-echo 'CUDNN_PATH=$(dirname $(python -c "import nvidia.cudnn;print(nvidia.cudnn.__file__)"))' >> $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
-echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CONDA_PREFIX/lib/:$CUDNN_PATH/lib' >> $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
-source $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
-# Verify install:
-python3 -c "import tensorflow as tf; print(tf.config.list_physical_devices('GPU'))"
-```
+_Note 2 (deep learning):_\
+In case you want to install the optional deep learning dependencies (i.e. `pip install .[deeplearning]`),
 
-Then, at every use, re-run the command
-`source $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh` (you can simply add this line to
-your `.bashrc`). For more details, please refer to
-[the official documentation](https://www.tensorflow.org/install/pip).
 
 ### Tools used
 
-MOABB uses [`poetry`](https://python-poetry.org/) for dependency management. This tool
-enables one to have a reproducible environment on all popular OS (Linux, MacOS and
-Windows) and provides easy publishing pipeline.
-
-Another tool that makes development more stable is
-[`pre-commit`](https://pre-commit.com/). It automatically runs variety of Code Quality
+MOABB uses [`pre-commit`](https://pre-commit.com/). It automatically runs variety of Code Quality
 instruments against the code you produced.
 
 For Code Quality verification, we use:
@@ -117,6 +79,8 @@ For Code Quality verification, we use:
 - [`isort`](https://github.com/timothycrosley/isort) - imports sorting and grouping
 - [`flake8`](https://gitlab.com/pycqa/flake8) - code style checking
 - [`prettier`](https://github.com/prettier/prettier) - `.yml` and `.md` files formatting
+- and more checkers.
+
 
 ### Generate the documentation
 

diff --git a/Dockerfile b/Dockerfile
diff --git a/README.md b/README.md
@@ -12,7 +12,7 @@
 **This is an open science project that may evolve depending on the need of the
 community.**
 
-
+** If you use moabb, remember to [cite](https://neurotechx.github.io/moabb/#citing-moabb-and-related-publications)! **
 
 [![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)
@@ -83,28 +83,18 @@ state of the art by 5% ...”.
 ### Pip installation
 
 To use MOABB, you could simply do: \
-`pip install MOABB` \
+`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:
+You could clone the repository and go to the downloaded directory with `pip`, 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`
+1. `git clone https://github.com/neurotechx/moabb.git && cd moabb`
+2. `pip install -e .`
 
 See [contributors' guidelines](CONTRIBUTING.md) for detailed explanation.
 
-### Requirements we use
-
-See `pyproject.toml` file for full list of dependencies
-
 ## Running
 
 ### Verify Installation
@@ -124,58 +114,6 @@ concepts and use cases. Also, we have a several [examples](./examples/) availabl
 
 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
 
@@ -196,7 +134,7 @@ can be seen [here](https://github.com/NeuroTechX/moabb/wiki/Datasets-Support).
 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].
+project is currently maintained by [Sylvain Chevallier][link_sylvain] and [Bruno Aristimunha][link_bruno].
 
 ### What do we need?
 
@@ -335,3 +273,4 @@ BCI algorithms applied on an extensive list of freely available EEG datasets.
 [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
+[link_bruno]: https://www.linkedin.com/in/bruaristimunha/
diff --git a/docs/source/CONTRIBUTING.md b/docs/source/CONTRIBUTING.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -67,7 +67,7 @@
     "sphinx_design",
     "sphinx_gallery.gen_gallery",
     "gh_substitutions",
-    "m2r2",
+    "myst_parser",
     "numpydoc",
     "sphinx_favicon",
     "sphinxcontrib.jquery",

diff --git a/docs/source/install/install_source.rst b/docs/source/install/install_source.rst
@@ -47,45 +47,23 @@ Building MOABB from source with the development environment
 
 If you want to build from source to work on MOABB itself, then follow these steps:
 
-1. Install poetry by running the following command (only needs to be done once per machine):
-
-.. code-block:: bash
-
-   curl -sSL https://install.python-poetry.org | python3 -
-
-You could also check checkout `poetry installation instruction <https://python-poetry.org/docs/#installation>`__ or
-use `conda forge version <https://anaconda.org/conda-forge/poetry>`__
-
-We need the most updated version of the poetry to ensure the compatibility with optional dependency.
-
-.. note::
-    If you have any group-related errors at the end of this section, you may not run the proper version of poetry.
-
-
-2. (Optional) We recommend disabling automatic environment creation:
+1. You will need to clone the repository from GitHub and install the dependencies.
 
 .. code-block:: console
 
-   poetry config virtualenvs.create false
-
-
-.. note::
-    This step is optional. Skip if you are not sure.
-3. If you want to install without any optional dependency
+   git clone https://github.com/neurotechx/moabb && cd moabb
 
-You will need to run this command in the project directory:
+2. You will need to run this command in the project directory:
 
 .. code-block:: console
 
-   poetry install
-
-4. If you want to install with an optional dependency
+   pip install -e .
 
-You will need to run this command in the project directory:
+3. If you want to install with an optional dependency
 
 .. code-block:: console
 
-   poetry install --extras "deeplearning carbonemission docs"
+   pip install -e .[deeplearning,carbonemission,docs,tests]
 
 For a full list of dependencies, see the pyproject.toml file.