TubeTK/Build Instructions

Recommended Build Procedure

• Install CMake
  • http://cmake.org

Configure the build using CMake

• Create the build directory

cd ~/Projects # assuming that this is where your TubeTK source directory is located
mkdir tubetk-Release

• Run CMake to configure
  • Linux:

cd tubetk-Release
ccmake ../tubetk_source_dir
press 'c' to configure

• • Windows:

run CMake (cmake-gui)
Where is the source code: your TubeTK source directory
Where to build the binaries: your new TubeTK build directory
Press the "Configure" button

• • Confirm the following CMake variables
    • TubeTK_USE_SUPERBUILD should be ON
      • If "ON", then cmake will fetch and compile TCLAP, ModuleDescriptionParser, and GenerateCLP from the Slicer3 svn repository.
    • TubeTK_SUPERBUILD_ITK should be ON
      • If "ON", then cmake will fetch and compile ITK as part of the build process.
      • If "OFF", then you will need to specify the path to ITK-Release in the CMake var ITK_DIR
    • TubeTK_USE_QT should be OFF
      • If you have Qt 4.6.3 or greater installed, you can turn it on.
  • Generate the build files by pressing "generate" in ccmake
  • Perform initial build using your compiler at the top-level of tubetk-Release
  • Subsequent builds should be initiated in the subdir tubetk-Release/TubeTK-Build to save time

Recommended Compilation Options

• For Linux developers (and Linux dashboard machines) we recommend:
  • CMAKE_CXX_FLAGS:STRING=-W -Wall -Wextra -Wshadow -Wno-system-headers -Wwrite-strings -Wno-deprecated -Woverloaded-virtual
  • CMAKE_C_FLAGS:STRING=-W -Wall -Wextra -Wshadow -Wno-system-headers -Wwrite-strings
• A summary of warning options for gcc and g++ are given at:
  • http://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html
  • http://gcc.gnu.org/onlinedocs/gcc-4.3.4/gcc/C_002b_002b-Dialect-Options.html

Inside TubeTK

• As noted above, 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
  • CTK
  • OpenIGTLink
  • 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)
• You can manually install the above toolkits and then configure TubeTK to use those installations instead of building its own copies of those toolkits, BUT we don't recommend heading down that road.
  • Requires CMake expertise
  • Requires making sure each of the toolkits is correctly configured (via their own cmake configuration processes) for use with TubeTK.
  • If you still want to try this complex, manual, unsupported approach, then the following steps will help somewhat:
    1. Read tubetk/SuperBuild.cmake to find out the current set of cmake options required for each library.
    2. For example, at one point in tubetk history, you were required to build ITK v3.20.0, as mirrored and customized on the Slicer github account, using the following cmake vars
       • BUILD_SHARED_LIBS = OFF (or ON, but libs are VERY small in ITK because of templates)
       • ITK_USE_LIBXML2 = ON
       • ITK_USE_REVIEW = ON
       • ITK_USE_OPTIMIZED_REGISTRATION_METHODS = ON
       • ITK_USE_TRANSFORM_IO_FACTORIES = ON
       • CMAKE_CXX_FLAGS = -fPIC
       • CMAKE_C_FLAGS = -fPIC
         • adding -fPIC to both c and cxx flags can be ignored if you build with shared libs ON.
    3. You must also build non-cmake libraries, such as Qt 4.6.2 or greater
       • Tips for installing Open Source Qt to run with Visual Studio
         1. Open a visual studio command shell.
         2. Go to the Qt source directory and run "configure -platform win32-msvc2005". This will tell Qt to prepare itself for being compiled by the Visual Studio compiler. If you use another version of VS than 2005, replace win32-msvc-2005 with the appropriate one.
         3. Type "nmake" and take a break when it compiles.
         4. Add QMAKESPEC=win32-msvc2005 as a system environment variable and add QTDIR=your_dir into the system path. It is done.
       • Tips for installing Qt on Linux
         1. apt-get qt4
    4. After Qt, you must also build the Slicer customized version of VTK v5.6, from the Slicer github account, using the appropriate cmake vars, such as
       • BUILD_SHARED_LIBS = ON
       • VTK_USE_GUISupport = ON
       • VTK_USE_QVTK
    5. Again, many details are missing in the above list. We really recommend using Superbuild instead.

References

• Superbuild and EXTERNAL_PROJECTS
  • Dave Cole's article in the October Kitware Source [1]