-
Notifications
You must be signed in to change notification settings - Fork 17
/
installation-osx-1.2.0.html
346 lines (283 loc) · 15.3 KB
/
installation-osx-1.2.0.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="description" content="The Topology ToolKit">
<meta name="author" content="The Topology ToolKit">
<meta name="keywords" content="TTK, Topology ToolKit, Topological Data
Analysis, Visualization, Reeb graph, Reeb Space, Morse-Smale complex, contour
tree, persistence diagram, persistence curve, continuous scatterplot, fiber
surface, contour forests, jacobi set, mandatory critical points, topological
simplification, VTK, ParaView, Python" />
<title>TTK - the Topology ToolKit - Topological Data Analysis and
Visualization</title>
<!-- Bootstrap Core CSS -->
<link href="vendor/bootstrap/css/bootstrap.min.css" rel="stylesheet">
<!-- Theme CSS -->
<link href="css/clean-blog.min.css" rel="stylesheet">
<!-- Custom Fonts -->
<link href="vendor/font-awesome/css/font-awesome.min.css" rel="stylesheet" type="text/css">
<link href='https://fonts.googleapis.com/css?family=Lora:400,700,400italic,700italic' rel='stylesheet' type='text/css'>
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800' rel='stylesheet' type='text/css'>
<link rel="apple-touch-icon" sizes="180x180" href="apple-touch-icon.png">
<link rel="icon" type="image/png" sizes="32x32" href="favicon-32x32.png">
<link rel="icon" type="image/png" sizes="16x16" href="favicon-16x16.png">
<link rel="manifest" href="site.webmanifest">
<meta name="msapplication-TileColor" content="#da532c">
<meta name="theme-color" content="#ffffff">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
<!-- Google Analytics -->
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'
);
ga('create', 'UA-88087813-1', 'auto');
ga('send', 'pageview');
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
var pluginUrl =
'//www.google-analytics.com/plugins/ga/inpage_linkid.js';
_gaq.push(['_require', 'inpage_linkid', pluginUrl]);
_gaq.push(['_setAccount', 'UA-88087813-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type =
'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl'
: 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(ga, s);
})();
</script>
<!-- End Google Analytics -->
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-default navbar-custom navbar-fixed-top">
<div class="container-fluid">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header page-scroll">
<button type="button" class="navbar-toggle"
data-toggle="collapse" data-target="#bs-example-navbar-collapse-1">
<span class="sr-only">Toggle navigation</span>
Menu <i class="fa fa-bars"></i>
</button>
<a class="navbar-brand" href="index.html">
TTK Home</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling
-->
<div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="examples/index.html" target="new">Examples</a>
</li>
<li>
<a href="tutorials.html">Videos</a>
</li>
<li>
<a href="downloads.html">Downloads</a>
</li>
<li>
<a href="installation.html">Installation</a>
</li>
<li>
<a href="documentation.html">Documentation</a>
</li>
<li>
<a href="events.html">Events</a>
</li>
<li>
<a href="contribute.html">Contribute</a>
</li>
<li>
<a href="contact.html">Contact</a>
</li>
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
</nav>
<!-- Page Header -->
<!-- Set your background image for this header on the line below. -->
<header class="intro-header"
style="background-image: url('img/morseHills.png'">
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
<div class="page-heading">
<h1>Topology ToolKit</h1>
<hr class="small">
<span class="subheading">Installation</span>
</div>
</div>
</div>
</div>
</header>
<!-- Main Content -->
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
Please find below detailed instructions for the
binary installation of TTK under MacOS. These pre-built packages are compiled for <code>x86_64</code> architectures and <code>MacOS 12 (Monterey)</code> using <code>Python 3.11</code>.
<p>
<h3>1. Downloading the packages</h3>
Please checkout and review our <a href="downloads.html" target="new">download page</a> and download the following packages:<br>
· <code>ttk-paraview-v5.11.1.tar.gz</code><br>
· <code>ttk-1.2.0.tar.gz</code><br><br>
<p>
<h3>2. Installing dependencies with Homebrew</h3>
To install TTK's dependencies, we recommand to MacOS users to use the
<a href=https://brew.sh/" target="new">
Homebrew package manager</a>. Please checkout
<a href=https://docs.brew.sh/Installation target="new">
Homebrew's installation page</a> to download and install Homebrew.<br><br>
<!-- When installing Anaconda, please make sure -->
<!-- to perform a system wide installation (<code>All Users (requires admin privileges)</code>) and -->
<!--to check the box <code>Add Python to Environment variables</code> from the installation wizard. If you have already installed Anaconda previously and you do not remember if you checked that box, you will need to make sure to go through our section
<a href="#post-installation">Post-installation</a> at the bottom of this page.<br><br>
We will assume in the remainder that you installed Anaconda on your system successfully, under the directory <code>C:\ProgramData\Anaconda3</code>.
If you have already installed Anaconda previously and you do not remember in which directory you installed it,
you will need to make sure to go through our section
<a href="#post-installation">Post-installation</a> at the bottom of this page.
<br><br>-->
We will assume in the remainder that you installed Homebrew on your system successfully, under default directories.<br><br>
To install TTK's and ParaView's dependencies, open a terminal and enter
the following commands (omit the <code>$</code> character):<br><br>
<code>$ brew cask install xquartz </code><br>
<code>$ brew install wget libomp mesa glew qt</code><br>
<code>$ brew install boost graphviz embree</code><br><br>
<p>
<h3>2. ParaView installation</h3>
Installation by default will place files in <code>/usr/local</code>, however you could install into a different directory and adjust the paths as indicated below. To install TTK's version of ParaView, open a terminal and enter
the following command (omit the <code>$</code> character):<br><br>
<code>$ mkdir ~/ttk-binary</code><br>
<code>$ mv ~/Downloads/ttk-paraview-v5.11.1.tar.gz ~/ttk-binary</code><br>
<code>$ cd ~/ttk-binary</code><br>
<code>$ tar xzvf ttk-paraview-v5.11.1.tar.gz</code><br>
<code>$ sudo cp -r ttk-paraview/* /usr/local</code><br><br>
<p>
<h3>3. TTK installation</h3>
To install TTK, open a terminal and enter
the following command (omit the <code>$</code> character):<br><br>
<code>$ mv ~/Downloads/ttk-1.2.0.tar.gz ~/ttk-binary</code><br>
<code>$ cd ~/ttk-binary</code><br>
<code>$ tar xzvf ttk-1.2.0.tar.gz</code><br>
<code>$ sudo cp -r ttk/* /usr/local</code><br><br>
<p>
<h3>4. Setting up environment variables</h3>
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 <code>$</code> character):<br><br>
<code>$ echo "export CMAKE_PREFIX_PATH=$(brew --prefix qt@5)/lib/cmake:$CMAKE_PREFIX_PATH" >> ~/.zshrc</code><br>
<code>$ echo "export PYTHONPATH=${PYTHONPATH}:/usr/local/lib/python3.11/site-packages/" >> ~/.zshrc</code><br>
<code>$ echo "export PV_PLUGIN_PATH=${PV_PLUGIN_PATH}:/usr/local/lib/plugins/" >> ~/.zshrc</code><br>
<code>$ echo "export DYLD_LIBRARY_PATH=${DYLD_LIBRARY_PATH}:/usr/local/lib" >> ~/.zshrc</code> (this is only necessary if installed somewhere other than <code>/usr/local</code>, changed to your install directory)<br>
<code>$ echo "export PATH=${PATH}:/usr/local/bin/" >> ~/.zshrc</code> (this is only necessary if installed somewhere other than <code>/usr/local</code>, changed to your install directory)<br>
<code>$ source ~/.zshrc</code><br><br>
Optionally, the following optional dependency can be installed with <code>pip</code> (if present on the system):<br>
<code>$ pvpython -m pip install scikit-learn</code>. If pvpython is not found or creates an error, this indicates either your <code>PATH</code> or <code>PYTHONPATH</code> variable is not set correctly.<br><br>
<!-- Note that if you decided to change the default installation path of ParaView and TTK, you will need in the above commands to replace <code>/usr/local</code> by your custom installation path. -->
</p>
<!--<p>
<h3><a name="post-installation"></a>4. Post-installation custom paths</h3>
If you have installed Anaconda, ParaView and TTK into their default directories, you can jump directly to the next section.<br><br>
If you have not installed Anaconda, ParaView or TTK into their default directories, you will need to edit a few environment variables (<code>Control Panel</code>, <code>Edit environment variables for your account</code>).
First, add the following environment variables:
<br>
<code> · CONDA_DIR=[Anaconda custom installation directory]</code><br>
<code> · PV_DIR=[ParaView custom installation directory]</code><br>
<code> · TTK_DIR=[TTK custom installation directory]</code><br><br>
Next, append the following strings to the content of the following environment variables:
<br>
· Add <code>%TTK_DIR%\lib\cmake;%PV_DIR%\lib\cmake</code> to the variable <code>CMAKE_PREFIX_PATH</code><br>
· Add <code>%TTK_DIR%\bin;%PV_DIR%\bin</code> to the variable <code>PATH</code><br>
· Add <code>%TTK_DIR%\bin\plugins</code> to the variable <code>PV_PLUGIN_PATH</code><br>
· Add <code>%CONDA_DIR%\Lib;%TTK_DIR%\bin\Lib\site-packages;%PV_DIR%\bin\Lib\site-packages</code> to the variable <code>PYTHONPATH</code><br>
· Add <code>%CONDA_DIR%\Library\plugins</code> to the variable <code>QT_PLUGIN_PATH</code><br>
-->
<p>
<h3>5. Checking your TTK installation</h3>
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:<br><br>
<code>$ paraview</code><br><br>
If paraview does not load correctly or creates an error, this may indicate either your <code>PATH</code> or <code>DYLD_LIBRARY_PATH</code> variable is not set correctly. Likewise, for the examples tested below, they might reveal issues with the <code>PV_PLUGIN_PATH</code> variable.<br><br>
When executing downloaded packages from the command line, MacOS will likely trigger a security warning. To fix, open System Preferences and switch to the <code>Privacy & Security</code> panel. Under the <code>General</code> tab you should be able to find an option to <code>Allow Anyway</code>.
<!--MacOS users will need to launch the built ParaView
binary from the ParaView source tree and load all the TTK plugins with the
<a href="http://www.paraview.org/Wiki/ParaView/Plugin_HowTo#Using_Plugins"
target="new">ParaView Plugin Manager</a> before continuing.<br>-->
If all works, you should see the following TTK startup screen:<br> <br>
<a href="img/ttkStartup.jpg" target="new">
<img align='center'width="95%" src="img/ttkStartup.jpg">
</a>
<br><br>
On this screen, clicking on the "Example Visualizations" link should bring you
to the TTK built-in example screen:
<br> <br>
<a href="img/ttkExamples.jpg" target="new">
<img align='center'width="95%" src="img/ttkExamples.jpg">
</a>
<br><br>
From there, clicking on one of the three buttons should generate one of the
following three visualizations:<br><br>
<a href="img/gallery/builtinExample1.jpg" target="new">
<img align='center'width="95%" src="img/gallery/builtinExample1.jpg" >
</a>
<br><br>
<a href="img/gallery/builtinExample2.jpg" target="new">
<img align='center'width="95%" src="img/gallery/builtinExample2.jpg" >
</a>
<br><br>
<a href="img/gallery/builtinExample3.jpg" target="new">
<img align='center'width="95%" src="img/gallery/builtinExample3.jpg" >
</a>
<br><br>
If this is the case, congratulations!<br> You have just successfully installed
TTK on your system!</p>
<p>
Now, please visit our <a href="tutorials.html">tutorial</a> 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!
</p>
</div>
</div>
</div>
<hr>
<!-- Footer -->
<footer>
<div class="container">
<div class="row">
<div class="col-lg-8 col-lg-offset-2 col-md-10 col-md-offset-1">
<p class="copyright text-muted">
Contact: <a href="mailto:[email protected]">
[email protected]</a><br>
Updated on Jul. 11, 2023.</p>
</div>
</div>
</div>
</footer>
<!-- jQuery -->
<script src="vendor/jquery/jquery.min.js"></script>
<!-- Bootstrap Core JavaScript -->
<script src="vendor/bootstrap/js/bootstrap.min.js"></script>
<!-- Contact Form JavaScript -->
<script src="js/jqBootstrapValidation.js"></script>
<script src="js/contact_me.js"></script>
<!-- Theme JavaScript -->
<script src="js/clean-blog.min.js"></script>
</body>
</html>