Skip to content

Commit 55e5a59

Browse files
committed
Open v2.4.0 planning cycle
Mark v2.3.0 as released in the completed requirements sheet and add the initial v2.4.0 planning baseline with the explicitly deferred tasks: mne-mna Python package, NeuralSet interoperability, field-map visualization, production CMNE checkpoint, and CI/release hardening follow-ups.
1 parent a35784f commit 55e5a59

2 files changed

Lines changed: 75 additions & 12 deletions

File tree

doc/dev-notes/v2.3.0-requirements.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Release target: v2.3.0
44
Codename: **Real-Time Ready · Cortical Studio · Python Bridge**
55
Branch: staging (all work happens on staging — never push directly to main)
66

7-
Last updated: 13 June 2026 — All planned v2.3.0 tasks complete. Post-release-prep work (after `71a89bafd4`) added: **15+ CI pipeline fixes** (XCB/XKB deps, EGL/GLES libs, vswhere, pip cache, deploy auth, website SSG/MDX build, pipeline annotations, license-headers consolidation); **TASK 10.5** screenshot regression CI now landed (`6f74d33f98`); **TASK 11 enhancements**: session persistence for `PolhemusCoregistration` (`445fb0fc10`), constrained optical calibration solver with known tracker-to-objective distance, direct objective-center capture, sample persistence; **new disp3D features**: tracker-driven video overlay projection on head surface, vertex-displaced depth relief for video overlay, catheter probe tracking (station 3) with visualization, probe tip-only with rotating crosshair aesthetic. **TASK 4.6** field-mapping overlay + **CMNE production ONNX checkpoint** + **TASKs 1-2** deferred to v2.4.0. Tag `v2.3.0` not yet created — release pending final CI validation.)
7+
Last updated: 15 June 2026 — v2.3.0 released. All planned v2.3.0 tasks complete. Post-release-prep work (after `71a89bafd4`) added: **15+ CI pipeline fixes** (XCB/XKB deps, EGL/GLES libs, vswhere, pip cache, deploy auth, website SSG/MDX build, pipeline annotations, license-headers consolidation); **TASK 10.5** screenshot regression CI now landed (`6f74d33f98`); **TASK 11 enhancements**: session persistence for `PolhemusCoregistration` (`445fb0fc10`), constrained optical calibration solver with known tracker-to-objective distance, direct objective-center capture, sample persistence; **new disp3D features**: tracker-driven video overlay projection on head surface, vertex-displaced depth relief for video overlay, catheter probe tracking (station 3) with visualization, probe tip-only with rotating crosshair aesthetic. **TASK 4.6** field-mapping overlay + **CMNE production ONNX checkpoint** + **TASKs 1-2** deferred to v2.4.0. Tag `v2.3.0` created and released on 15 June 2026.)
88

99
---
1010

@@ -66,7 +66,7 @@ Last updated: 13 June 2026 — All planned v2.3.0 tasks complete. Post-release-p
6666
| 11 | Coregistration helper app | **Done**`mne_align` app + Polhemus FASTRAK driver + wizard + ICP + `-trans.fif` export + manual page; **session persistence** (`445fb0fc10`) + **optical calibration** enhancements landed |||
6767
| 16 | Skigen integration & API registry | **Done** (16.7 CI workflow + validator + test all landed) |||
6868

69-
**Running totals:** all planned v2.3.0 tasks complete (36 algorithm sub-tasks + 10 GUI/infrastructure tasks); 391+ tests passing, 0 regressions. TASKs 1-2 deferred to v2.4.0. Release pending: CHANGELOG update for post-prep features, CITATION.cff date, tag creation.
69+
**Running totals:** all planned v2.3.0 tasks complete (36 algorithm sub-tasks + 10 GUI/infrastructure tasks); 391+ tests passing, 0 regressions. TASKs 1-2 deferred to v2.4.0. Released as `v2.3.0` on 15 June 2026; v2.4.0 planning continues in `doc/dev-notes/v2.4.0-requirements.md`.
7070

7171
---
7272

@@ -132,14 +132,14 @@ v2.3.0 is ready to ship. All pillars are complete. TASKs 1-2 are
132132
deferred to v2.4.0; pillars E and F should read "Deferred to v2.4.0".
133133
TASK 10.5 screenshot regression CI is now landed (no longer deferred).
134134

135-
**Release checklist (pending):**
135+
**Release checklist (completed):**
136136

137-
1. Verify CI green on all platforms (staging workflows).
138-
2. Update `CHANGELOG.md` with post-release-prep features (video overlay, probe tracking, session persistence, optical calibration, CI fixes).
139-
3. Update `CITATION.cff` version to `2.3.0` and release date.
140-
4. Merge staging → main.
141-
5. Tag `v2.3.0` on main.
142-
6. GitHub Release with binaries triggers automatically.
137+
1. Verify CI green on all platforms (staging workflows).**Done**
138+
2. Update `CHANGELOG.md` with post-release-prep features (video overlay, probe tracking, session persistence, optical calibration, CI fixes).**Done**
139+
3. Update `CITATION.cff` version to `2.3.0` and release date.**Done**
140+
4. Merge/fast-forward staging → main.**Done**
141+
5. Tag `v2.3.0` on main.**Done**
142+
6. GitHub Release with binaries triggers automatically.**Done**
143143

144144
### TASK 16 — Skigen integration & API registry
145145

