<p align="center">
  <a href="/resources/design/logos/MNE-CPP_Logo.svg"><img src="/resources/design/logos/MNE-CPP_Logo.svg" width="400" height="200" alt="MNE-CPP"></a>
</p>
<p align="center">
<a href="https://github.com/mne-tools/mne-cpp/actions/workflows/release.yml" target="_blank">
    <img src="https://github.com/mne-tools/mne-cpp/actions/workflows/release.yml/badge.svg" alt="Release">
</a>
<a href="https://github.com/mne-tools/mne-cpp/actions/workflows/tests.yml" target="_blank">
    <img src="https://github.com/mne-tools/mne-cpp/actions/workflows/tests.yml/badge.svg" alt="Tests">
</a>
<a href="https://codecov.io/gh/mne-tools/mne-cpp" target="_blank">
    <img src="https://codecov.io/gh/mne-tools/mne-cpp/branch/main/graph/badge.svg" alt="CodeCov">
</a>
<a href="https://github.com/mne-tools/mne-cpp/actions/workflows/codeql.yml" target="_blank">
    <img src="https://github.com/mne-tools/mne-cpp/actions/workflows/codeql.yml/badge.svg" alt="CodeQL">
</a>
<a href="https://scan.coverity.com/projects/mne-tools-mne-cpp" target="_blank">
    <img src="https://scan.coverity.com/projects/8955/badge.svg" alt="Coverity">
</a>
<a href="https://gitter.im/mne-tools/mne-cpp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" target="_blank">
    <img src="https://badges.gitter.im/mne-tools/mne-cpp.svg" alt="Gitter">
</a>
</p>

-----------------

MNE-CPP is an open-source software framework which offers a variety of neuroscientific tools. It provides a cross-platform library, which allows to build standalone applications for the acquisition and processing of MEG/EEG data, both in real-time and offline. For more information and documentation please visit https://mne-cpp.github.io/.

Build from source
-----------------

`tools/build_project.bat` builds the project for Windows, Linux, and MacOS.

For IDE discovery and manual builds, configure from the repository root:

`cmake -S . -B build`

For more in depth information on how to compile the project, please follow the [build guide](https://mne-cpp.github.io/pages/development/buildguide.html). The minimum requirements to build MNE-CPP are:

  * Compiler
    * Windows - [MSVC 2022](https://visualstudio.microsoft.com/vs/) or later
    * Linux - [GCC 13](https://gcc.gnu.org/releases.html) or later
    * MacOS - [Clang 14](https://developer.apple.com/xcode/) or later
  * External dependencies
    * [Qt 6.10](https://www.qt.io/) or later
    * [Python 3.10](https://www.python.org/) or later

Releases
--------

Release binaries for Windows, Mac and Linux are available [here](https://mne-cpp.github.io/pages/download/download.html).

Get involved
------------

If you want to contribute to MNE-CPP you can find all necessary information [here](https://mne-cpp.github.io/pages/development/contribute.html).

Contact
-------

A list of contact persons can be found [here](https://mne-cpp.github.io/contact.html).

License
-------

MNE-CPP is **BSD-licenced** (3 clause):

    Copyright (c) 2011-2026, authors of MNE-CPP. All rights reserved.

    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are met:

    1. Redistributions of source code must retain the above copyright notice, this
       list of conditions and the following disclaimer.

    2. Redistributions in binary form must reproduce the above copyright notice,
       this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.

    3. Neither the name of the copyright holder nor the names of its
       contributors may be used to endorse or promote products derived from
       this software without specific prior written permission.

    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
    AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
    IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
    DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
    FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
    DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
    SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
    CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
    OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
    OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
