Skip to content

Commit 631a078

Browse files
bruAristimunhaPierreGtchpre-commit-ci[bot]
authored
V1.2.0 (#708)
* [MNT] update to release * [MNT] update to release * [MNT] single readme file * [MNT] typo * Apply suggestions from code review Co-authored-by: Pierre Guetschel <[email protected]> Signed-off-by: Bru <[email protected]> * [MNT] version control * Single readme and contributing webpage * [pre-commit.ci] auto fixes from pre-commit.com hooks * removing docker, no one is using. * removing docker, no one is using. * removing poetry * external example --------- Signed-off-by: Bru <[email protected]> Signed-off-by: Bru <[email protected]> Co-authored-by: Pierre Guetschel <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 75b78ef commit 631a078

21 files changed

+184
-975
lines changed

.dockerignore

Lines changed: 0 additions & 146 deletions
This file was deleted.

.github/workflows/docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ jobs:
5555

5656
- name: Install moabb
5757
run: |
58-
uv pip install -e .[docs,deeplearning,optuna]
58+
uv pip install -e .[docs,deeplearning,optuna,external]
5959
6060
- name: Build docs
6161
run: |

CITATION.cff

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ authors:
7070
given-names: "Sylvain"
7171
orcid: "https://orcid.org/0000-0003-3027-8241"
7272
title: "Mother of all BCI Benchmarks"
73-
version: 1.1.1
73+
version: 1.2.0
7474
doi: 10.5281/zenodo.10034223
75-
date-released: 2024-09-16
75+
date-released: 2025-03-05
7676
url: "https://github.com/NeuroTechX/moabb"

CONTRIBUTING.md

Lines changed: 25 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,16 @@
33
:tada::clinking_glasses: First off, thanks for taking the time to contribute!
44
:tada::clinking_glasses:
55

6-
Contributions are always welcome, no matter how small.
6+
Contributions are always welcome, no matter how small!
7+
8+
If you think you can help in any of the areas of MOABB (and we bet you can) or in any of
9+
the many areas that we haven't yet thought of (and here we're _sure_ you can) then please
10+
check out our [roadmap](https://github.com/NeuroTechX/moabb/blob/master/ROADMAP.md).
11+
12+
Please note that it's very important to us that we maintain a positive and supportive
13+
environment for everyone who wants to participate. When you join us we ask that you follow
14+
our [code of conduct](https://github.com/NeuroTechX/moabb/blob/master/CODE_OF_CONDUCT.md)
15+
in all interactions both on and offline.
716

817
The following is a small set of guidelines for how to contribute to the project
918

@@ -13,7 +22,7 @@ The following is a small set of guidelines for how to contribute to the project
1322

1423
This project adheres to the Contributor Covenant [Code of Conduct](CODE_OF_CONDUCT.md). By
1524
participating you are expected to adhere to these expectations. Please report unacceptable
16-
25+
behavior.
1726

1827
### Contributing on Github
1928

@@ -23,15 +32,13 @@ include those additions in the master version of this project, check out this
2332

2433
### Community
2534

26-
This project is maintained by the [NeuroTechX](www.neurotechx.com) community. Join the
27-
[Gitter](https://gitter.im/moabb_dev/community), where discussions about MOABB takes
28-
place.
35+
This project is maintained by the [NeuroTechX](www.neurotechx.com) community.
2936

3037
## How can I contribute?
3138

3239
If there's a feature you'd be interested in building or you find a bug or have a
3340
suggestion on how to improve the project, go ahead! Let us know on the
34-
[Gitter](https://gitter.im/moabb_dev/community) or [open an issue](../../issues) so others
41+
[open an issue](../../issues) so others
3542
can follow along and we'll support you as much as we can. When you're finished submit a
3643
pull request to the master branch referencing the specific issue you addressed.
3744

@@ -54,61 +61,28 @@ pull request to the master branch referencing the specific issue you addressed.
5461
[what's new](http://moabb.neurotechx.com/docs/whats_new.html) and
5562
[documentation](http://moabb.neurotechx.com/docs/index.html) pages if needed
5663

64+
5765
## Setup development environment
5866

59-
1. install `poetry` (only once per machine):\
60-
`curl -sSL https://install.python-poetry.org | python3 -`\
61-
or [checkout installation instruction](https://python-poetry.org/docs/#installation) or
62-
use [conda forge version](https://anaconda.org/conda-forge/poetry)
63-
1. (Optional, skip if not sure) Disable automatic environment creation:\
64-
`poetry config virtualenvs.create false`
65-
1. (Optional) Install the optional dependency
66-
1. install all dependencies in one command (have to be run in thibe project directory):\
67-
`poetry install`
68-
1. install `pre-commit` hooks to git repo:\
67+
1. Install pre-commit to start to code:\
68+
`pip install pre-commit`
69+
2. Install the pre-commit hooks:\
6970
`pre-commit install`
70-
1. you are ready to code!
71+
3. you are ready to code!
7172

7273
_Note 1:_\
7374
Your first commit will trigger `pre-commit` to download [Code Quality tools](#tools-used).
7475
That's OK and it is intended behavior. This will be done once per machine automatically.
7576

76-
_Note 2:_\
77-
By default `poetry` creates separate Python virtual environment for every project ([more details in documentation](https://python-poetry.org/docs/managing-environments/)).
78-
If you use `conda` or any other way to manage different environments by hand - you need to
79-
disable `poetry` environment creation. Also in this case be careful with version of Python
80-
in your environment - it has to satisfy requirements stated in `pyproject.toml`. In case you
81-
disable `poetry` you are in charge of this.
77+
_Note 2 (deep learning):_\
78+
In case you want to install the optional deep learning dependencies (i.e. `pip install .[deeplearning]`),
8279

83-
_Note 3 (deep learning):_\
84-
In case you want to install the optional deep learning dependencies (i.e. `poetry install --with deeplearning`),
85-
you will need to do the following additional steps if you want `tensorflow` to detect your
86-
GPU:
87-
88-
```bash
89-
# Instructions for tensorflow==2.12
90-
conda install -c conda-forge cudatoolkit=11.8.0
91-
mkdir -p $CONDA_PREFIX/etc/conda/activate.d
92-
echo 'CUDNN_PATH=$(dirname $(python -c "import nvidia.cudnn;print(nvidia.cudnn.__file__)"))' >> $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
93-
echo 'export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CONDA_PREFIX/lib/:$CUDNN_PATH/lib' >> $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
94-
source $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh
95-
# Verify install:
96-
python3 -c "import tensorflow as tf; print(tf.config.list_physical_devices('GPU'))"
97-
```
98-
99-
Then, at every use, re-run the command
100-
`source $CONDA_PREFIX/etc/conda/activate.d/env_vars.sh` (you can simply add this line to
101-
your `.bashrc`). For more details, please refer to
102-
[the official documentation](https://www.tensorflow.org/install/pip).
10380

10481
### Tools used
10582

106-
MOABB uses [`poetry`](https://python-poetry.org/) for dependency management. This tool
107-
enables one to have a reproducible environment on all popular OS (Linux, MacOS and
108-
Windows) and provides easy publishing pipeline.
83+
### Tools used
10984

110-
Another tool that makes development more stable is
111-
[`pre-commit`](https://pre-commit.com/). It automatically runs variety of Code Quality
85+
MOABB uses [`pre-commit`](https://pre-commit.com/). It automatically runs variety of Code Quality
11286
instruments against the code you produced.
11387

11488
For Code Quality verification, we use:
@@ -117,12 +91,14 @@ For Code Quality verification, we use:
11791
- [`isort`](https://github.com/timothycrosley/isort) - imports sorting and grouping
11892
- [`flake8`](https://gitlab.com/pycqa/flake8) - code style checking
11993
- [`prettier`](https://github.com/prettier/prettier) - `.yml` and `.md` files formatting
94+
- and more checkers.
95+
12096

12197
### Generate the documentation
12298

12399
To generate a local version of the documentation:
124100

125-
```
101+
```bash
126102
cd docs
127103
make html
128104
```

Dockerfile

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)