Installation¶
Dependencies¶
Required:
mne(>=0.24)numpy(>=1.16.0)scipy(>=1.2.0, or >=1.5.0 for certain operations with EEGLAB data)setuptools(>=46.4.0)
Optional:
nibabel(>=2.5, for processing MRI data)pybv(>=0.6, for writing BrainVision data)matplotlib(>=3.1.0, for using the interactive data inspector)pandas(>=0.24.0, for generating event statistics)EDFlib-Python(>=1.0.2, for writing EDF data)
We recommend the Anaconda Python distribution.
We require that you use Python 3.7 or higher.
You may choose to install mne-bids
via pip or
via conda.
Installation via pip¶
To install MNE-BIDS including all dependencies required to use all features, simply run:
pip install --user -U mne-bids[full]
This pip command will also work if you want to upgrade if a newer version
of mne-bids is available.
If you don’t require advanced features like interactive visual data inspection,
you may also install a basic version of mne-bids via
pip install --user -U mne-bids
If you want to install a snapshot of the current development version, run:
pip install --user -U https://api.github.com/repos/mne-tools/mne-bids/zipball/main
To check if everything worked fine, the following command should print a version number and not give any error messages:
python -c 'import mne_bids; print(mne_bids.__version__)'
MNE-BIDS works best with the latest stable release of MNE-Python (the mne package).
To ensure MNE-Python is up-to-date, run:
pip install --user -U mne
Installation via conda¶
If you have followed the
MNE-Python installation instructions,
all that’s left to do is to install mne-bids without its dependencies, as
they’ve already been installed during the MNE-Python installation process.
Activate the correct conda environment and install mne-bids:
conda activate mne
conda install --channel conda-forge --no-deps mne-bids
This approach ensures that the installation of mne-bids doesn’t alter any
other packages in your existing conda environment.
Alternatively, you may wish to take advantage of the fact that the
mne-bids package on conda-forge in fact depends on mne,
meaning that a “full” installation of mne-bids (i.e., including its
dependencies) will provide you with a working copy of of both mne and
mne-bids at once:
conda create --name mne --channel conda-forge mne-bids
After activating the environment, you should be ready to use mne-bids:
conda activate mne
python -c 'import mne_bids; print(mne_bids.__version__)'