Difference between revisions of "Portal:Getting Started"

From MNE-CPP Wiki
Jump to: navigation, search
 
(41 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.
+
This portal will show you how to use the MNE-CPP project as developer or command line user.  
  
'''Getting the mne-cpp source code compiled:'''
+
= Getting Started as Developer =
# Download the current Qt version:
+
## Go to the [http://www.qt.io/download-open-source/#section-2 Qt download website]
+
## Select 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 feautres:
+
#:* Qt/Pre-compiled Qt
+
#:* Qt/Qt3D
+
#:* Tools/QtCreator
+
# Clone mne-cpp from the main repository (mne-tools/mne-cpp) or your forked repository from your own Git Hub account.
+
# Run the mne-cpp.pro file with the QtCreator. Select the Release mode.
+
# Right mouse click on the top level tree item mne-cpp, then select Run qmake.
+
# Right mouse click again and then hit Build. The build porcess may take some time depending on your computer setup.
+
# After the build process is finished, check out the mne-cpp/bin folder. All applications and libraries should have been created throughout the build process.
+
# In case you do not have a debugger setup (for windows):
+
## Go to SDK webpage.
+
## Download and install SDK.
+
## Select debugger under Kits in QtCreator.
+
## The first time you use the debugger, you might see the following message.
+
  
'''Next steps:'''
+
If you want to setup and compile the latest MNE-CPP version please read the [[Step by Step Setup Guide|'''step by step setup guide''']].
 +
<!-- If you want to use the MNE-CPP version based on the old qt3D module please read the [[Step by Step Setup Guide (old qt3D version)|old step by step guide]]. Please note that this version is not longer maintained or developed, since the old qt3D version has been completley replaced by the new qt3D module.-->
  
Tutorial on how to create your first application
+
= Getting Started as Command Line User =
 
+
The command line tools parameters are described in section [[Command Line Tools|Command Line Tools Instructions]].
Tutorial on how to create your first MNE-X plugin
+

Latest revision as of 18:26, 31 January 2018

This portal will show you how to use the MNE-CPP project as developer or command line user.

Getting Started as Developer

If you want to setup and compile the latest MNE-CPP version please read the step by step setup guide.

Getting Started as Command Line User

The command line tools parameters are described in section Command Line Tools Instructions.