gaborstefanics / mnelab

MNELAB - a graphical user interface (GUI) for MNE

Graphical user interface (GUI) for MNE, a Python-based toolbox for EEG/MEG analysis.

Changelog

Check out the changelog to learn what we added, changed or fixed in the latest version.

Dependencies

MNELAB requires Python >= 3.6. In addition, the following Python packages are required:

• PyQt5 >= 5.10.0
• numpy >= 1.14.0
• scipy >= 1.0.0
• matplotlib >= 2.0.0
• mne >= 0.19.0
• pyobjc-framework-Cocoa >= 5.2.0 (macOS only)

Optional dependencies provide additional features if installed:

• scikit-learn (ICA computation via FastICA)
• python-picard (ICA computation via PICARD)
• pyEDFlib (export to EDF/BDF)
• pyxdf (import XDF)
• pybv (export to BrainVision VHDR/VMRK/EEG)

In general, it is recommended to always use the latest package versions.

Additional features

MNELAB comes with the following features that are not (yet) available in MNE:

• Export to EDF/BDF (requires pyEDFlib)
• Export to EEGLAB SET
• Export to BrainVision VHDR/VMRK/EEG (requires pybv)
• Import XDF files (requires pyxdf)

Installation

Via pip

The latest release is available on PyPI and can be installed with:

pip install mnelab
mnelab

The mnelab command in the last line starts the application.

Via conda

An (unofficial, but regularly updated) conda package can be installed from conda-forge. We strongly suggest to install MNELAB into its own dedicated environment to ensure smooth installation and operation:

conda create -y --name mnelab -c conda-forge mnelab
conda activate mnelab
mnelab

The mnelab command in the last line starts the application. Any issues with this conda package should be reported to the respective issue tracker.

Alternatively, if for some reason you do not want to use conda-forge, you can first install all dependencies that are present in the default conda channel:

conda install pyqt numpy scipy matplotlib

Next, install the dependencies that are not in the default conda channel via pip:

pip install mne

Finally, install MNELAB as follows:

pip install --no-deps mnelab

Arch Linux

If you use Arch Linux, you can install the python-mnelab AUR package (note that this requires the python-mne AUR package).

Standalone installer

A stand-alone installer will be available soon.

Development version

Follow these steps to use the latest development version of MNELAB:

1. Download the source code and unpack it into a folder of your choice.
2. Open a terminal and change to the MNELAB source folder.
   • If you use Anaconda or Miniconda, install all dependencies with conda install numpy scipy matplotlib pyqt followed by pip install mne.
   • Otherwise, install all dependencies with pip install -r requirements.txt (and optionally pip install -r requirements-optional.txt).
3. Finally, run python3 -m mnelab to start MNELAB (if this does not work try python -m mnelab, just make sure to use Python 3 because Python 2 is not supported).

Contributing

The contributing guide contains details on how to contribute to MNELAB.