Difference between revisions of "Portal:Develop"

From MNE-CPP Wiki
Jump to: navigation, search
(→‎Documentation)
 
(14 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
== The MNE-CPP Project Structure==  
+
== General Project Information ==  
−
* Highly modular and easily extendable
+
−
* Cross platform capable: Windwos, Linux, Mac, handheld devices & embedded systems
+
−
* Purely written in C++
+
−
* MNE-CPP is set up as a two layer structure:
+
−
*:# Library layer:
+
−
*:#:* Backbone of the MNE-CPP framework
+
−
*:#:* Different libraries providing core features & functionalities
+
−
*:# Application layer:
+
−
*:#:* User interaction of the MNE-CPP framework
+
−
*:#:* Full scale GUI applications with rich user experience
+
−
*:#:* Command line applications
+
−
*:#:* Simple examples for an easy start
+
−
*:#:* SUnit tests: Safeguarding correctness of results
+
−
* Dependencies:
+
−
*:# Keep dependencies to a minimum
+
−
*:# Qt for Graphical User Interface integration
+
−
*:# Light-weight template library Eigen for linear algebra
+
−
*:# Future proof: Qt/Eigen are highly & activley maintained
+
−
*:# Avoid SOUP (Software Of Unknown Pedigree)
+
  
−
[[File:MNE-CPP Library horizontal.png|400px]]
+
[[The MNE-CPP Project Structure]]
  
−
== The MNE-CPP Development Cycle==
+
[[MNE-CPP's Agile Development Cycle]]
−
=== Project Management ===
+
−
The MNE-CPP project is maintained by an agile management approach, using JIRA. JIRA is a well known issue tracking tool by Atlassian, which let's you post bug reports, improvement tasks, wishes for new features and much more. It gives you a way to directly participate in the development of MNE-CPP. Please go to [https://mne-cpp.atlassian.net MNE-CPP's JIRA website] and sign up for an account if you wish to help to improve MNE-CPP.
+
−
 
+
−
Next to JIRA we also use Atlassian's Confluence to share documents, meeting notes and other project related files. You can find our confluence page [https://mne-cpp.atlassian.net/wiki/ here].
+
  
 
== Tutorials ==  
 
== Tutorials ==  
 
=== Introductive ===
 
=== Introductive ===
 +
[[Setup real-time source localization example]]
 +
 +
[[Setup SSVEP BCI example]]
 +
 +
[[Setup EEG amplifier plugins in MNE Scan]]
 +
 
[[Create a MNE-CPP based application]]
 
[[Create a MNE-CPP based application]]
  
−
[[Create a MNE-X plugin]]
+
[[Create a MNE Scan plugin]]
  
 
=== Advanced ===
 
=== Advanced ===
 
[[MNE CPP on Neuromag Linux]]
 
[[MNE CPP on Neuromag Linux]]
  
−
== Documentation ==
+
== MNE-CPP Releases ==
 +
 
 +
[https://github.com/mne-tools/mne-cpp/releases/tag/v1.0.0-beta3.0 MNE-CPP v1.0.0-beta 3.0] (03/31/2017)
 +
 
 +
[https://github.com/mne-tools/mne-cpp/releases/tag/v1.0.0-beta2.0 MNE-CPP v1.0.0-beta 2.0] (01/18/2017)
 +
 
 +
[https://github.com/mne-tools/mne-cpp/releases/tag/v1.0.0-beta1.0 MNE-CPP v1.0.0-beta 1.0] (04/28/2015)
 +
 
 +
== Conventions and Policies ==
 
[[Coding Conventions & Style]]
 
[[Coding Conventions & Style]]
  
 
[[Commit Policy]]
 
[[Commit Policy]]
−
 
−
[http://doc.mne-cpp.org MNE-CPP Reference]
 

Latest revision as of 09:50, 5 October 2017

General Project Information

The MNE-CPP Project Structure

MNE-CPP's Agile Development Cycle

Tutorials

Introductive

Setup real-time source localization example

Setup SSVEP BCI example

Setup EEG amplifier plugins in MNE Scan

Create a MNE-CPP based application

Create a MNE Scan plugin

Advanced

MNE CPP on Neuromag Linux

MNE-CPP Releases

MNE-CPP v1.0.0-beta 3.0 (03/31/2017)

MNE-CPP v1.0.0-beta 2.0 (01/18/2017)

MNE-CPP v1.0.0-beta 1.0 (04/28/2015)

Conventions and Policies

Coding Conventions & Style

Commit Policy

Retrieved from "http://wiki.mne-cpp.org/index.php?title=Portal:Develop&oldid=428"