Topology ToolKit

Please find below detailed instructions for the installation of TTK under MacOS Catalina.

1. Downloading the packages

Please checkout and review our download page and download the following packages:
 · ttk-paraview-v5.9.1.pkg
 · ttk-1.0.0.pkg

2. Installing dependencies with Homebrew

To install TTK's dependencies, we recommand to MacOS users to use the Homebrew package manager. Please checkout Homebrew's installation page to download and install Homebrew.

We will assume in the remainder that you installed Homebrew on your system successfully, under default directories.

To install TTK's and ParaView's dependencies, open a terminal and enter the following commands (omit the $ character):

$ brew cask install xquartz
$ brew install wget libomp mesa glew qt
$ brew install boost graphviz embree

Optionally, the following optional dependency can be installed with pip (if present on the system):
$ python -m pip install scikit-learn

2. ParaView installation

To install TTK's version of ParaView, open a terminal and enter the following command (omit the $ character):

$ sudo installer -pkg ttk-paraview-v5.9.1.pkg -target /

3. TTK installation

To install TTK, open a terminal and enter the following command (omit the $ character):

$ sudo installer -pkg ttk-1.0.0.pkg -target /

4. Setting up environment variables

At this point, for an optimal user experience, we recommend users to define the following environment variables (in particular, when using TTK with python). This can be done by entering the following commands (omit the $ character):

$ echo "export CMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}:$(brew --prefix qt)/lib/cmake:/Applications/lib/cmake/" >> ~/.zshrc
$ echo "export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:/Applications/lib/" >> ~/.zshrc
$ echo "export PATH=${PATH}:/Applications/bin/" >> ~/.zshrc
$ echo "export PV_PLUGIN_PATH=${PV_PLUGIN_PATH}:/Applications/bin/plugins/" >> ~/.zshrc
$ echo "export PYTHONPATH=${PYTHONPATH}:/Applications/lib/python3.8/site-packages/" >> ~/.zshrc
$ source ~/.zshrc

5. Checking your TTK installation

If you applied all the above steps successfully, you can now open a terminal and type the following command to load your TTK-patched ParaView:

$ paraview

At this point, you should see the following TTK startup screen:

On this screen, clicking on the "Example Visualizations" link should bring you to the TTK built-in example screen:

From there, clicking on one of the three buttons should generate one of the following three visualizations:

If this is the case, congratulations!
You have just successfully installed TTK on your 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!