Difference between revisions of "Documentation/Nightly/Developers"
From Slicer Wiki
Tag: 2017 source edit |
|||
(15 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<noinclude>{{documentation/versioncheck}}</noinclude> | <noinclude>{{documentation/versioncheck}}</noinclude> | ||
__NOTOC__ | __NOTOC__ | ||
− | {| border="0" align="center" width="98% | + | {| 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>: <big><big>Welcome ! Check these '''[[{{FULLPAGENAME}}/StartHere|instructions]]''' !</big></big> | |<span style="color: #555555; font-size: 18px; font-weight: bold;">New Developers</span>: <big><big>Welcome ! Check these '''[[{{FULLPAGENAME}}/StartHere|instructions]]''' !</big></big> | ||
|} | |} | ||
− | {| border="0" align="center" width="98% | + | {| 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 | ||
<!-- | <!-- | ||
[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 34: | 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 | ||
− | |||
− | [http://slicer.cdash.org/index.php?project=Slicer4 | + | :[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] | ||
− | [ | + | :Nightly, continuous and experimental dashboards. - <small>[[{{FULLPAGENAME}}/Tutorials/DashboardSetup|Setup a dashboard]]</small> |
− | : Web-based bug tracking system - <small>[[Documentation/{{documentation/version}}/Developers/BugTrackerConfiguration|Configuration]]</small> | + | |
+ | [https://issues.slicer.org Bug tracker] / [[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> | ||
[[{{FULLPAGENAME}}/Style Guide|Slicer Style Guidelines]] | [[{{FULLPAGENAME}}/Style Guide|Slicer Style Guidelines]] | ||
− | |||
− | [[Release Details | + | :Consistency and Readability for a manageable code base |
− | : Informations about Slicer releases | + | |
+ | [https://slicer.readthedocs.io/en/latest/developer_guide/script_repository.html Script repository] | ||
+ | |||
+ | :Collection of python scripts manipulating various Slicer components. | ||
+ | |||
+ | [https://github.com/Slicer/Slicer/wiki/Release-Details Change logs and release details] | ||
+ | |||
+ | :Informations about Slicer releases | ||
[[Resources]] | [[Resources]] | ||
− | |||
+ | :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> | ||
---- | ---- | ||
− | [ | + | [https://slicer.readthedocs.io/en/latest/developer_guide/extensions.html Create Slicer extensions] |
− | : Build, test, package and distribute extensions | + | |
+ | :Build, test, package and distribute extensions | ||
+ | |||
+ | [https://slicer.readthedocs.io/en/latest/developer_guide/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> | + | <span style="color: #555555; font-size: 18px; font-weight: bold;">How-tos</span> |
---- | ---- | ||
{{:{{FULLPAGENAME}}/Tutorials}} | {{:{{FULLPAGENAME}}/Tutorials}} | ||
---- | ---- | ||
− | <span style="color: #555555; font-size: 18px; font-weight: bold;">Quick links</span> | + | <span style="color: #555555; font-size: 18px; font-weight: bold;">Quick links</span> |
---- | ---- | ||
{{:{{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 97: | Line 116: | ||
[[{{FULLPAGENAME}}/Modules | Modules]] | [[{{FULLPAGENAME}}/Modules | Modules]] | ||
− | |||
− | [ | + | :Comparison between the different supported module types |
− | : Objects and their organization. MRML Library provides API for managing medical image data type | + | |
+ | [https://slicer.readthedocs.io/en/latest/developer_guide/mrml_overview.html Data Model / MRML] | ||
+ | |||
+ | :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 architecture. | + | |
+ | :Description of the Charting (jqPlot) architecture. | ||
+ | |||
+ | [https://slicer.readthedocs.io/en/latest/developer_guide/modules/plots.html Plots] | ||
+ | |||
+ | :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 08:14, 3 May 2022
Home < Documentation < Nightly < Developers
For the latest Slicer documentation, visit the read-the-docs. |
New Developers: Welcome ! Check these instructions ! |
Getting involved
Resources Roadmap UPDATED
Labs NEW
Source code repository CDash Quality Dashboard: SlicerStable, SlicerPreview
Bug tracker / Report a problem / Contribute a patch
Change logs and release details
|
Build instructions
How-tos
Quick links
|
Design & Implementation
Layouts UPDATED
Compressed Video NEW
Build system / Release process / Factory description
|