Skip to main content

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

Project description

mne-qt-browser

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

Screenshot of mne-qt-browser

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.

Installation

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

pip

pip install mne matplotlib mne-qt-browser

or

conda

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

Usage

The backend supports plotting for the following MNE-Python methods:

In the following example, we'll read M/EEG raw data from the MNE sample dataset and plot it using the qt-backend. (For mne-version >= 1.0 the qt-backend will be the default)

from pathlib import Path
import mne

sample_dir = mne.datasets.sample.data_path()
raw_path = Path(sample_dir) / 'MEG' / 'sample' / 'sample_audvis_raw.fif'
raw = mne.io.read_raw(raw_path)

mne.viz.set_browser_backend('qt')  # Enable mne-qt-browser backend if mne < 1.0
raw.plot(block=True)

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

This will use the mne-qt-browser for the current Python session. If you want to make this change permanent, so you don't have to use the set_browser_backend() each time after restarting Python, run the following line to modify your MNE configuration file:

import mne
mne.set_config('MNE_BROWSER_BACKEND', 'qt')

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mne-qt-browser-0.2.4.tar.gz (59.6 kB view details)

Uploaded Source

Built Distribution

mne_qt_browser-0.2.4-py3-none-any.whl (63.5 kB view details)

Uploaded Python 3

File details

Details for the file mne-qt-browser-0.2.4.tar.gz.

File metadata

  • Download URL: mne-qt-browser-0.2.4.tar.gz
  • Upload date:
  • Size: 59.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for mne-qt-browser-0.2.4.tar.gz
Algorithm Hash digest
SHA256 27404a9ff5fdac59aefc5b6a8afc2bfc6dac609e66eb8d53d81d3fd94bc0b4f3
MD5 0e0900a2a1d39b9946e537214f4ed44a
BLAKE2b-256 459742a5900771f4621503462ca012167bdefa241c74060027458b31dbb42cc0

See more details on using hashes here.

File details

Details for the file mne_qt_browser-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: mne_qt_browser-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 63.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.63.0 importlib-metadata/4.11.2 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.2

File hashes

Hashes for mne_qt_browser-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 33f599cd974f71f2a91b7e5379d0b3ddbcc198d60118d739d372ff0dd6dd3407
MD5 57b314b7c2cf2667d7167db82ab8e22a
BLAKE2b-256 f412760b1ae109210d2e4c6612a7458353cc2fca13e9e63126c3c62ddb775a68

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page