@@ -170,12 +170,12 @@ inverses**, **directed connectivity**, and **MNX-as-MNE-Scan-storage**. It
170170
also landed the disp3D **`ElectrodeObject`** and **`SliceObject`**
171171
renderables — but neither is exposed in any GUI yet.
172172

173-
As of 13 June 2026, all v2.3.0 tasks are complete. The codebase includes
173+
As of 15 June 2026, v2.3.0 is released. The codebase includes
174174
36 algorithm sub-tasks (391+ tests), all GUI pillars (MNE Inspect, MNE Scan,
175175
mne_analyze, mne_analyze_studio, mne_align), TASK 10.5 screenshot regression CI,
176176
15+ CI pipeline fixes, and new disp3D features (video overlay + catheter probe
177-
tracking). TASKs 1-2 are explicitly deferred to v2.4.0. The release is
178-
pending CHANGELOG finalization and tag creation.
177+
tracking). TASKs 1-2 are explicitly deferred to v2.4.0 and tracked in
178+
`doc/dev-notes/v2.4.0-requirements.md`.
179179

180180
### Pillars
181181

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# MNE-CPP v2.4.0 — Planning Baseline
2+
3+
Release target: v2.4.0
4+
Codename: **TBD**
5+
Branch: staging (all work happens on staging; main is reserved for releases)
6+
7+
Last updated: 15 June 2026 — Initial planning sheet opened immediately after the v2.3.0 release. This cycle starts from the items explicitly deferred from v2.3.0 plus release-follow-up cleanup.
8+
9+
---
10+
11+
## Release Goals
12+
13+
v2.4.0 should build on the v2.3.0 multimodal/real-time release by focusing on:
14+
15+
1. **MNA Python bridge and NeuralSet interoperability** — complete the external workflow integration items that were intentionally deferred from v2.3.0.
16+
2. **Field-map visualization in the GUI** — expose the already-tested field-map computation stack through a scalp/BEM-aware rendering layer.
17+
3. **Production CMNE model packaging** — replace the in-tree fallback path with a trained, versioned ONNX checkpoint and release/update procedure.
18+
4. **CI/release pipeline hardening** — keep the v2.3.0 release pipeline lessons, reduce duplicate visual screenshot workflows, and make release reruns idempotent.
19+
20+
---
21+
22+
## Implementation Plan
23+
24+
| Task | Description | Status | Notes / Acceptance Criteria |
25+
|------|-------------|--------|-----------------------------|
26+
| **1** | `mne-mna` Python package | Planned | Python package for reading/writing/running MNA workflows; coordinate with mne-python packaging conventions; include round-trip tests and docs. |
27+
| **2** | NeuralSet interoperability | Planned | Define/import/export NeuralSet event/session tables; establish conversion path to/from MNA/MNX; include schema validation and example datasets. |
28+
| **4.6** | Field-mapping overlay in `mne_analyze` / `mne_inspect` | Planned | `FwdFieldMap` library and tests already exist; add scalp-BEM rendering layer in `disp3D`, GUI controls, and visual tests. |
29+
| **3.x** | Production CMNE ONNX checkpoint | Planned | Train/version production model, document provenance, package checkpoint, and make runtime selection deterministic; keep fallback behavior for missing models. |
30+
| **CI.1** | Visual screenshot pipeline consolidation | Planned | Decide whether `mne_screenshot_regression` remains a separate gate with true golden-image comparison, or whether visual smoke coverage folds into doc screenshot generation (`mne_doc_shots`). |
31+
| **CI.2** | Release rerun hardening | In progress | Preserve idempotent release creation/tag rerun behavior; document retag procedure and expected branch/tag state. |
32+
| **Docs.1** | Post-v2.3 documentation cleanup | Planned | Update release-process notes with v2.3.0 lessons; ensure stable/dev website version switch remains correct. |
33+
34+
---
35+
36+
## Deferred / Candidate Scope
37+
38+
### MNE-Python parity candidates
39+
40+
Remaining non-critical gaps after v2.3.0 include:
41+
42+
- Niche I/O formats: GDF, SNIRF, Curry, MEF, FieldTrip, Neuralynx, NSx, ANT, BCI2000, Nihon Kohden, Persyst.
43+
- Specialized preprocessing: OTP, PCA-OBS, fNIRS preprocessing, iEEG preprocessing, eye-tracking preprocessing.
44+
- Advanced forward solvers: OpenMEEG and FEM.
45+
- Inverse: SAM beamformer.
46+
- Time-frequency: Stockwell TFR.
47+
- Connectivity: multivariate MIC/MIM.
48+
- Labels: random parcellation.
49+
- Coregistration: MRI scaling.
50+
- 3D visualization: volume rendering.
51+
52+
These are candidates for v2.4.0 only if they directly support the primary goals above; otherwise they should remain backlog items.
53+
54+
---
55+
56+
## Release Checklist (v2.4.0)
57+
58+
1. Keep all work on `staging` until final release.
59+
2. Keep CI green across staging, screenshot/doc pipelines, CodeQL, and release dry-runs where applicable.
60+
3. Update `CHANGELOG.md`, `CITATION.cff`, `README.md`, and `doc/website/docusaurus.config.ts` only when v2.4.0 is ready to cut.
61+
4. Fast-forward `main` to `staging`.
62+
5. Tag `v2.4.0` on `main`.
63+
6. Verify GitHub Release artifacts and website update.

0 commit comments

Comments
 (0)