TubeTK/Development: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
 
(88 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= TubeTK's Collaborative Software Development Tools =
__NOTITLE__
__NOTOC__


== View the software over the web ==
{| border="1" cellpadding="10" cellspacing="0"
|+ [[image:TubeTK_Header.jpg|1000px|link=TubeTK]]
|-
| style="background:#efefef;" align="left" valign="top" width="150px" |


* http://gitorious.org/tubetk/
'''[[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]]'''


== Download the software via git ==
| width="800px" align="left" |
= Collaborative TubeTK Development =


* Read-only access
<b> Please follow these steps to build and extend TubeTK </b>
** 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


== Check on the status of TubeTK ==
== 1. View the software over the web ==


* The TubeTK Dashboard reports on the nightly build process of TubeTK. 
The source code for TubeTK is hosted on GitHub:
** https://www.kitware.com/CDash/index.php?project=TubeTK
** Analytics on dashboard: https://www.google.com/analytics/settings/home#scid=15664873
* Mantis
** TBD


== View the reference pages ==
* https://github.com/KitwareMedical/TubeTK


* Doxygen
== 2. Check on the status of TubeTK ==
** TBD


= TubeTK's Development Documentation =
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:
* http://open.cdash.org/index.php?project=TubeTK


== Setting up your TubeTK Development Environment ==
== 3. Build the toolkit ==


* TubeTK development MUST produce a linear history and follow VTK policies
* [[TubeTK/Build Instructions|Build Instructions]]
** [[TubeTK/GITConfiguration | REQUIRED Git Configuration]]
** [[TubeTK/GITCheatSheet | GIT Tips and Tricks]]


== TubeTK Development Documentation ==
== 4. Learn and live the development guidelines ==


* [[TubeTK/Design | Design discussions]]
* [[TubeTK/Developers Guide|Developers Guide]]
* [[TubeTK/Build | Build instructions]]
* [[TubeTK/Dashboards | Dashboard instructions]]
* [[TubeTK/DevelopersGuide | Developers guide]]
* [[TubeTK/DevelopersFAQ | Developers FAQ]]


= Inside TubeTK =
== 5. Contribute Dashboard Clients ==


* TubeTK uses CMake's Superbuild include other libraries, as needed for the options selected.
* [[TubeTK/Dashboard Scripts|Dashboard Scripts]]
* 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 =
== 6. Contribute Code ==


== TubeTK and Slicer ==
* [[TubeTK/Midas Unit Tests|Adding Midas-based Unit Tests]]


* Slicer
== 7. Read the FAQ ==
** svn co http://svn.slicer.org/Slicer4/trunk Slicer4


== TubeTK and ImageJ ==
* [[TubeTK/Developers FAQ|Developers FAQ]]


= Related software =
== 8. Join the Developers' Mailing List ==


TubeTK is builds upon and contribute back to a variety of open-source efforts, such as the following:
*Join the TubeTK email list here: [http://public.kitware.com/cgi-bin/mailman/listinfo/tubetk-developers]


{| border="0" width="75%" cellpadding="20" align="center"
| align="center" | [[image:NeuralNav-ITKLogo.jpg|100px]] [http://www.itk.org <br> ITK]
| align="center" | [[image:NeuralNav-SlicerLogo.jpg|100px]] [http://www.slicer.org <br> Slicer]
| align="center" | [[image:NeuralNav-CTKLogo.jpg|100px]] [http://www.commontk.org <br> CTK]
|-
| align="center" | [[image:NeuralNav-CMakeLogo.jpg|100px]] [http://www.cmake.org <br> CMake]
| align="center" | [[image:NeuralNav-CDashLogo.jpg|100px]] [http://www.cdash.org <br> CDash]
| align="center" | [[image:NeuralNav-MIDASLogo.jpg|100px]] [http://www.insight-journal.org/midas <br> MIDAS]
||
|-
|}
|}
[[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]