mne-tools / mne-tools/mne-python

[Idea] Using Jupyterlite for interactive tutorials and workshops

Open
#13,616 22 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.5k
Forks
1.6k
Avg merge
1d 6h
Merged PRs (30d)
100

Description

Creating this issue to get my thoughts out on paper. Something I have been thinking about for a while that would go along with the Education objective of the MNE Roadmap.

A long wild back I added support for MNE to Pyodide. It has since added pip support for all pure Python packages so it's now up-to-date with the latest released version with no updates needed.

Jupyterlite has greatly matured as a project and is at a point where we could consider adopting for interactive tutorials. Jupyterlite takes the Jupyterlab ecosystem and wires it up with either Pyodide (and pip) or Xeus-Python (and conda+pip)
I think a bit of work would be needed to ensure the sample dataset could be added to the workspace.

We could use this setup for workshops to get up and going quickly.

Some few examples of Jupyterlite:

cc: @larsoner

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or tests. Start by reviewing the Education objective in the roadmap and the linked Pyodide and Jupyter examples, then determine how the sample dataset could be added to an interactive workspace. Done would require an agreed implementation plan for tutorials and workshops.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter, python
Domain
content, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.