mne-tools / mne-tools/mne-python

split off simulation code into separate package

Open
#12,980 12 comments 0 reactions 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

Hi @mne-tools/mne-python-steering-committee

@ctrltz and colleagues have been doing some work on simulating MNE objects (above and beyond what we currently support), in the new https://github.com/ctrltz/meegsim package. They have expressed interest in incorporating their work into MNE-Python, and after a few discussions with @larsoner @agramfort and @britta-wstnr we've settled on a tentative plan to "spin off" our existing simulation code into a new package (mne-simulation or so) similar to what was done for connectivity a few years ago, and then give @ctrltz and colleagues write-access to that repo so they can add their code and also have a much smaller/faster test/CI suite. Existing simulation code would be deprecated in MNE-Python release 1.9 and removed in 1.10.

This issue is your chance to weigh in on whether you think it best to:

  1. follow the above plan
  2. keep existing simulation code in MNE-Python, and add new code into the main repo
  3. keep existing simulation code in MNE-Python, and don't add the new MEEGsim functionality
  4. something else (?)

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

No files, tests, or entry points are named. Start by reviewing the existing simulation code and the proposed mne-simulation or meegsim package plan, then follow the discussion to determine whether the package split is approved. Done would require an agreed migration and deprecation plan, but this issue does not define implementation scope.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.