Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cbrnr/mnelab

MNELAB – a GUI for MNE
https://github.com/cbrnr/mnelab

eeg gui meg mne python

Last synced: about 1 month ago
JSON representation

MNELAB – a GUI for MNE

Host: GitHub
URL: https://github.com/cbrnr/mnelab
Owner: cbrnr
License: bsd-3-clause
Created: 2017-06-23T20:48:48.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2024-04-12T13:27:17.000Z (5 months ago)
Last Synced: 2024-04-12T16:51:59.148Z (5 months ago)
Topics: eeg, gui, meg, mne, python
Language: Python
Homepage:
Size: 6.09 MB
Stars: 222
Watchers: 12
Forks: 66
Open Issues: 38
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

my-awesome-starred - cbrnr/mnelab - MNELAB – a GUI for MNE (Python)

README

        ![Python](https://img.shields.io/pypi/pyversions/mnelab.svg?logo=python&logoColor=white)

[![PyPI](https://img.shields.io/pypi/v/mnelab)](https://pypi.org/project/mnelab/)

[![Docs](https://readthedocs.org/projects/mnelab/badge/?version=latest)](https://mnelab.readthedocs.io/)

[![DOI](https://joss.theoj.org/papers/10.21105/joss.04650/status.svg)](https://doi.org/10.21105/joss.04650)

[![License](https://img.shields.io/github/license/cbrnr/mnelab)](LICENSE)

## MNELAB

![](https://raw.githubusercontent.com/cbrnr/mnelab/main/mnelab/images/mnelab_logo.png)

MNELAB is a graphical user interface (GUI) for [MNE-Python](https://mne.tools/stable/index.html), a Python package for EEG/MEG analysis.

![](https://raw.githubusercontent.com/cbrnr/mnelab/main/mnelab.png)

### Documentation

Instructions for installing and using MNELAB as well as step-by-step examples for different use cases are available in the [documentation](https://mnelab.readthedocs.io/). Check out the [changelog](https://github.com/cbrnr/mnelab/blob/main/CHANGELOG.md) to learn what we added, changed, or fixed.

### Installation

You can install MNELAB with [pip](https://pip.pypa.io/en/stable/):

```

pip install mnelab

```

If you want to use all MNELAB features, the full package including optional dependencies can be installed with:

```

pip install "mnelab[full]"

```

You can also use [pipx](https://pypa.github.io/pipx/) to install MNELAB in a completely isolated environment:

```

pipx install mnelab

```

If you want the latest development version, use the following command:

```

pip install git+https://github.com/cbrnr/mnelab

```

### Running MNELAB

MNELAB must be started from a terminal with the following command:

```

mnelab

```

If you get an error, try the following alternative:

```

python -m mnelab

```

### Dependencies

MNELAB requires Python ≥ 3.9 and the following packages:

- [mne](https://mne.tools/stable/index.html) ≥ 1.7.0

- [PySide6](https://www.qt.io/qt-for-python) ≥ 6.7.1

- [edfio](https://edfio.readthedocs.io/en/stable/index.html) ≥ 0.4.2

- [matplotlib](https://matplotlib.org/) ≥ 3.8.0

- [numpy](http://www.numpy.org/) ≥ 1.25.0

- [scipy](https://scipy.org/) ≥ 1.10.0

- [pyxdf](https://github.com/xdf-modules/xdf-Python) ≥ 1.16.4

- [pyobjc-framework-Cocoa](https://pyobjc.readthedocs.io/en/latest/) ≥ 10.0 (macOS only)

- [pybv](https://pybv.readthedocs.io/en/stable/) ≥ 0.7.4 (BrainVision VHDR/VMRK/EEG export)

Optional dependencies provide additional features:

- [mne-qt-browser](https://github.com/mne-tools/mne-qt-browser) ≥ 0.6.2 (alternative raw plot backend)

- [python-picard](https://pierreablin.github.io/picard/) ≥ 0.7.0 (ICA computation with PICARD)

- [scikit-learn](https://scikit-learn.org/stable/) ≥ 1.3.0 (ICA computation with FastICA)

### Contributing

The [contributing guide](https://github.com/cbrnr/mnelab/blob/main/CONTRIBUTING.md) contains detailed instructions on how to contribute to MNELAB.