TubeTK/Development: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
 
(85 intermediate revisions by 7 users not shown)
Line 1: Line 1:
__NOTITLE__
__NOTOC__
{| border="1" cellpadding="10" cellspacing="0"
|+ [[image:TubeTK_Header.jpg|1000px|link=TubeTK]]
|-
| style="background:#efefef;" align="left" valign="top" width="150px" |
'''[[TubeTK|Home]]'''
*[[TubeTK/About|About]]
*[[TubeTK/Images|Image Gallery]]
*[[TubeTK/Data|Data and Publications]]
<br>
----
<br>
'''For Users'''
* [[TubeTK/Installation|Installation]]
* [[TubeTK/Documentation|Methods & Apps]]
* [[TubeTK/Slicer|TubeTK with 3D Slicer]]
* [[TubeTK/OsiriX|TubeTK with OsiriX]]
<br>
----
<br>
'''For Developers'''
* [[TubeTK/Development|Development Docs]]
<br>
----
<br>
'''[https://github.com/TubeTK/TubeTK/issues Report Bugs<br>Request Features]'''
<br>
<br>
----
<br>
'''[[TubeTK/Contact|Contact Us]]'''
| width="800px" align="left" |
= Collaborative TubeTK Development =
= Collaborative TubeTK Development =


Line 5: Line 41:
== 1. View the software over the web ==
== 1. View the software over the web ==


* http://gitorious.org/tubetk/
The source code for TubeTK is hosted on GitHub:
 
* https://github.com/KitwareMedical/TubeTK


== 2. Check on the status of TubeTK ==
== 2. Check on the status of TubeTK ==


* The TubeTK Dashboard reports on the nightly build process of TubeTK.  
The TubeTK Dashboard reports on the nightly build process of TubeTK. Check this to make sure the current version of TubeTK is compiling and that the relevant tests are passing on your platform:
** https://www.kitware.com/CDash/index.php?project=TubeTK
* http://open.cdash.org/index.php?project=TubeTK
** Analytics on dashboard: https://www.google.com/analytics/settings/home#scid=15664873
* Mantis
** TBD


== 3. Download the software via git ==
== 3. Build the toolkit ==


* Read-only access
* [[TubeTK/Build Instructions|Build Instructions]]
** git clone git://gitorious.org/tubetk/tubetk.git
* Read and write access (assume you have an existing and approved gitorious account)
** git clone git@gitorious.org:tubetk/tubetk.git
** git push git@gitorious.org:tubetk/tubetk.git master


== 4. Learn and live the development guidelines ==


== 4. Setup your development environment ==
* [[TubeTK/Developers Guide|Developers Guide]]


* TubeTK development MUST produce a linear history and follow VTK policies
== 5. Contribute Dashboard Clients ==
** [[TubeTK/GITConfiguration | REQUIRED Git Configuration]]
** [[TubeTK/GITCheatSheet | GIT Tips and Tricks]]


== 5. Build the toolkit ==
* [[TubeTK/Dashboard Scripts|Dashboard Scripts]]


* [[TubeTK/Build | Build instructions]]
== 6. Contribute Code ==


== 6. Read, learn, and follow the development guidelines ==
* [[TubeTK/Midas Unit Tests|Adding Midas-based Unit Tests]]
 
* [[TubeTK/DevelopersGuide | Developers guide]]


== 7. Read the FAQ ==
== 7. Read the FAQ ==


* [[TubeTK/DevelopersFAQ | Developers FAQ]]
* [[TubeTK/Developers FAQ|Developers FAQ]]
 
== 8. Contribute Code ==
 
* [[TubeTK/Design | Design discussions]]
 
== 9. Contribute Dashboard Clients ==
 
* [[TubeTK/Dashboards | Dashboard instructions]]
 
= Inside TubeTK =
 
* TubeTK uses CMake's Superbuild include other libraries, as needed for the options selected.
* Libraries that may be automatically downloaded and included by TubeTK include:
** ITK
** VTK
** Select tools from the NA-MIC Kit:
*** TCLAP, GenerateCLP, ModuleDescriptionParser, RegisterImages
* Libraries that must be externally installed if you want to use them with TubeTK
** CMake (2.8.2 or greater - REQUIRED)
** Qt (4.6.2 or greater - OPTIONAL)


= Using TubeTK =
== 8. Join the Developers' Mailing List ==


== TubeTK and Slicer ==
*Join the TubeTK email list here: [http://public.kitware.com/cgi-bin/mailman/listinfo/tubetk-developers]


* Slicer
|}
** svn co http://svn.slicer.org/Slicer4/trunk Slicer4


== TubeTK and ImageJ ==
[[Category:TubeTK|Development]]

Latest revision as of 16:44, 19 December 2015

__NOTITLE__


TubeTK Header.jpg

Home




For Users




For Developers




Report Bugs
Request Features




Contact Us

Collaborative TubeTK Development

Please follow these steps to build and extend TubeTK

1. View the software over the web

The source code for TubeTK is hosted on GitHub:

2. Check on the status of TubeTK

The TubeTK Dashboard reports on the nightly build process of TubeTK. Check this to make sure the current version of TubeTK is compiling and that the relevant tests are passing on your platform:

3. Build the toolkit

4. Learn and live the development guidelines

5. Contribute Dashboard Clients

6. Contribute Code

7. Read the FAQ

8. Join the Developers' Mailing List

  • Join the TubeTK email list here: [1]