bhargavaganti/mnelab

MNELAB - a 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:

• QtPy >= 1.9.0
• PyQt5 >= 5.10.0 or PySide2 >= 5.10.0
• numpy >= 1.14.0
• scipy >= 1.0.0
• matplotlib >= 2.1.0
• mne >= 0.21.0
• pyobjc-framework-Cocoa >= 5.2.0 (macOS only)
• python.app (only when using Anaconda or Miniconda Python on macOS)

Optional dependencies provide additional features if installed:

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

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

pip

1. Install either PyQt5 (python3 -m pip install PyQt5) or PySide2 (python3 -m pip install PySide2).
2. Install MNELAB (python3 -m pip install mnelab).

You can start MNELAB in a terminal with mnelab or python3 -m mnelab.

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 -n mnelab -c conda-forge mnelab

You can start MNELAB in a terminal with conda activate mnelab followed by mnelab or python -m mnelab. Any issues with this conda package should be reported to the respective issue tracker.

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. Install all dependencies listed above.
3. 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 detailed instructions on how to contribute to MNELAB.