TubeTK/Development: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
 
(87 intermediate revisions by 7 users not shown)
Line 1: Line 1:
= Collaborative TubeTK Development =
__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]]'''


== Check on the status of TubeTK ==
| width="800px" align="left" |
= Collaborative TubeTK Development =


* The TubeTK Dashboard reports on the nightly build process of TubeTK. 
<b> Please follow these steps to build and extend TubeTK </b>
** https://www.kitware.com/CDash/index.php?project=TubeTK
** Analytics on dashboard: https://www.google.com/analytics/settings/home#scid=15664873
* Mantis
** TBD


== Download the software via git ==
== 1. View the software over the web ==


* Read-only access
The source code for TubeTK is hosted on GitHub:
** 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


* https://github.com/KitwareMedical/TubeTK


== Setup your development environment ==
== 2. Check on the status of TubeTK ==


* TubeTK development MUST produce a linear history and follow VTK policies
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:
** [[TubeTK/GITConfiguration | REQUIRED Git Configuration]]
* http://open.cdash.org/index.php?project=TubeTK
** [[TubeTK/GITCheatSheet | GIT Tips and Tricks]]


== Build the toolkit ==
== 3. Build the toolkit ==


* [[TubeTK/Build | Build instructions]]
* [[TubeTK/Build Instructions|Build Instructions]]


== Read, learn, and follow the development guidelines ==
== 4. Learn and live the development guidelines ==


* [[TubeTK/DevelopersGuide | Developers guide]]
* [[TubeTK/Developers Guide|Developers Guide]]


== Contribute Code ==
== 5. Contribute Dashboard Clients ==


* [[TubeTK/Design | Design discussions]]
* [[TubeTK/Dashboard Scripts|Dashboard Scripts]]


== Contribute Dashboard Clients ==
== 6. Contribute Code ==


* [[TubeTK/Dashboards | Dashboard instructions]]
* [[TubeTK/Midas Unit Tests|Adding Midas-based Unit Tests]]


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


* [[TubeTK/DevelopersFAQ | Developers FAQ]]
* [[TubeTK/Developers FAQ|Developers FAQ]]


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


* TubeTK uses CMake's Superbuild include other libraries, as needed for the options selected.
*Join the TubeTK email list here: [http://public.kitware.com/cgi-bin/mailman/listinfo/tubetk-developers]
* 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 =
|}
 
== TubeTK and Slicer ==
 
* Slicer
** svn co http://svn.slicer.org/Slicer4/trunk Slicer4
 
== TubeTK and ImageJ ==
 
= Related software =
 
TubeTK is builds upon and contribute back to a variety of open-source efforts, such as the following:


{| border="0" width="75%" cellpadding="20" align="center"
[[Category:TubeTK|Development]]
| 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]
||
|-
|}

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]