Skip to content

fix MNE-RT links and update roadmap #14096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
payamsash wants to merge 1 commit into
base: main
Choose a base branch
from
+10 −10
Open

fix MNE-RT links and update roadmap #14096

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 3 additions & 8 deletions doc/development/roadmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,15 +145,10 @@ We should deprecate `MNE-Realtime`_ in favor of the newly minted `MNE-LSL`_.
We should then fully support MNE-LSL using modern coding best practices such as CI
integration.

Core components of commonly used real-time processing pipelines should be implemented in
MNE-LSL, including but not limited to realtime IIR filtering, artifact rejection,
montage and reference setting, and online averaging. Integration with standard
MNE-Python plotting routines (evoked joint plots, topomaps, etc.) should be
supported with continuous updating.

For closed-loop applications such as neurofeedback and BCI, `MNE-RT`_ builds on
MNE-LSL and MNE-Python to provide real-time feature extraction, adaptive protocols,
artifact correction, and live visualisation in a single researcher-friendly API.
MNE-LSL and MNE-Python for sensor- and source-space feature extraction, adaptive
feedback protocols, real-time artifact correction, and live visualisation that
integrates with standard MNE-Python plotting routines with continuous updating.

Clustering statistics API
^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
6 changes: 6 additions & 0 deletions doc/sphinxext/related_software.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,12 @@
"Home-page": "https://github.com/aaltoimaginglanguage/conpy",
"Summary": "Functions and classes for performing connectivity analysis on MEG data.", # noqa: E501
},
# PyPI metadata still points at the old personal repo (payamsash/mne-rt)
# instead of the current mne-rt-org/mne-rt home.
"mne-rt": {
"Home-page": "https://github.com/mne-rt-org/mne-rt",
"Summary": "Real-time M/EEG neurofeedback and BCI framework built on MNE-Python and MNE-LSL.", # noqa: E501
},
Comment on lines +84 to +89

@larsoner larsoner Jul 24, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rather than doing this, could you fix your metadata and cut a tiny release? With GHA release workflows it shouldn't be too bad, assuming you're at an okay point in your code to cut such a release. (And if you don't have trusted publishing and automated releases set up you should do it anyway!)

}

REQUIRE_INSTALLED = os.getenv("MNE_REQUIRE_RELATED_SOFTWARE_INSTALLED", "false").lower()
Expand Down
3 changes: 1 addition & 2 deletions examples/visualization/brain.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -145,8 +145,7 @@
# ``brain.layered_meshes``. Calling
# :meth:`~mne.viz.LayeredMesh.update_overlay` pushes new scalar data without
# rebuilding the full rendering pipeline — the key operation for packages that
# stream source-space data onto the brain in real time, such as
# `MNE-RT <https://payamsash.github.io/mne-rt/>`_.
# stream source-space data onto the brain in real time, such as `MNE-RT`_.
#
# Here we add an initial bottom-to-top gradient as the first data frame.

Expand Down
Loading