TubeTK/Build Instructions: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
 
(122 intermediate revisions by 6 users not shown)
Line 1: Line 1:
There are two ways of building TubeTK:


= Overview =
* (Option 1) Slicer-Dependent Build
* (Option 2) Stand-Alone Build


TubeTK is known to compile on Windows, Macs, and Linux.
If you are going to use TubeTK as a library for building your own C++ programs or for processing data using the command-line or scripts, it is sufficient to build TubeTK as a (Option 2) Stand-Alone Build.


* Process
If you want a graphical user interface (albeit to a limited subset of TubeTK's methods), you should follow the (Option 1) Slicer-Dependent Build instructions.
** Install system-level pre-requisites
** Download source
** Configure using CMake (http://cmake.org)
** Build


= System-level pre-requisites =
= (Option 1) Slicer-Dependent Build =


== Windows ==
It uses a compiled version of Slicer to provide its dependencies. 


* CMake: http://cmake.org/cmake/resources/software.html (Version 2.8.8 or greater)
In this build format,
* Git: http://msysgit.github.com
# TubeTK produces a set of libraries and command-line programs that can be used to process images from the command line and to build other applications.
* SVN: http://tortoisesvn.net
# TubeTK methods are available from within the Slicer application against which it is built.
* Qt: http://qt.nokia.com/downloads


== Macs ==
This build format is tested nightly on Windows, OS X, and Linux machines.


* CMake: http://cmake.org/cmake/resources/software.html
This build format has the following steps:
* Git:
* Install requirements and options
* SVN:
* Download source
* Qt:
* Configure using CMake
* Build


== Linux ==
== Install Requirements and Options ==


TubeTK makes heavy use of ITK, VTK, Git, Qt (optional), and SubversionEach of these packages depends on a variety of system-level packages, many of which are not installed by default on Linux systems.  These dependencies are similar to the dependencies needed to install ParaView. So, the following will install all of the dependencies needed to build VTK and ITK (as needed by ParaView and TubeTK).
=== CMake ===
CMake 3.4 or greater is required.
* The Mac/Windows binaries can be downloaded from [http://cmake.org http://cmake.org]
* The linux installation from source is easiestAssuming an older version of cmake is already installed, and you want to install v3.4.1, do the following:
sudo apt-get build-dep cmake
sudo apt-get install libgtkmm-2.4-dev glade-gtk2 libglademm-2.4-dev
git clone http://github.com:/Kitware/CMake.git
cd CMake
git checkout v3.4.1
cd ..
mkdir CMake-Release
cd CMake-Release
cmake ../CMake -DCMAKE_BUILD_TYPE=Release
make -j8


* CMake: http://cmake.org/cmake/resources/software.html (Version 2.8.8 or greater - current not available via apt-get).
=== Slicer ===


* X11, Git, SVN, Qt
* If you are building the Stand-Alone version of TubeTK, you do not need to build Slicer.


  sudo apt-get build-dep paraview
* If you are building the Slicer-Dependent version of TubeTK, you must build Slicer from source:
  sudo apt-get install git gitk
** Source: http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Instructions
  sudo apt-get install subversion
  sudo apt-get install qt-sdk


== Download the source ==
<b>Notes:</b>
* To address the multiple dependencies required (and optional) for VTK, we recommend installing the build dependencies of ParaView prior to building Slicer:
sudo apt-get build-dep paraview


You have two options:


=== 1. Have CTest do all of the remaining work ===
=== Boost (optional) ===


This is the recommended approach for people who will be using and developing in TubeTK.  It not only builds and tests TubeTK with minimal effort, but it also submits your build as an "experimental" on the TubeTK dashboard - this allows us to more easily help you debug errors during the build process:
Download and build Boost:
* http://www.boost.org/


* Download a ctest configuration file for TubeTK
<b>Notes:</b>
** Windows: [http://tubetk.org/gitweb?p=TubeTK.git;a=blob_plain;f=CMake/DashboardScripts/TubeTK_CDashClient_Windows.cmake;hb=HEAD TubeTK_CDashClient_Windows.cmake]
* Linux: TubeTK creates dynamic libraries that have static links to Boost libraries.  Since Boost static libraries on Linux are not compiled with fPIC, you must compile Boost from source to use it with TubeTK.
** Linux:[http://tubetk.org/gitweb?p=TubeTK.git;a=blob_plain;f=CMake/DashboardScripts/TubeTK_CDashClient_Linux.cmake;hb=HEAD TubeTK_CDashClient_Linux.cmake]
** <code> ./bootstrap.sh <br> </code>
* Edit it to match your environment
** <code> ./bjam -j14 </code>
** Only the variables in the first portion of the file should be edited.  They are clearly marked and self explanatory.
** <code> ./bjam cxxflags=-fPIC cflags=-fPIC -a link=static -j14 </code>
* Run ctest and submit an experimental dashboard
* Mac: if compiling for compatibility with older versions of MacOS, you may need to build boost using the following command:
:<code>ctest -S <name_of_your_script_file.cmake></code>
** <code> ./b2 toolset=clang cxxflags="-stdlib=libstdc++" linkflags="-stdlib=libstdc++" link=static install -a </code>
:This will download the source code, configure it, build it, test it, and then submit the results to the [http://open.cdash.org/index.php?project=TubeTK TubeTK Dashboard]
** Slicer and TubeTK matches its build environment with the environment used to build qmake.  This means that all code build using Slicer and TubeTK must also build using that environment.  So, on some systems you will need to specify stdlib=libstdc++ (for 10.8) or stdlib-libc++ (for 10.9 and beyond).  See the comments starting in line 103 of https://github.com/Slicer/Slicer/blob/master/CMake/SlicerBlockSetCMakeOSXVariables.cmake


=== 2. Download manually via Git ===
== Download Source ==


{| style="width: 100%"
Download the source via git
|-
* <code> git clone https://github.com/KitwareMedical/TubeTK TubeTK </code>
|width=60%|
Clone TubeTK using the commands
|-
|
:<code>$ git clone git://tubetk.org/TubeTK.git</code>
:<code>$ cd TubeTK</code>
|align="center"|
[http://schacon.github.com/git/git-clone.html <code>git help clone</code>]


[[Git/Trouble#Firewall_Blocks_Port_9418|Connection refused]]?
== Configure ==
|}


== Run CMake to configure ==
Create a directory, outside of the source directory, to hold the compilation
* <code> mkdir TubeTK-Release </code>
* <code> cd TubeTK-Release </code>


  cd ~/src/tubetk-Release
Within that compilation directory, run cmake and point it to where the source is located. We recommend using a cmake with a GUI configuration editor.  This is the default on Windows and Mac. On Linux (or from Mac command-line) type:
ccmake ../tubetk
* <code> cmake-gui ../TubeTK </code>
press 'c' to configure
Set CMAKE_BUILD_TYPE to Release
press 'c' to configure again
press 'g' to generate


== Build the code ==
Set the following CMake variables
* TubeTK_USE_SLICER = On
* Slicer_DIR = <Path to your Slicer build directory>
* Linux and Mac only, also set:
** CMAKE_BUILD_TYPE = <same build type as Slicer installation: Debug or Release>


== Build the Code ==
== Build ==


* Open Microsoft Visual Studio
=== Windows ===
* File -> Open -> Project/Solution -> open tubetk-Release/TubeTK.sln
Load the TubeTK solution file in Visual Studio
* <code> Select File -> Open -> Project/Solution -> open TubeTK-Release/TubeTK.sln </code>
** INITIAL BUILD: Perform the initial build using the TubeTK.sln file at the top-level of TubeTK-Release.  This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
** SUBSEQUENT BUILDS: Subsequent builds <b>MUST</b> be initiated using the TubeTK.sln file in the subdir <b>TubeTK-Release/TubeTK-build</b>.  This will build TubeTK only.  You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
* Choose your build type: Release, Debug, etc.  It MUST match the build type chosen for Slicer.
* <code> Right click on the "ALL_BUILD" project and select "Build". </code>


* Perform the initial build using your compiler at the top-level of tubetk-Release.  This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
=== Linux and OS X ===
** Right click on the "ALL_BUILD" project and select "Build".
* INITIAL BUILD: Perform the initial build using your compiler at the top-level of TubeTK-Release.  This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
* Subsequent builds should be initiated in the subdir tubetk-Release/TubeTK-Build to save time.  This will build TubeTK only.  You may have to periodically build from the top-level of tubetk-Release to get updates to the libraries that TubeTK depends on.
** <code> cd TubeTK-Release </code>
** Right click on the "TubeTK" project and select "Build".
** <code> make -j8 </code>
* SUBSEQUENT BUILDS: Subsequent builds <b>MUST</b> be initiated in the subdir TubeTK-Release/TubeTK-build.  This will build TubeTK only.  You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
** <code> cd TubeTK-Release/TubeTK-build </code>
** <code> make -j8 </code>


= Macs =
= (Option 2) Stand-Alone Build =


* X11
In this build format, TubeTK produces a set of libraries and command-line programs that can be used to process images from the command line and to build other applications.
** Install X11 ( Note: Mac OS X 10.7 Lion already ships with X11 )
* git
* svn
* Qt


Launch the X11 terminal to install git, svn and and Qt. Then, follow the steps described in the Linux build section to download, configure and build tubetk in Mac OS X.  During CMake configuration, select "Unix Makefiles" generator. Tubetk has been successively built on Mac OS X 10.7 using gcc 4.2 ( dash5.kitware ).
This build format is tested nightly on Windows, OS X, and Linux machines.


This build format has the following steps:
* Install requirements and options
* Download source
* Configure using CMake
* Build


Perform the initial build using your compiler at the top-level of tubetk-Release.  This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
== Install Requirements and Options ==
mkdir ~/src/TubeTK-Release
cd ~/src/TubeTK-Release
make -j4


Subsequent builds should be initiated in the subdir tubetk-Release/TubeTK-Build to save time.  This will build TubeTK only.  You may have to periodically build from the top-level of tubetk-Release to get updates to the libraries that TubeTK depends on.
=== GIT ===
cd ~/src/tubetk-Release/TubeTK-Build
make -j4


= Advanced =
Install the latest stable release.
* Windows
** http://msysgit.github.io/
* Linux
** <code> sudo apt-get install git </code>
* Mac
** git is included with MacOS


== Using KWStyle ==
=== Qt ===
QT version 4.8.6 or 4.8.7 is REQUIRED.
* Windows
** You will want the 64-bit version of Qt, with WebKIT support.  See details at:
http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Instructions/Prerequisites/Qt#Windows_3
* Linux
** Qt is included with most versions of Linux
* Mac
** Download the installer from
*** http://download.qt.io/archive/qt/4.8/


For introductory information, see: [http://public.kitware.com/KWStyle/ http://public.kitware.com/KWStyle/]
=== CMake ===
  cvs -d :pserver:anoncvs@public.kitware.com:/cvsroot/KWStyle co KWStyle
CMake 3.0 or greater is required.
  mkdir KWStyle-Release
* The Mac/Windows binaries can be downloaded from http://cmake.org
  cd KWStyle-Release
* The linux installation from source is easiest.  Assuming an older version of cmake is already installed, and you want to install v3.4.1, do the following:
  ccmake ../KWStyle
sudo apt-get build-dep cmake
  # Set BUILD_TYPE to Release
sudo apt-get install libgtkmm-2.4-dev glade-gtk2 libglademm-2.4-dev
  # Configure
git clone http://github.com:/Kitware/CMake.git
  # Generate
cd CMake
  make
git checkout v3.4.1
  sudo make install
cd ..
mkdir CMake-Release
cd CMake-Release
cmake ../CMake -DCMAKE_BUILD_TYPE=Release
make -j8


  cd tubetk-Release
=== Boost (optional) ===
  ccmake .
  # Turn on advanced options
  # Turn on TubeTK_USE_KWSTYLE
  # Configure
  # Set KWSTYLE_EXECUTABLE to /usr/local/bin/KWStyle
  # Configure
  # Generate
  make
  make StyleCheck


== Using a pre-existing ITK or VTK installation ==
Download and build Boost:
* http://www.boost.org/


You can configure CMake variables to use an existing ITK or VTK installation instead of its embedded versionsThis is NOT recommended, because of inter-dependencies that require specific version of these libraries, and built using specific options, to be used.
<b>Notes:</b>
* USE_SYSTEM_ITK: OFF
* Linux: TubeTK creates dynamic libraries that have static links to Boost librariesSince Boost static libraries on Linux are not compiled with fPIC, you must compile Boost from source to use it with TubeTK.
** If "ON", then you can tell TubeTK to use an ITK build that is already present on your system (using the CMake variable ITK_DIR). See the warning below.
** <code> ./bootstrap.sh <br> </code>
* USE_SYSTEM_VTK: OFF
** <code> ./bjam -j14 </code>
** If "ON", then you can tell TubeTK to use a VTK build that is already present on your system (using the CMake variable VTK_DIR).  See the warning below.
** <code> ./bjam cxxflags=-fPIC cflags=-fPIC -a link=static -j14 </code>


* Dependencies on ITK and VTK versions and build options
=== Python (optional) ===
** Note that TubeTK relies on ITK and VTK from 3D Slicer (https://github.com/Slicer/ITK and https://github.com/Slicer/VTK, respectively)
** Slicer's repositories for ITK/VTK contain enhancements that have not yet made it into the ITK/VTK repositories themselves.


= Inside TubeTK =
Versions 2.7.x is supported at this time.


* As noted above, TubeTK uses CMake's Superbuild include other libraries, as needed for the options selected.
Download and install per system instructions at:
* Libraries that may be automatically downloaded and included by TubeTK include:
* https://www.python.org/downloads/
** ITK
* Windows
** VTK
** Pre-compiled version of numpy, scipy, etc are available as wheels at:
** CTK
http://www.lfd.uci.edu/~gohlke/pythonlibs/
** Select tools from the NA-MIC Kit:
** Using these wheels is recommended over Anaconda and other installation packages, because they also include and expose versions of Qt (for example) that are incompatible with Slicer and TubeTK.
*** TCLAP, GenerateCLP, ModuleDescriptionParser, RegisterImages
* Linux and Mac
* Libraries that must be externally installed if you want to use them with TubeTK
** Python is already included with most Linux and Mac variants.
** 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:
**# Read tubetk/SuperBuild.cmake to find out the current set of cmake options required for each library.
**# 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.
**# 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
**#*# Open a visual studio command shell.
**#*# 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.
**#*# Type "nmake" and take a break when it compiles.
**#*# 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
**#*# apt-get qt4
**# 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
**# Again, many details are missing in the above list.  We really recommend using Superbuild instead.


= References =
== Download Source ==


* Superbuild and EXTERNAL_PROJECTS
Download the source via git
** Dave Cole's article in the October Kitware Source [http://www.kitware.com/products/archive/kitware_quarterly1009.pdf]
* <code> git clone https://github.com/KitwareMedical/TubeTK TubeTK </code>
 
== Configure ==
 
Before starting the configuration, make sure that you have <code>virtualenv</code> installed ('''Linux Only''').
 
If not, just install it with :
* <code> sudo apt-get install pyton-pip </code>
* <code> pip install virtualenv </code>
 
 
Create a directory, outside of the source directory, to hold the compilation
* <code> mkdir TubeTK-Release </code>
* <code> cd TubeTK-Release </code>
 
Within that compilation directory, run cmake and point it to where the source is located. We recommend using a cmake with a GUI configuration editor.  This is the default on Windows and Mac.  On Linux (or from Mac command-line) type:
* <code> cmake-gui ../TubeTK </code>
 
Linux and Mac only, set the CMake variables:
* CMAKE_BUILD_TYPE = <same build type as Slicer installation: Debug or Release>
 
== Build ==
 
=== Windows ===
Load the TubeTK solution file in Visual Studio
* <code> Select File -> Open -> Project/Solution -> open TubeTK-Release/TubeTK.sln </code>
** Perform the initial build using your compiler at the top-level of TubeTK-Release.  This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
* <code> Right click on the "ALL_BUILD" project and select "Build". </code>
** Subsequent builds should be initiated in the subdir TubeTK-Release/TubeTK-build to save time.  This will build TubeTK only.  You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
*** <code> Right click on the "TubeTK" project and select "Build". </code>
 
=== Linux and OS X ===
Perform the initial build using your compiler at the top-level of TubeTK-Release. This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
* <code> cd $HOME/TubeTK-Release </code>
* <code> make </code>
Subsequent builds should be initiated in the subdir TubeTK-Release/TubeTK-build to save time. This will build TubeTK only.  You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
* <code> cd $HOME/TubeTK-Release/TubeTK-build </code>
* <code> make </code>
 
 
[[Category:TubeTK|Build Instructions]]

Latest revision as of 12:11, 1 November 2016

There are two ways of building TubeTK:

  • (Option 1) Slicer-Dependent Build
  • (Option 2) Stand-Alone Build

If you are going to use TubeTK as a library for building your own C++ programs or for processing data using the command-line or scripts, it is sufficient to build TubeTK as a (Option 2) Stand-Alone Build.

If you want a graphical user interface (albeit to a limited subset of TubeTK's methods), you should follow the (Option 1) Slicer-Dependent Build instructions.

(Option 1) Slicer-Dependent Build

It uses a compiled version of Slicer to provide its dependencies.

In this build format,

  1. TubeTK produces a set of libraries and command-line programs that can be used to process images from the command line and to build other applications.
  2. TubeTK methods are available from within the Slicer application against which it is built.

This build format is tested nightly on Windows, OS X, and Linux machines.

This build format has the following steps:

  • Install requirements and options
  • Download source
  • Configure using CMake
  • Build

Install Requirements and Options

CMake

CMake 3.4 or greater is required.

  • The Mac/Windows binaries can be downloaded from http://cmake.org
  • The linux installation from source is easiest. Assuming an older version of cmake is already installed, and you want to install v3.4.1, do the following:
sudo apt-get build-dep cmake
sudo apt-get install libgtkmm-2.4-dev glade-gtk2 libglademm-2.4-dev
git clone http://github.com:/Kitware/CMake.git
cd CMake
git checkout v3.4.1
cd ..
mkdir CMake-Release
cd CMake-Release
cmake ../CMake -DCMAKE_BUILD_TYPE=Release
make -j8

Slicer

  • If you are building the Stand-Alone version of TubeTK, you do not need to build Slicer.

Notes:

  • To address the multiple dependencies required (and optional) for VTK, we recommend installing the build dependencies of ParaView prior to building Slicer:
sudo apt-get build-dep paraview


Boost (optional)

Download and build Boost:

Notes:

  • Linux: TubeTK creates dynamic libraries that have static links to Boost libraries. Since Boost static libraries on Linux are not compiled with fPIC, you must compile Boost from source to use it with TubeTK.
    • ./bootstrap.sh
    • ./bjam -j14
    • ./bjam cxxflags=-fPIC cflags=-fPIC -a link=static -j14
  • Mac: if compiling for compatibility with older versions of MacOS, you may need to build boost using the following command:
    • ./b2 toolset=clang cxxflags="-stdlib=libstdc++" linkflags="-stdlib=libstdc++" link=static install -a
    • Slicer and TubeTK matches its build environment with the environment used to build qmake. This means that all code build using Slicer and TubeTK must also build using that environment. So, on some systems you will need to specify stdlib=libstdc++ (for 10.8) or stdlib-libc++ (for 10.9 and beyond). See the comments starting in line 103 of https://github.com/Slicer/Slicer/blob/master/CMake/SlicerBlockSetCMakeOSXVariables.cmake

Download Source

Download the source via git

Configure

Create a directory, outside of the source directory, to hold the compilation

  • mkdir TubeTK-Release
  • cd TubeTK-Release

Within that compilation directory, run cmake and point it to where the source is located. We recommend using a cmake with a GUI configuration editor. This is the default on Windows and Mac. On Linux (or from Mac command-line) type:

  • cmake-gui ../TubeTK

Set the following CMake variables

  • TubeTK_USE_SLICER = On
  • Slicer_DIR = <Path to your Slicer build directory>
  • Linux and Mac only, also set:
    • CMAKE_BUILD_TYPE = <same build type as Slicer installation: Debug or Release>

Build

Windows

Load the TubeTK solution file in Visual Studio

  • Select File -> Open -> Project/Solution -> open TubeTK-Release/TubeTK.sln
    • INITIAL BUILD: Perform the initial build using the TubeTK.sln file at the top-level of TubeTK-Release. This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
    • SUBSEQUENT BUILDS: Subsequent builds MUST be initiated using the TubeTK.sln file in the subdir TubeTK-Release/TubeTK-build. This will build TubeTK only. You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
  • Choose your build type: Release, Debug, etc. It MUST match the build type chosen for Slicer.
  • Right click on the "ALL_BUILD" project and select "Build".

Linux and OS X

  • INITIAL BUILD: Perform the initial build using your compiler at the top-level of TubeTK-Release. This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
    • cd TubeTK-Release
    • make -j8
  • SUBSEQUENT BUILDS: Subsequent builds MUST be initiated in the subdir TubeTK-Release/TubeTK-build. This will build TubeTK only. You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
    • cd TubeTK-Release/TubeTK-build
    • make -j8

(Option 2) Stand-Alone Build

In this build format, TubeTK produces a set of libraries and command-line programs that can be used to process images from the command line and to build other applications.

This build format is tested nightly on Windows, OS X, and Linux machines.

This build format has the following steps:

  • Install requirements and options
  • Download source
  • Configure using CMake
  • Build

Install Requirements and Options

GIT

Install the latest stable release.

Qt

QT version 4.8.6 or 4.8.7 is REQUIRED.

  • Windows
    • You will want the 64-bit version of Qt, with WebKIT support. See details at:

http://www.slicer.org/slicerWiki/index.php/Documentation/Nightly/Developers/Build_Instructions/Prerequisites/Qt#Windows_3

CMake

CMake 3.0 or greater is required.

  • The Mac/Windows binaries can be downloaded from http://cmake.org
  • The linux installation from source is easiest. Assuming an older version of cmake is already installed, and you want to install v3.4.1, do the following:
sudo apt-get build-dep cmake
sudo apt-get install libgtkmm-2.4-dev glade-gtk2 libglademm-2.4-dev
git clone http://github.com:/Kitware/CMake.git
cd CMake
git checkout v3.4.1
cd ..
mkdir CMake-Release
cd CMake-Release
cmake ../CMake -DCMAKE_BUILD_TYPE=Release
make -j8

Boost (optional)

Download and build Boost:

Notes:

  • Linux: TubeTK creates dynamic libraries that have static links to Boost libraries. Since Boost static libraries on Linux are not compiled with fPIC, you must compile Boost from source to use it with TubeTK.
    • ./bootstrap.sh
    • ./bjam -j14
    • ./bjam cxxflags=-fPIC cflags=-fPIC -a link=static -j14

Python (optional)

Versions 2.7.x is supported at this time.

Download and install per system instructions at:

http://www.lfd.uci.edu/~gohlke/pythonlibs/

    • Using these wheels is recommended over Anaconda and other installation packages, because they also include and expose versions of Qt (for example) that are incompatible with Slicer and TubeTK.
  • Linux and Mac
    • Python is already included with most Linux and Mac variants.

Download Source

Download the source via git

Configure

Before starting the configuration, make sure that you have virtualenv installed (Linux Only).

If not, just install it with :

  • sudo apt-get install pyton-pip
  • pip install virtualenv


Create a directory, outside of the source directory, to hold the compilation

  • mkdir TubeTK-Release
  • cd TubeTK-Release

Within that compilation directory, run cmake and point it to where the source is located. We recommend using a cmake with a GUI configuration editor. This is the default on Windows and Mac. On Linux (or from Mac command-line) type:

  • cmake-gui ../TubeTK

Linux and Mac only, set the CMake variables:

  • CMAKE_BUILD_TYPE = <same build type as Slicer installation: Debug or Release>

Build

Windows

Load the TubeTK solution file in Visual Studio

  • Select File -> Open -> Project/Solution -> open TubeTK-Release/TubeTK.sln
    • Perform the initial build using your compiler at the top-level of TubeTK-Release. This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.
  • Right click on the "ALL_BUILD" project and select "Build".
    • Subsequent builds should be initiated in the subdir TubeTK-Release/TubeTK-build to save time. This will build TubeTK only. You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.
      • Right click on the "TubeTK" project and select "Build".

Linux and OS X

Perform the initial build using your compiler at the top-level of TubeTK-Release. This will update and build the libraries that TubeTK depends on (ex. VTK, ITK), and then build TubeTK.

  • cd $HOME/TubeTK-Release
  • make

Subsequent builds should be initiated in the subdir TubeTK-Release/TubeTK-build to save time. This will build TubeTK only. You may have to periodically build from the top-level of TubeTK-Release to get updates to the libraries that TubeTK depends on.

  • cd $HOME/TubeTK-Release/TubeTK-build
  • make