Build from Source


The CMake Build Guide goes through the process of building the current version of the project. The qmake Build Guide is for older versions of the project. If you are building the project from the main repository’s main branch, you’ll want to follow the CMake guide

These show you how to build the dynamically and statically linked version of MNE-CPP from source. After building the project you will be able to run the different applications that are part of the project. These will appear as executable files with different extensions, depending on your operating system.

You can run the compiled applications within QtCreator application (this is the recommended tool also for development and building processes), by pressing the Run button. However, if you want to run directly from within a different command-line tool or through the operating system itself, you will have to resolve all the Qt-related dependencies by generating Qt libraries. MNE-CPP provides a useful automatic deployment script which is saved in tools/deployment. For more information about this script see the Continous Integration section. Briefly, run the script deploy.bat with either dynamic or static as input argument to specify the linkage to be used. This way all the necessary Qt-related dependencies will be solved and the applications readily available for execution in all contexts. We recommend building the dynamically linked version for developing purposes.

Note on CMake

MNE-CPP has migrated from using qmake to CMake as a buildsystem generator tool. Qmake is Qt’s old build system created for building the qt project. CMake has become a de facto standard for project building in c++, especially with later versions (>3.0). Aside from following in Qt’s footsteps, as that project has switched to CMake too, we believe that CMake is a better framework for the project’s long term maintainability, and will reduce the learning curve for potential contributors.

We apologise for any of the growing pains that will inevitably occur, and we appreciate any and all feedback or suggestions, either through github or email. We will keep the qmake build instructions on here, and the last instance of the project still in qmake is still avilable on github in the qmake branch.

Table of contents