Difference between revisions of "Portal:Getting Started"
From MNE-CPP Wiki
| Line 3: | Line 3: | ||
'''Get the mne-cpp source code:''' | '''Get the mne-cpp source code:''' | ||
# Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account. | # Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account. | ||
| + | |||
'''Compile the mne-cpp source code:''' | '''Compile the mne-cpp source code:''' | ||
| Line 16: | Line 17: | ||
# Select the Release mode in the lower left corner. | # Select the Release mode in the lower left corner. | ||
# In the Qt Creator's ''Projects'' window right mouse click on the top level mne-cpp tree item, then select ''Run qmake''. | # In the Qt Creator's ''Projects'' window right mouse click on the top level mne-cpp tree item, then select ''Run qmake''. | ||
| − | # Right mouse click again and then hit ''Build'' | + | # Right mouse click again and then hit ''Build'' (this step may take some time). |
# After the build process is finished, go to the ''mne-cpp/bin'' folder. All applications and libraries should have been created throughout the build process. | # After the build process is finished, go to the ''mne-cpp/bin'' folder. All applications and libraries should have been created throughout the build process. | ||
# In case you do not have a windows debugger: | # In case you do not have a windows debugger: | ||
| Line 23: | Line 24: | ||
## Open the QtCreator and select the debugger under ''Tools/Options/Build & Run/Kits/[your Kit name goes here]/Debugger''. | ## Open the QtCreator and select the debugger under ''Tools/Options/Build & Run/Kits/[your Kit name goes here]/Debugger''. | ||
| − | |||
| + | '''Optional - Get the sample data set:''' | ||
| + | # Download the MNE sample data from [ftp://surfer.nmr.mgh.harvard.edu/pub/data/MNE-sample-data-processed.tar.gz here]. | ||
| + | # Open the tar.gz file (i.e. with [http://www.7-zip.de/ 7zip]) and extract the data into the ''mne-cpp/bin/MNE-sample-data'' folder. | ||
| + | |||
| + | |||
| + | '''Optional - Further reading:''' | ||
* Tutorial: How to create your first MNE-CPP application. | * Tutorial: How to create your first MNE-CPP application. | ||
* Tutorial: How to create your first MNE-X plugin. | * Tutorial: How to create your first MNE-X plugin. | ||
* Guide: How to contribute your code. | * Guide: How to contribute your code. | ||
Revision as of 12:45, 4 January 2016
This page will show you how to setup the mne-cpp project in order to build and develop your own features with or based on the mne-cpp framework.
Get the mne-cpp source code:
- Git clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account.
Compile the mne-cpp source code:
- Download the current Qt version:
- Go to the Qt download website.
- Select the appropriate version based on the compiler and platform you use.
- For example if you are using the Microsoft Visual Studio 2013 Compiler on a Windows 32bit system, select the "Qt 5.5.1 for Windows 32-bit (VS 2013, 823 MB)" version.
- Install the Qt version with the minimum of the following features:
- Qt/Qt x.x/Pre-compiled Qt (i.e. Qt 5.5/msvc2013 32-bit)
- Qt/Qt x.x/Qt3D
- Qt/Tools/QtCreator
- Go to your cloned repository folder and run the mne-cpp/mne-cpp.pro file with the QtCreator.
- Select the Release mode in the lower left corner.
- In the Qt Creator's Projects window right mouse click on the top level mne-cpp tree item, then select Run qmake.
- Right mouse click again and then hit Build (this step may take some time).
- After the build process is finished, go to the mne-cpp/bin folder. All applications and libraries should have been created throughout the build process.
- In case you do not have a windows debugger:
- Go to the Windows SDK download website
- Download and install the SDK (during the installation, select the Debugging Tools for Windows box and clear all the other boxes).
- Open the QtCreator and select the debugger under Tools/Options/Build & Run/Kits/[your Kit name goes here]/Debugger.
Optional - Get the sample data set:
- Download the MNE sample data from here.
- Open the tar.gz file (i.e. with 7zip) and extract the data into the mne-cpp/bin/MNE-sample-data folder.
Optional - Further reading:
- Tutorial: How to create your first MNE-CPP application.
- Tutorial: How to create your first MNE-X plugin.
- Guide: How to contribute your code.
