Difference between revisions of "Documentation/4.1/Developers/StartHere"

From Slicer Wiki
Jump to: navigation, search
m
(Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887)
 
(11 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
<noinclude>{{documentation/versioncheck}}</noinclude>
 
{{documentation/{{documentation/version}}/Developers/random-image}}  
 
{{documentation/{{documentation/version}}/Developers/random-image}}  
  
Line 9: Line 10:
 
Multiple types of modules are supported: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|CLI]], [[Documentation/{{documentation/version}}/Developers/Modules#Loadable_Modules|Loadable module]], [[Documentation/{{documentation/version}}/Developers/Modules#Scripted_Modules|Scripted module]] and [[Documentation/{{documentation/version}}/Developers/EditorExtension|Editor effect]]. While the developer has to choose between one of these types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.  
 
Multiple types of modules are supported: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|CLI]], [[Documentation/{{documentation/version}}/Developers/Modules#Loadable_Modules|Loadable module]], [[Documentation/{{documentation/version}}/Developers/Modules#Scripted_Modules|Scripted module]] and [[Documentation/{{documentation/version}}/Developers/EditorExtension|Editor effect]]. While the developer has to choose between one of these types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.  
  
−
These modules can be either built-in or installed on demand via the [[Documentation/{{documentation/version}}/SlicerApplication/ExtensionsManager|extensions manager]].
+
These modules are usually built-in.
 +
 
  
 
__TOC__
 
__TOC__
−
 
  
 
= New community member checklist =
 
= New community member checklist =
  
−
# {{Done}}&nbsp;&nbsp;&nbsp;[http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developer mailing list
+
# {{Done}}&nbsp;&nbsp;&nbsp;[http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list
 
# {{Done}}&nbsp;&nbsp;&nbsp;[http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker
 
# {{Done}}&nbsp;&nbsp;&nbsp;[http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker
 
# {{Done}}&nbsp;&nbsp;&nbsp;Sign-up on [https://github.com/signup/free github] and [https://help.github.com/articles/set-up-git setup Git]
 
# {{Done}}&nbsp;&nbsp;&nbsp;Sign-up on [https://github.com/signup/free github] and [https://help.github.com/articles/set-up-git setup Git]
 
# {{Done}}&nbsp;&nbsp;&nbsp;[https://help.github.com/articles/fork-a-repo Fork] Slicer repository: https://github.com/Slicer/Slicer
 
# {{Done}}&nbsp;&nbsp;&nbsp;[https://help.github.com/articles/fork-a-repo Fork] Slicer repository: https://github.com/Slicer/Slicer
−
# {{Done}}&nbsp;&nbsp;&nbsp;Read the [[Documentation/{{documentation/version}}/Developers/Style Guide|Slicer Style Guidelines]] so that we all understand each other :)
+
# {{Done}}&nbsp;&nbsp;&nbsp;Read the [[Documentation/{{documentation/version}}/Developers/Style Guide|Slicer Coding Style Guidelines]] so that we all understand each other :)
  
−
= Develop a module or an extension =
+
= Develop a module and create an extension =
  
 
<!-- # [[#Add_or_improve_a_functionality:_Where_to_start_.3F|Where to start?]] -->
 
<!-- # [[#Add_or_improve_a_functionality:_Where_to_start_.3F|Where to start?]] -->
Line 29: Line 30:
 
# Create
 
# Create
 
#: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|CLI module]] or
 
#: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|CLI module]] or
−
#: [[Documentation/{{documentation/version}}/Developers/Tutorials/CreateLoadableModule|Loadable module]] or
+
#: [[Documentation/{{documentation/version}}/Developers/Modules#Loadable_Modules|Loadable module]] or
 
#: [[Documentation/{{documentation/version}}/Developers/Modules#Scripted_Modules|Scripted module]] or
 
#: [[Documentation/{{documentation/version}}/Developers/Modules#Scripted_Modules|Scripted module]] or
 
#: [[Documentation/{{documentation/version}}/Developers/EditorExtension|Editor effect]]
 
#: [[Documentation/{{documentation/version}}/Developers/EditorExtension|Editor effect]]
 
# [[Documentation/{{documentation/version}}/HowTo|Read documentation guidelines]]
 
# [[Documentation/{{documentation/version}}/HowTo|Read documentation guidelines]]
−
# Compile [[Documentation/4.1/Developers/Build_Module|slicer modules outside of the slicer source tree]].
+
# [[Documentation/{{documentation/version}}/Developers/Build_Module|Build modules outside of Slicer source tree]].
 
# <code>Hack, hack, hack :)</code>
 
# <code>Hack, hack, hack :)</code>
−
# [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension|Bundle module(s) into a Slicer extension]]
+
# [[Build, test, package and distribute extensions]]
−
# [https://github.com/Slicer/ExtensionsIndex#readme Build, test, package and distribute extensions]
 
  
 
<!--
 
<!--
Line 43: Line 43:
 
[[File:SlicerDeveloper-ContributionWorkflow.png | 1100px]]
 
[[File:SlicerDeveloper-ContributionWorkflow.png | 1100px]]
 
-->
 
-->
 +
 +
= Contribute a patch =
 +
{{:Documentation/{{documentation/version}}/Developers/Tutorials/ContributePatch}}

Latest revision as of 07:30, 14 June 2013

Home < Documentation < 4.1 < Developers < StartHere


For the latest Slicer documentation, visit the read-the-docs.


Application settings dialog
Browse the image gallery

3D Slicer is a free open source extensible software application for medical image computing and visualization. Mainly written in C++ and based on the NA-MIC kit, 3D Slicer relies on a variety of libraries: VTK, ITK, CTK, CMake, Qt and Python.

To ensure the stability of the application, relying on a robust software process, the source code is compiled and tested on a daily basis on a variety of platform configurations. The testing results are summarized and reported using a web-based centralized CDash dashboard. Developers of 3D Slicer can also report issues on the open mailing list or using the web-based bug tracking system.

3D Slicer consists of both a lean application core and modules offering specific functionality. The core implements the user interface, provides support for data input/output (IO) and visualization and also exposes developer interfaces that support extension of the application with new modules.

Multiple types of modules are supported: CLI, Loadable module, Scripted module and Editor effect. While the developer has to choose between one of these types to implement its module, the end user won't notice the difference as they all share the same look & feel. The choice for a given type of module is usually based on the type of inputs/parameters for a given module.

These modules are usually built-in.


New community member checklist

  1. Check.svg   Sign-up on the developers mailing list
  2. Check.svg   Register on the issue tracker
  3. Check.svg   Sign-up on github and setup Git
  4. Check.svg   Fork Slicer repository: https://github.com/Slicer/Slicer
  5. Check.svg   Read the Slicer Coding Style Guidelines so that we all understand each other :)

Develop a module and create an extension

  1. Build Slicer application
  2. Learn about the different type of modules
  3. Create
    CLI module or
    Loadable module or
    Scripted module or
    Editor effect
  4. Read documentation guidelines
  5. Build modules outside of Slicer source tree.
  6. Hack, hack, hack :)
  7. Build, test, package and distribute extensions


Contribute a patch

The following instructions describes the recommended workflow to contribute patch to Slicer code base.

It is also assumed you followed the New community member checklist and have a clone of https://github.com/Slicer/Slicer/.


  • 1. Create an issue in the tracker. For example, see issue #1906
  • 2. Make sure your fork has a git remote. Replace jcfr with your git login.
git remote add jcfr git@github.com:jcfr/Slicer.git
  • 3. Create a topic named <issuer_number>-a-descriptive-topic-name. For example:
git checkout -b 1906-uninstall-extensions-on-restart
  • 4. Add a note to the issue with a link pointing to your topic. For example, see note 1906#c4578
  • 5. Send an email on the slicer-developers list pointing to the reported bug. Title of the email should start with [BUG <IssueNumber>] Title of the bug - <category>
Retrieved from "https://www.slicer.org/w/index.php?title=Documentation/4.1/Developers/StartHere&oldid=32461"