Topology ToolKit


Windows Installation
Please find below detailed instructions for the installation of TTK under Windows.

TTK is also supported on other operating systems:
 ·  Linux installation instructions (default target platform);
 ·  MacOS installation instructions.

These specific notes describe the installation procedure for a Windows 10 operating system with Visual Studio 2015 (but the process should be very similar for other versions).

If you are an advanced user and you do not wish to install ParaView (TTK's main user interface), you still have the possibility to install TTK without ParaView support (although we highly recommend to activate it).
In that case, simply download TTK as describded in section 1, install the dependencies as detailed in section 2 and finally, directly jump to section 6 ("Installing TTK").
Examples showing how to use TTK libraries from your own VTK code can be found on this page.

If you are an advanced user and you do not even wish to install VTK, you still have the possibility to install TTK without VTK support (although we highly recommend to activate it).
In that case, simply download TTK as describded in section 1, install the optional dependencies as detailed in section 2 and finally, directly jump to section 6 ("Installing TTK").
Examples showing how to use TTK libraries from your own C++ code can be found on this page.

Most users will want to activate TTK's ParaView support.

The remainder of these notes describe the installation of the version 0.9.7 of TTK along with the version 5.6.0 of ParaView. Other versions of either software packages may require slight variations in the installation procedure. For earlier versions of both software packages, you may want to check out previous versions of our installation notes for Windows:
 ·  TTK 0.9.6 with ParaView 5.5.2.
 ·  TTK 0.9.5 with ParaView 5.5.0.
 ·  TTK 0.9.4 with ParaView 5.4.1.

1. Installing the dependencies

Please install all these applications with default settings and unpack Boost in C:\. Change the environment variable PATH to include the following paths:
 · C:\Program Files\Qt\5.9.3\msvc2015_64\bin
 · C:\Program Files\Python36

Next, create the following environment variables:
 · BOOST_ROOT = C:\boost_1_66_0\
 · Qt5_DIR = C:\Program Files\Qt\5.9.3\msvc2015_64\lib\cmake\Qt5

Optional dependencies

In order to enjoy the complete set of TTK features, we also recommend to install the following, optional dependencies:
 ·  graphviz (for graph drawing features, version 2.40.1 or later).
 ·  scikit-learn for Python3 (for data reduction features, version 0.19.0 or later).
 ·  sqlite (for cinema query features, version 3.24.0 or later);
 ·  ZFP (for advanced compression support, version 0.5.4 or later).
 ·  zlib (for further compression support, version 1.2.11 or later)

2. Building VTK

Now, download the zip archive of ParaView's source tree, version 5.6.0, by following this link and decompress the archive to C:\ (this will create the directory C:\ParaView-v5.6.0).

Next, open the command prompt by pressing Windows+X to open the Power Users menu, and then click on Command Prompt (Admin).

Run the following commands to configure VTK with CMake:
cd ..\..\
cd C:\ParaView-v5.6.0
cd VTK
mkdir build
cd build
cmake-gui ..\

Click on the "Configure" button and select the appropriate generator (in these notes, "Visual Studio 14 2015 Win64" for x64-bit applications). Make sure to set the following variable:
 · CMAKE_CONFIGURATION_TYPES=Release
 · CMAKE_INSTALL_PREFIX=C:/Program Files/VTK/

Click on the "Generate" button. Next, click on the "Open project" button.
Under Visual Studio, make sure to select the target named INSTALL.
Build it and close Visual Studio, CMake and the command prompt.

Change the environment variable PATH to include the path:
 · C:\Program Files\VTK\bin

3. Download TTK

Download TTK's source code archive ttk-0.9.7.zip from the download page and decompress it to C:\.

4. Patching ParaView

In order to enjoy the complete set of TTK features, we recommend at this stage to patch the ParaView source tree. This step is optional. To proceed, go to the patch directory:
cd C:\ttk-0.9.7\paraview\patch

Next, on 64-bit installations, run the following command:
patch-paraview-msvc.cmd C:\ParaView-v5.6.0

Otherwise, for 32-bit installations, run the following command:
patch-paraview-msvc-x86.cmd C:\ParaView-v5.6.0

Finally, run the following command to deploy the complete set of TTK features:
patch-paraview-5.6.0.sh C:\ParaView-v5.6.0
cd ..\..\..

5. Installing ParaView

Run the following commands to configure ParaView with CMake:
cd ParaView-v5.6.0
mkdir build
cd build
cmake-gui ..\

Click on the "Configure" button and select the appropriate generator (in these notes, "Visual Studio 14 2015 Win64" for x64-bit applications). Make sure to set the following variable:
 · CMAKE_CONFIGURATION_TYPES=Release
 · CMAKE_INSTALL_PREFIX=C:/Program Files/ParaView/
 · PARAVIEW_ENABLE_PYTHON=ON

Click on the "Generate" button. Next, click on the "Open project" button.
Under Visual Studio, make sure to select the target named INSTALL.
Build it and close Visual Studio, CMake and the command prompt.

Change the environment variable PATH to include the path:
 · C:\Program Files\ParaView\bin

Next, create the following environment variable:

 · PARAVIEW_BIN = C:\Program Files\ParaView\bin


Optionally, for an advanced Python support in ParaView, Numpy can be installed. For this, open the command prompt by pressing Windows+X to open the Power Users menu, and then click on Command Prompt (Admin) and enter the following command:
pip install numpy

6. Installing TTK

Open the command prompt by pressing Windows+X to open the Power Users menu, and then click on Command Prompt (Admin).

Run the following commands to configure TTK with CMake:
cd ..\..\ttk-0.9.7
mkdir build
cd build
cmake-gui ..\

Click on the "Configure" button and select the appropriate generator (in these notes, "Visual Studio 14 2015 Win64" for x64-bit applications). Make sure to set the following variable:
 · CMAKE_CONFIGURATION_TYPES=Release
 · ParaView_DIR=C:\ParaView-v5.6.0\build
 · TTK_ENABLE_OPENMP=OFF

If you are an advanced user and you do not wish to activate TTK's ParaView support, set the CMake variable TTK_BUILD_PARAVIEW_PLUGINS to OFF. Examples showing how to use TTK libraries from your own VTK code can be found on this page.

If you are an advanced user and you do not even wish to activate TTK's VTK support, set the CMake variables TTK_BUILD_STANDALONE_APPS and TTK_BUILD_VTK_WRAPPERS to OFF. Examples showing how to use TTK libraries from your own C++ code can be found on this page.

Click on the "Generate" button. Next, click on the "Open project" button.
Under Visual Studio, make sure to select the target named INSTALL.
Build it and close Visual Studio and CMake.

If you got to this point without (too many) errors, then congratulations!
You have just successfully installed TTK on your Windows system!

Now, please visit our tutorial page to watch video tutorials showing how to use TTK with ParaView with concrete examples and how to use it from your own Python or C++ code or how to extend TTK by writing up your own module!