Documentation/4.2/Developers/StartHere - Revision history

UpdateBot: Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

2013-06-14T07:45:38Z

Prepend documentation/versioncheck template. See http://na-mic.org/Mantis/view.php?id=2887

Kikinis: /* Overview */

2012-12-18T13:27:11Z

Overview

Kikinis: /* Overview */

2012-12-18T13:26:13Z

Overview

Kikinis: /* Decisions */

2012-12-18T13:20:35Z

Decisions

Kikinis: /* Decisions */

2012-12-18T13:09:08Z

Decisions

Kikinis: /* New community member checklist */

2012-12-18T12:54:16Z

New community member checklist

UpdateBot: Nightly -> 4.2

2012-10-31T21:59:21Z

Nightly -> 4.2

New page

{{documentation/{{documentation/version}}/Developers/random-image}}

3D Slicer is a free [http://en.wikipedia.org/wiki/Open_source open source] extensible software application for medical image computing and visualization. Mainly written in [http://en.wikipedia.org/wiki/C%2B%2B C++] and based on the [http://www.na-mic.org/Wiki/index.php/NA-MIC-Kit NA-MIC kit], 3D Slicer relies on a variety of libraries: [http://www.vtk.org VTK], [http://itk.org ITK], [http://commontk.org CTK], [http://www.cmake.org CMake], [http://qt.nokia.com/products/ Qt] and [http://www.python.org/ Python].

To ensure the stability of the application, relying on a robust [http://www.kitware.com/solutions/softwareprocess/softwareprocess.html software process], the source code is compiled and tested on a daily basis on a [[Documentation/{{documentation/version}}/SlicerApplication/HardwareConfiguration|variety of platform configurations]]. The testing results are summarized and reported using a web-based centralized CDash [http://slicer.cdash.org/index.php?project=Slicer4 dashboard]. Developers of 3D Slicer can also report issues on the [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel open mailing list] or using the [http://na-mic.org/Mantis/my_view_page.php 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: [[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]].

__TOC__

= New community member checklist =

# {{Done}}   [http://massmail.bwh.harvard.edu/mailman/listinfo/slicer-devel Sign-up] on the developers mailing list
# {{Done}}   [http://na-mic.org/Mantis/signup_page.php Register] on the issue tracker
# {{Done}}   Sign-up on [https://github.com/signup/free github] and [https://help.github.com/articles/set-up-git setup Git]
# {{Done}}   [https://help.github.com/articles/fork-a-repo Fork] Slicer repository: https://github.com/Slicer/Slicer
# {{Done}}   Read the [[Documentation/{{documentation/version}}/Developers/Style Guide|Slicer Style Guidelines]] so that we all understand each other :)

= Develop a module and create an extension =


# Build [[Documentation/{{documentation/version}}/Developers/Build_Instructions|Slicer application]]
# Learn about the [[Documentation/{{documentation/version}}/Developers/Modules|different type of modules]]
# Create
#: [[Documentation/{{documentation/version}}/Developers/Modules#Command_Line_Interface_.28CLI.29|CLI 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/EditorExtension|Editor effect]]
# [[Documentation/{{documentation/version}}/HowTo|Read documentation guidelines]]
# [[Documentation/4.1/Developers/Build_Module|Build modules outside of Slicer source tree]].
# <code>Hack, hack, hack :)</code>
# [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension|Bundle module(s) into a Slicer extension]]
# [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions|Build, test, package and distribute extensions]]



= Contribute a patch =
{{:Documentation/{{documentation/version}}/Developers/Tutorials/ContributePatch}}

← Older revision		Revision as of 07:45, 14 June 2013
Line 1:		Line 1:
		+	<noinclude>{{documentation/versioncheck}}</noinclude>
	{{documentation/{{documentation/version}}/Developers/random-image}}		{{documentation/{{documentation/version}}/Developers/random-image}}

@@ Line 22: / Line 22: @@
 # I would like to develop an extension for 3D Slicer
 ## I program in C++ ==> Go here
 # I would like to use CLI modules to develop processing pipelines ==> Go here
 # I have a CLI module and would like to share it with the world. ==> Go here

← Older revision		Revision as of 13:26, 18 December 2012
Line 18:		Line 18:
	*Slicer has a plug-in architecture. There are different types of plug-ins available. We recommend to begin development work in Slicer by programming a so-called command line interface plug-in also known as CLI plug-in.		*Slicer has a plug-in architecture. There are different types of plug-ins available. We recommend to begin development work in Slicer by programming a so-called command line interface plug-in also known as CLI plug-in.

−	Typically, a development project will begin with a prototype functionality. Depending on the nature of the algorithm, you might consider implementing it as a ITK function, and submit to the Insight journal. An alternate infrastructure for adding new functionality is through programming in Python. By turning this functionality into a CLI plug-in, it becomes possible to use Slicer as a platform for the functionality. Slicer will provide I/O and visualization capabilities, you will provide the new algorithm. Finally, Slicer has infrastructure and support for sharing the functionality with your friends and the world. We call them Extensions. There is a process which will allow you to add your extension to the Slicer extension catalog.	+	Typically, a development project will begin with a prototype functionality. Depending on the nature of the algorithm, you might consider implementing it as a ITK function, and submit to the Insight journal. An alternate infrastructure for adding new functionality is through programming in Python. By turning this functionality into a CLI plug-in, it becomes possible to use Slicer as a platform for the functionality. Slicer will provide I/O and visualization capabilities, you will provide the new algorithm. Finally, Slicer has infrastructure and support for sharing the functionality with your friends and the world. We call them Extensions. There is a process which will allow you to [[Documentation/{{documentation/version}}/Developers/Tutorials/BuildTestPackageDistributeExtensions\|add your extension to the Slicer extension catalog]].

@@ Line 14: / Line 14: @@
 __TOC__
-= Decisions =
+= Overview =
-Slicer has a plug-in architecture. There are different types of plug-ins available. We recommend to begin by programming a so-called command line interface plug-in or CLI plug-in.
 # I would like to develop an extension for 3D Slicer
 ## I program in C++ ==> Go here
 ## I program in Python ==> Go here
 # I would like to use CLI modules to develop processing pipelines ==> Go here
 = ToDo List for joining the Slicer Developer Community =

@@ Line 15: / Line 15: @@
 = Decisions =
 # I would like to develop an extension for 3D Slicer
+## I program in C++ ==> Go here
 = ToDo List for joining the Slicer Developer Community =