-
Notifications
You must be signed in to change notification settings - Fork 140
Home
MNE-CPP is an open-source, cross-platform C++17 framework for the acquisition, processing, and visualization of MEG / EEG / sEEG / fNIRS data, designed for real-time clinical and research workflows.
The authoritative documentation lives on the project website. This wiki is a curated index of where to find what.
| Step | Where to go |
|---|---|
| Install a binary | Downloads — Linux, macOS, Windows installers, plus a WebAssembly demo |
| Open sample data | Sample dataset |
| First MNE Inspect session | Inspect quickstart |
| Build from source | Developer setup |
| Resource | Link |
|---|---|
| Project website | https://mne-cpp.github.io |
| User manual | https://mne-cpp.github.io/docs/manual/intro |
| Developer guide | https://mne-cpp.github.io/docs/development/intro |
| C++ API reference (Doxygen) | https://mne-cpp.github.io/api |
| MNA / MNX format specification | https://mne-cpp.github.io/docs/manual/mna-format |
| FIFF format reference | https://mne-cpp.github.io/docs/manual/fiff-format |
| Command-line tools overview | https://mne-cpp.github.io/docs/manual/tools-overview |
| Channel | Link |
|---|---|
| Latest stable installer | https://github.com/mne-tools/mne-cpp/releases/latest |
| All releases | https://github.com/mne-tools/mne-cpp/releases |
| Nightly dev builds | https://github.com/mne-tools/mne-cpp/releases/tag/dev_build |
| WebAssembly browser demo | https://mne-cpp.github.io/wasm/ |
SDK (CMake find_package(MNECPP)) |
Attached to each release as mnecpp-<version>-sdk-*.tar.gz
|
If you use MNE-CPP in academic work, please cite the framework. The concept DOI always resolves to the latest version:
@software{mne_cpp,
author = {Dinh, Christoph and Esch, Lorenz and Larson, Eric and others},
title = {{MNE-CPP: A Framework for Electrophysiology}},
publisher = {Zenodo},
doi = {10.5281/zenodo.593102},
url = {https://github.com/mne-tools/mne-cpp}
}A machine-readable CITATION.cff
ships in the repository root and is consumed by GitHub's Cite this repository
button.
Full publication list: https://mne-cpp.github.io/docs/cite
| Channel | Purpose |
|---|---|
| GitHub Discussions | Q&A, ideas, show-and-tell |
| GitHub Issues | Bug reports, feature requests |
| Pull requests | Code contributions |
CONTRIBUTING.md |
How to contribute |
CODE_OF_CONDUCT.md |
Community standards |
| MNE-Python community | https://mne.tools — sister project, shared formats and concepts |
- Release process — how to cut a new MNE-CPP release.
- Roadmap — current release plans (v2.2.0 to v2.3.0).
- CI dashboards: Staging · Release · CodeQL · Coverity
- Coverage:
| Project | Relationship |
|---|---|
| MNE-Python | Reference implementation; MNE-CPP shares the FIFF format and many algorithms |
| MNE-BIDS | BIDS layer used for MNE-CPP's BIDS importer/exporter |
| FreeSurfer | Source of subject anatomies (BEM, source spaces, cortical surfaces) |
| Qt 6 | GUI toolkit for desktop and WASM builds |
| Eigen | Linear algebra backbone |
| ONNX Runtime | ML model inference for the ml library |
This wiki is generated from
doc/wiki/ in the
main repo and auto-deployed by the
wiki.yml
workflow on every push to main. Edit those files via pull request; direct
edits to the wiki UI will be overwritten.
MNE-CPP — BSD-3-Clause licensed · Maintained by the MNE-CPP authors · Website · API · Source
Edit this wiki via
doc/wiki/— direct edits in the GitHub UI are overwritten on next push tomain.