| .. meta:: |
| :description: Install MOABB via pip or from source. Supports Python 3.10+ with optional dependencies for deep learning (braindecode), carbon tracking, and interactive visualization. |
| :keywords: install MOABB, pip install moabb, BCI Python package, EEG benchmark installation |
|
|
| .. _installation: |
|
|
| ================ |
| Installation |
| ================ |
|
|
| MOABB is written in Python 3, specifically for version 3.8 or above. |
|
|
| The package is distributed via Python package index (`PyPI <https://pypi.org/project/moabb>`__), and you can access the |
| source code via `Github <https://github.com/NeuroTechX/moabb>`__ repository. |
|
|
| There are different ways to install MOABB: |
|
|
|
|
| .. grid:: 2 |
|
|
| .. grid-item-card:: |
| :text-align: center |
|
|
| .. rst-class:: font-weight-bold mb-0 |
|
|
| Install via ``pip`` |
|
|
| .. rst-class:: card-subtitle text-muted mt-0 |
|
|
| For Beginners |
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| .. image:: ../../source/_static/moabb_install.png |
| :alt: MOABB Installer with pip |
|
|
| **New to Python?** Use our standalone installers that include |
| everything to get you started! |
| +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
|
|
|
|
| .. button-ref:: install_pip |
| :ref-type: ref |
| :color: primary |
| :shadow: |
| :class: font-weight-bold |
|
|
| Installing from PyPI |
|
|
|
|
| .. grid-item-card:: |
| :text-align: center |
|
|
| .. rst-class:: font-weight-bold mb-0 |
|
|
| Building from src and the dev env |
|
|
| .. rst-class:: card-subtitle text-muted mt-0 |
|
|
| For Advanced Users |
|
|
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| .. image:: https://mne.tools/stable/_images/mne_installer_console.png |
| :alt: Terminal Window |
|
|
| **Already familiar with Python?** |
| Follow our setup instructions for building from Github and start to contribute! |
| +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
|
|
| .. button-ref:: install_source |
| :ref-type: ref |
| :color: primary |
| :shadow: |
| :class: font-weight-bold |
|
|
| From src and dev env |
|
|
|
|
|
|
| .. toctree:: |
| :hidden: |
|
|
| install_pip |
| install_source |
|
|
