--- a +++ b/docs/install/install_pip.rst @@ -0,0 +1,29 @@ +.. _install_pip: + +Installing from PyPI +~~~~~~~~~~~~~~~~~~~~ + +Braincode can be installed via pip from `PyPI <https://pypi.org/project/braindecode>`__. + +.. note:: + We recommend the most updated version of pip to install from PyPI. + +Below are the installation commands for the most common use cases. + +.. code-block:: console + + pip install braindecode + +Braindecode can also be installed along MOABB to download open datasets: + +.. code-block:: bash + + pip install moabb + +To use the potential of the deep learning modules PyTorch with GPU, we recommend the following sequence before installing the braindecode: + +#. Install the latest NVIDIA driver. +#. Check `PyTorch Official Guide <https://pytorch.org/get-started/locally/>`__, for the recommended CUDA versions. For the Pip package, the user must download the CUDA manually, install it on the system, and ensure CUDA_PATH is appropriately set and working! +#. Continue to follow the guide and install PyTorch. + +See `Troubleshooting <braindecode.faq>`__ section if you have a problem.