Difference between revisions of "Documentation/Nightly/Developers"

From Slicer Wiki
Jump to: navigation, search
Tag: 2017 source edit
 
Line 1: Line 1:
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
<noinclude>{{documentation/versioncheck}}</noinclude>
 
__NOTOC__
 
__NOTOC__
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
+
{| border="0" align="center" width="98%" cellspacing="7" cellpadding="2" valign="top"
 
|-
 
|-
 
|<span style="color: #555555; font-size: 18px; font-weight: bold;">New Developers</span>:&nbsp;&nbsp;&nbsp;&nbsp;<big><big>Welcome ! Check these '''[[{{FULLPAGENAME}}/StartHere|instructions]]''' !</big></big>
 
|<span style="color: #555555; font-size: 18px; font-weight: bold;">New Developers</span>:&nbsp;&nbsp;&nbsp;&nbsp;<big><big>Welcome ! Check these '''[[{{FULLPAGENAME}}/StartHere|instructions]]''' !</big></big>
 
|}
 
|}
  
{| border="0" align="center" width="98%" valign="top" cellspacing="7" cellpadding="2"
+
{| border="0" align="center" width="98%" cellspacing="7" cellpadding="2" valign="top"
 
|-
 
|-
! width="33%"|
+
! width="33%" |
 
! |
 
! |
! width="33%"|
+
! width="33%" |
 
! |
 
! |
! width="33%"|
+
! width="33%" |
 
|-  
 
|-  
|valign="top"|
+
| valign="top" |
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Getting involved</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Getting involved</span>
Line 20: Line 20:
  
 
[[Documentation/{{documentation/version}}/Developers/StartHere|Start here]]
 
[[Documentation/{{documentation/version}}/Developers/StartHere|Start here]]
: New community member checklist
+
 
 +
:New community member checklist
  
 
[[{{FULLPAGENAME}}/Meetings|Developer meetings]]
 
[[{{FULLPAGENAME}}/Meetings|Developer meetings]]
: It is open to everyone, feel free to join.
+
 
 +
:It is open to everyone, feel free to join.
  
 
[https://discourse.slicer.org Discussion Forum]
 
[https://discourse.slicer.org Discussion Forum]
: The most effective way to get help from the community
+
 
 +
:The most effective way to get help from the community
 
<!--
 
<!--
 
[http://slicer-devel.65872.n3.nabble.com/ Search developers mailing list] / [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up]
 
[http://slicer-devel.65872.n3.nabble.com/ Search developers mailing list] / [http://massmail.spl.harvard.edu/mailman/listinfo/slicer-devel Sign-up]
Line 33: Line 36:
  
 
[[Documentation/{{documentation/version}}/Developers/FAQ|FAQ]]
 
[[Documentation/{{documentation/version}}/Developers/FAQ|FAQ]]
: Set of common development questions/answers
+
 
 +
:Set of common development questions/answers
 +
 
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Resources</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Resources</span>
 
----
 
----
 
[[Roadmap|Roadmap]]{{updated}}
 
[[Roadmap|Roadmap]]{{updated}}
: What's next ? What's the plan ?
+
 
 +
:What's next ? What's the plan ?
  
 
[[Documentation/Labs|Labs]] {{new}}
 
[[Documentation/Labs|Labs]] {{new}}
: Keep track of on-going experiments.
+
 
 +
:Keep track of on-going experiments.
  
 
[http://apidocs.slicer.org/master/annotated.html Doxygen]
 
[http://apidocs.slicer.org/master/annotated.html Doxygen]
: Source code API documentation.
+
 
 +
:Source code API documentation.
  
 
Source code repository
 
Source code repository
: [https://github.com/Slicer/Slicer Github] or [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk SVN]
+
 
 +
:[https://github.com/Slicer/Slicer Github] or [http://viewvc.slicer.org/viewvc.cgi/Slicer4/trunk SVN]
  
 
CDash Quality Dashboard: [http://slicer.cdash.org/index.php?project=Slicer4 SlicerStable], [http://slicer.cdash.org/index.php?project=SlicerPreview SlicerPreview]
 
CDash Quality Dashboard: [http://slicer.cdash.org/index.php?project=Slicer4 SlicerStable], [http://slicer.cdash.org/index.php?project=SlicerPreview SlicerPreview]
: Nightly, continuous and experimental dashboards. - <small>[[{{FULLPAGENAME}}/Tutorials/DashboardSetup|Setup a dashboard]]</small>
+
 
 +
:Nightly, continuous and experimental dashboards. - <small>[[{{FULLPAGENAME}}/Tutorials/DashboardSetup|Setup a dashboard]]</small>
  
 
[https://issues.slicer.org Bug tracker] / [https://issues.slicer.org/signup_page.php Register] / [[Documentation/{{documentation/version}}/Report_a_problem|Report a problem]] /  [[Documentation/{{documentation/version}}/Developers/Tutorials/ContributePatch|Contribute a patch]]
 
[https://issues.slicer.org Bug tracker] / [https://issues.slicer.org/signup_page.php Register] / [[Documentation/{{documentation/version}}/Report_a_problem|Report a problem]] /  [[Documentation/{{documentation/version}}/Developers/Tutorials/ContributePatch|Contribute a patch]]
: Web-based bug tracking system - <small>[[Documentation/{{documentation/version}}/Developers/BugTrackerConfiguration|Configuration]]</small>
+
 
 +
:Web-based bug tracking system - <small>[[Documentation/{{documentation/version}}/Developers/BugTrackerConfiguration|Configuration]]</small>
  
 
[[{{FULLPAGENAME}}/Style Guide|Slicer Style Guidelines]]
 
[[{{FULLPAGENAME}}/Style Guide|Slicer Style Guidelines]]
: Consistency and Readability for a manageable code base
+
 
 +
:Consistency and Readability for a manageable code base
  
 
[[Documentation/{{documentation/version}}/ScriptRepository|Script repository]]
 
[[Documentation/{{documentation/version}}/ScriptRepository|Script repository]]
: Collection of python scripts manipulating various Slicer components.
+
 
 +
:Collection of python scripts manipulating various Slicer components.
  
 
[[Release Details|Change logs and release details]]
 
[[Release Details|Change logs and release details]]
: Informations about Slicer releases
+
 
 +
:Informations about Slicer releases
  
 
[[Resources]]
 
[[Resources]]
: List Slicer resources and who to contact in case of problem.
 
  
 +
:List Slicer resources and who to contact in case of problem.
  
|bgcolor="#CCCCCC"|
+
| bgcolor="#CCCCCC" |
|valign="top"|
+
| valign="top" |
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Build instructions</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Build instructions</span>
Line 75: Line 89:
  
 
[[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Create Slicer extensions]] {{updated}}
 
[[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Create Slicer extensions]] {{updated}}
: Build, test, package and distribute extensions
+
 
 +
:Build, test, package and distribute extensions
  
 
[[Documentation/{{documentation/version}}/Developers/Build Instructions|Build Slicer application]]
 
[[Documentation/{{documentation/version}}/Developers/Build Instructions|Build Slicer application]]
: Compiling and installing Slicer from source.
+
 
 +
:Compiling and installing Slicer from source.
  
 
[[Documentation/{{documentation/version}}/Developers/Build Module|Build Module]]
 
[[Documentation/{{documentation/version}}/Developers/Build Module|Build Module]]
: Compiling slicer modules outside of the slicer source tree.
+
 
 +
:Compiling slicer modules outside of the slicer source tree.
  
 
----
 
----
<span style="color: #555555; font-size: 18px; font-weight: bold;">How-tos</span>&nbsp;&nbsp;[[{{FULLPAGENAME}}/Tutorials|<i class="fa fa-link fa-lg" aria-hidden="true"></i>]]
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">How-tos</span>&nbsp;&nbsp;
 
----
 
----
 
{{:{{FULLPAGENAME}}/Tutorials}}
 
{{:{{FULLPAGENAME}}/Tutorials}}
 
----
 
----
<span style="color: #555555; font-size: 18px; font-weight: bold;">Quick links</span>&nbsp;&nbsp;[[{{FULLPAGENAME}}/Quicklinks|<i class="fa fa-link fa-lg" aria-hidden="true"></i>]]
+
<span style="color: #555555; font-size: 18px; font-weight: bold;">Quick links</span>&nbsp;&nbsp;
 
----
 
----
 
{{:{{FULLPAGENAME}}/Quicklinks}}
 
{{:{{FULLPAGENAME}}/Quicklinks}}
  
|bgcolor="#CCCCCC"|
+
| bgcolor="#CCCCCC" |
|valign="top"|
+
| valign="top" |
 
----
 
----
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Design & Implementation</span>
 
<span style="color: #555555; font-size: 18px; font-weight: bold;">Design & Implementation</span>
Line 99: Line 116:
  
 
[[{{FULLPAGENAME}}/Modules | Modules]]
 
[[{{FULLPAGENAME}}/Modules | Modules]]
: Comparison between the different supported module types
+
 
 +
:Comparison between the different supported module types
  
 
[[{{FULLPAGENAME}}/MRML | Data Model / MRML]]
 
[[{{FULLPAGENAME}}/MRML | Data Model / MRML]]
: Objects and their organization. MRML Library provides API for managing medical image data type
+
 
 +
:Objects and their organization. MRML Library provides API for managing medical image data type
  
 
[[{{FULLPAGENAME}}/Logics | Logics]]
 
[[{{FULLPAGENAME}}/Logics | Logics]]
: Details the role of MRML/Slicer/Application/Modules logics and Displayable managers
+
 
 +
:Details the role of MRML/Slicer/Application/Modules logics and Displayable managers
  
 
[[{{FULLPAGENAME}}/Layouts | Layouts]] {{updated}}
 
[[{{FULLPAGENAME}}/Layouts | Layouts]] {{updated}}
: How to control the layout of the views
+
 
 +
:How to control the layout of the views
  
 
[[{{FULLPAGENAME}}/Slice Orientation Presets | Slice Orientation Presets]] {{new}}
 
[[{{FULLPAGENAME}}/Slice Orientation Presets | Slice Orientation Presets]] {{new}}
: How to manage slice orientation presets
+
 
 +
:How to manage slice orientation presets
  
 
[[{{FULLPAGENAME}}/Slicelets | Slicelets]]
 
[[{{FULLPAGENAME}}/Slicelets | Slicelets]]
: Create simple standalone applications (slicelets)
+
 
 +
:Create simple standalone applications (slicelets)
  
 
[[{{FULLPAGENAME}}/IO | IO Mechanism]]
 
[[{{FULLPAGENAME}}/IO | IO Mechanism]]
: How to read or write nodes from file
+
 
 +
:How to read or write nodes from file
  
 
[[{{FULLPAGENAME}}/Python scripting | Python scripting]]
 
[[{{FULLPAGENAME}}/Python scripting | Python scripting]]
: Presents the underlying infrastructure.
+
 
 +
:Presents the underlying infrastructure.
  
 
[[{{FULLPAGENAME}}/Charts | Charts]]
 
[[{{FULLPAGENAME}}/Charts | Charts]]
: Description of the Charting (jqPlot) architecture.
+
 
 +
:Description of the Charting (jqPlot) architecture.
  
 
[[{{FULLPAGENAME}}/Plots | Plots]] {{new}}
 
[[{{FULLPAGENAME}}/Plots | Plots]] {{new}}
: Description of the Plotting (VTK) architecture.
+
 
 +
:Description of the Plotting (VTK) architecture.
 +
 
 +
[[{{FULLPAGENAME}}/CompressedVideo | Compressed Video]] {{new}}
 +
 
 +
:Description of the compressed video architecture.
  
 
[[{{FULLPAGENAME}}/DirectoryStructure | Directory Structure]]
 
[[{{FULLPAGENAME}}/DirectoryStructure | Directory Structure]]
: Files location in the build and install tree.
+
 
 +
:Files location in the build and install tree.
  
 
[[{{FULLPAGENAME}}/QtPlugins|Qt Plugins]]
 
[[{{FULLPAGENAME}}/QtPlugins|Qt Plugins]]
: How to build and load Qt plugins.
+
 
 +
:How to build and load Qt plugins.
  
 
[[{{FULLPAGENAME}}/Build system | Build system / Release process / Factory description]]
 
[[{{FULLPAGENAME}}/Build system | Build system / Release process / Factory description]]
: Details how Slicer is built and packaged.
+
 
 +
:Details how Slicer is built and packaged.
  
 
[[{{FULLPAGENAME}}/QtTesting | QtTesting]]
 
[[{{FULLPAGENAME}}/QtTesting | QtTesting]]
: Testing framework to test Slicer application. It complements unit tests.
+
 
 +
:Testing framework to test Slicer application. It complements unit tests.
  
 
|}
 
|}
  
<hr>
+
<hr />
  
  
 
[[{{collaborator|logo|slicer4}}|x300px|center]]
 
[[{{collaborator|logo|slicer4}}|x300px|center]]

Latest revision as of 19:52, 14 November 2019

Home < Documentation < Nightly < Developers


New Developers:    Welcome ! Check these instructions !

Getting involved


Start here

New community member checklist

Developer meetings

It is open to everyone, feel free to join.

Discussion Forum

The most effective way to get help from the community

FAQ

Set of common development questions/answers

Resources


Roadmap  UPDATED

What's next ? What's the plan ?

Labs   NEW

Keep track of on-going experiments.

Doxygen

Source code API documentation.

Source code repository

Github or SVN

CDash Quality Dashboard: SlicerStable, SlicerPreview

Nightly, continuous and experimental dashboards. - Setup a dashboard

Bug tracker / Register / Report a problem / Contribute a patch

Web-based bug tracking system - Configuration

Slicer Style Guidelines

Consistency and Readability for a manageable code base

Script repository

Collection of python scripts manipulating various Slicer components.

Change logs and release details

Informations about Slicer releases

Resources

List Slicer resources and who to contact in case of problem.

Build instructions


Create Slicer extensions   UPDATED

Build, test, package and distribute extensions

Build Slicer application

Compiling and installing Slicer from source.

Build Module

Compiling slicer modules outside of the slicer source tree.

How-tos  


Migration Guide

How to update Slicer extension code following breaking changes in Slicer or dependent toolkits (VTK, ITK, Qt, ...)

Source code How-tos

How to checkout the source and contribute patches

Module How-tos

How to create or build modules, how to add or update remote modules

Testing How-tos

How to write tests and manage testing data

Documentation How-tos

How to document module or extension

Extension How-tos

How to contribute, build or package extensions

Misc How-tos

How to setup QtCreator, setup dashboard, work with QtDesigner, port modules

Debugging How-tos

How to debug Slicer, troubleshoot crash or memory leaks

Quick links  


Stable Dashboard
Preview Dashboard
Source
C++ API

Contribute
Style Guide
Issue Tracker

WikiCheatSheet, Wiki Editing Guide

Mailing list archives
FAQ



Design & Implementation


Modules

Comparison between the different supported module types

Data Model / MRML

Objects and their organization. MRML Library provides API for managing medical image data type

Logics

Details the role of MRML/Slicer/Application/Modules logics and Displayable managers

Layouts   UPDATED

How to control the layout of the views

Slice Orientation Presets   NEW

How to manage slice orientation presets

Slicelets

Create simple standalone applications (slicelets)

IO Mechanism

How to read or write nodes from file

Python scripting

Presents the underlying infrastructure.

Charts

Description of the Charting (jqPlot) architecture.

Plots   NEW

Description of the Plotting (VTK) architecture.

Compressed Video   NEW

Description of the compressed video architecture.

Directory Structure

Files location in the build and install tree.

Qt Plugins

How to build and load Qt plugins.

Build system / Release process / Factory description

Details how Slicer is built and packaged.

QtTesting

Testing framework to test Slicer application. It complements unit tests.


Slicer4Announcement-HiRes.png