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

From Slicer Wiki
Jump to: navigation, search
Line 23: Line 23:
 
# [[#Add_or_improve_a_functionality:_Where_to_start_.3F|Where to start?]]
 
# [[#Add_or_improve_a_functionality:_Where_to_start_.3F|Where to start?]]
 
# [[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]]
 
# [[Documentation/{{documentation/version}}/Developers/Build_Instructions|Build Slicer application]]
# [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension|Choose an extension project layout]]
+
# [[Documentation/{{documentation/version}}/Developers/Tutorials/BundleModulesIntoExtension|Choose a module/extension project layout]]
 
# 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

Revision as of 06:03, 17 June 2012

Home < Documentation < 4.1 < Developers < StartHere
Shortcuts 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 can be either built-in or installed on demand via the extensions manager.

New community member checklist

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

Develop a module or an extension

  1. Where to start?
  2. Build Slicer application
  3. Choose a module/extension project layout
  4. Create
    CLI module or
    Loadable module or
    Scripted module or
    Editor effect
  5. Build, test, package and distribute extensions

Add or improve a functionality: Where to start ?

SlicerDeveloper-ContributionWorkflow.png