TubeTK/Development: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
Line 1: Line 1:
= Collaborative TubeTK Development =
= Collaborative TubeTK Development =


== View the software over the web ==
<b> Please follow these steps to build and extend TubeTK </b>
 
== 1. View the software over the web ==


* http://gitorious.org/tubetk/
* http://gitorious.org/tubetk/


== 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.   
Line 13: Line 15:
** TBD
** TBD


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


* Read-only access
* Read-only access
Line 22: Line 24:




== Setup your development environment ==
== 4. Setup your development environment ==


* TubeTK development MUST produce a linear history and follow VTK policies
* TubeTK development MUST produce a linear history and follow VTK policies
Line 28: Line 30:
** [[TubeTK/GITCheatSheet | GIT Tips and Tricks]]
** [[TubeTK/GITCheatSheet | GIT Tips and Tricks]]


== Build the toolkit ==
== 5. Build the toolkit ==


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


== Read, learn, and follow the development guidelines ==
== 6. Read, learn, and follow the development guidelines ==


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


== Contribute Code ==
== 7. Read the FAQ ==
 
* [[TubeTK/DevelopersFAQ | Developers FAQ]]
 
== 8. Contribute Code ==


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


== Contribute Dashboard Clients ==
== 9. Contribute Dashboard Clients ==


* [[TubeTK/Dashboards | Dashboard instructions]]
* [[TubeTK/Dashboards | Dashboard instructions]]
== FAQ ==
* [[TubeTK/DevelopersFAQ | Developers FAQ]]


= Inside TubeTK =
= Inside TubeTK =

Revision as of 20:27, 7 November 2010

Collaborative TubeTK Development

Please follow these steps to build and extend TubeTK

1. View the software over the web

2. Check on the status of TubeTK

3. Download the software via git

  • Read-only access
  • 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. Setup your development environment

5. Build the toolkit

6. Read, learn, and follow the development guidelines

7. Read the FAQ

8. Contribute Code

9. Contribute Dashboard Clients

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

TubeTK and Slicer

TubeTK and ImageJ