mne-qt-browser

A new backend based on pyqtgraph for the 2D-Data-Browser in MNE-Python.

This repository hosts the code for an alternative backend for plotting 2D-Data with MNE-Python.

The backend is based on pyqtgraph which uses Qt's Graphics View Framework for the plotting. Development started as a 2021's Google Summer of Code Project. Currently, only Raw.plot() is supported. For the future support for Epochs and ICA-Sources is planned.

Installation

Install full MNE-Python with the instructions provided here or install minimal MNE-Python with

pip

pip install mne matplotlib mne-qt-browser

conda

conda install -c conda-forge mne-base matplotlib mne-qt-browser

Usage

Import mne-python

import mne

To use the new backend once, set pyqtgraph as backend with

mne.viz.set_browser_backend("pyqtgraph")

or to set it permanently with

mne.set_config('MNE_BROWSE_BACKEND', 'pyqtgraph')

Then load and plot your Raw-data, e.g. by using:

raw = mne.io.read_raw("<path_to_your_data>")
raw.plot()

If the plot is not showing, search for solutions in the troubleshooting section below.

Troubleshooting

Running from a script

If you are running a script containing raw.plot() like

python example_script.py

the plot will not stay open when the script is done.

To solve this either change raw.plot() to raw.plot(block=True) or run the script with the interactive flag

python -i example_script.py

IPython

If the integration of the Qt event loop is not activated for IPython, a plot with raw.plot() will freeze. Do avoid that either change raw.plot() to raw.plot(block=True) or activate the integration of the event loop with

%gui qt5

Report Bugs & Feature Requests

Please report bugs and feature requests in the issues of this repository.

Development and testing

You can run a benchmark locally with:

$ pytest -m benchmark mne_qt_browser

To run tests, clone mne-python, and then run the PyQtGraph tests with e.g.:

$ pytest -m pgtest ../mne-python/mne/viz/tests

If you do not have OpenGL installed, this will currently raise errors, and you'll need to add this line to mne/conftest.py after the error:: line:

    ignore:.*PyOpenGL was not found.*:RuntimeWarning

hoechenberger/mne-qt-browser