-
Notifications
You must be signed in to change notification settings - Fork 0
/
BuildingVATES.html
242 lines (205 loc) · 13.3 KB
/
BuildingVATES.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
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Building VATES</title>
<link rel="stylesheet" href="_static/bootstrap-sphinx.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Standards" href="Standards/index.html" />
<link rel="prev" title="Building with CMake" href="BuildingWithCMake.html" />
<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','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-59110517-1', 'auto');
ga('send', 'pageview');
</script>
</head><body>
<div id="navbar" class="navbar navbar-default ">
<div class="container">
<div class="navbar-header">
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".nav-collapse">
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="http://www.mantidproject.org"><img src="_static/Mantid_Logo_Transparent.png">
</a>
<span class="navbar-text navbar-version pull-left"><b>master</b></span>
</div>
<div class="collapse navbar-collapse nav-collapse">
<ul class="nav navbar-nav">
<li class="divider-vertical"></li>
<li><a href="index.html">Home</a></li>
<li><a href="http://download.mantidproject.org">Download</a></li>
<li><a href="http://www.mantidproject.org">Wiki</a></li>
<li><a href="http://docs.mantidproject.org">User Documentation</a></li>
<li><a href="http://www.mantidproject.org/Contact">Contact Us</a></li>
</ul>
<form class="navbar-form navbar-right" action="search.html" method="get">
<div class="form-group">
<input type="text" name="q" class="form-control" placeholder="Search" />
</div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
</div>
<div class="container">
<div class="row">
<div class="body col-md-12 content" role="main">
<div class="section" id="building-vates">
<span id="buildingvates"></span><h1>Building VATES<a class="headerlink" href="#building-vates" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#what-is-the-vsi" id="id1">What Is the VSI?</a></li>
<li><a class="reference internal" href="#how-do-i-get-the-vsi" id="id2">How Do I Get the VSI?</a></li>
<li><a class="reference internal" href="#paraview" id="id3">ParaView</a></li>
<li><a class="reference internal" href="#building-paraview" id="id4">Building ParaView</a></li>
<li><a class="reference internal" href="#building-the-vsi" id="id5">Building the VSI</a><ul>
<li><a class="reference internal" href="#sample-mantid-cmake-command" id="id6">Sample Mantid cmake command</a></li>
<li><a class="reference internal" href="#additional-libraries-for-paraview-mantid" id="id7">Additional Libraries for Paraview/Mantid</a></li>
</ul>
</li>
<li><a class="reference internal" href="#using-paraview-plugins" id="id8">Using Paraview Plugins</a></li>
<li><a class="reference internal" href="#help" id="id9">Help</a></li>
<li><a class="reference internal" href="#troubleshooting" id="id10">Troubleshooting</a></li>
</ul>
</div>
<div class="section" id="what-is-the-vsi">
<h2><a class="toc-backref" href="#id1">What Is the VSI?</a><a class="headerlink" href="#what-is-the-vsi" title="Permalink to this headline">¶</a></h2>
<p>The VSI stands for VATES Simple Interface. This is best thought of as the way to visualise 3D+ dimensional data in Mantid. Mantid stores n dimensional data in MDWorkspaces, which may be rendered using the ParaView visualisation tools.</p>
</div>
<div class="section" id="how-do-i-get-the-vsi">
<h2><a class="toc-backref" href="#id2">How Do I Get the VSI?</a><a class="headerlink" href="#how-do-i-get-the-vsi" title="Permalink to this headline">¶</a></h2>
<p>The VSI components are part of the Mantid distribution.</p>
</div>
<div class="section" id="paraview">
<h2><a class="toc-backref" href="#id3">ParaView</a><a class="headerlink" href="#paraview" title="Permalink to this headline">¶</a></h2>
<p>The visualisation components for the VSI require the ParaView visualisation platform. However, the CMake option <code class="docutils literal notranslate"><span class="pre">MAKE_VATES</span></code>, can be used to turn off its use. The patch files used in this section as well as build scripts for Windows & OSX/Linux which automate the steps described below can be found <a class="reference external" href="https://github.com/mantidproject/paraview-build">here</a>.</p>
<ul class="simple">
<li>Execute the following lines from the command prompt</li>
</ul>
<div class="highlight-sh notranslate"><div class="highlight"><pre>git clone https://gitlab.kitware.com/paraview/paraview.git <Your ParaView <span class="nb">source</span> root>
<span class="nb">cd</span> <Your ParaView <span class="nb">source</span> root>
git checkout v5.4.0
git submodule init
git submodule update
</pre></div>
</div>
<p>The VSI uses a custom data array layout to minimize memory copies. The name and header must be available to ParaView at compile time.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre>mkdir vtkMDHWSignalArray
<span class="nb">cd</span> vtkMDHWSignalArray
wget https://raw.githubusercontent.com/mantidproject/paraview-build/2b28ebc5fd40ad727ca66772522bf220b834c1f7/vtkMDHWSignalArray/vtkMDHWSignalArray.h
<span class="nv">SIGNAL_NAME</span><span class="o">=</span><span class="nv">vtkArrayDispatch_extra_arrays</span><span class="o">=</span>vtkMDHWSignalArray<span class="se">\<</span>double<span class="se">\></span>
<span class="nv">SIGNAL_HEADER</span><span class="o">=</span><span class="nv">vtkArrayDispatch_extra_headers</span><span class="o">=</span><path to vtkMDHWSignalArray.h>
</pre></div>
</div>
<p>Everyone is encouraged to apply the <a class="reference external" href="https://github.com/mantidproject/paraview-build/tree/875fe2a3c800996b75591c8dbe26909b51bdf963/patches">additional patchfiles</a> in our buildscript.</p>
</div>
<div class="section" id="building-paraview">
<h2><a class="toc-backref" href="#id4">Building ParaView</a><a class="headerlink" href="#building-paraview" title="Permalink to this headline">¶</a></h2>
<p>This is the visualisation plugins to build and use. This works on Windows/Linux/Mac. Download the source code and build using CMake out of source. You’ll need the Qt development libraries, in order to build the GUI and also python. For Windows user, the Third_Party directory contains qmake as well as all the development libraries you should need to build Paraview.</p>
<p>The scripts and cmake cache files used by the build servers are available <a class="reference external" href="https://github.com/mantidproject/paraview-build/tree/875fe2a3c800996b75591c8dbe26909b51bdf963">here</a>.</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre><span class="nb">cd</span> <Your paraview <span class="nb">source</span> root>
mkdir Build
<span class="nb">cd</span> Build
cmake -D$SIGNAL_NAME -D$SIGNAL_HEADER -C<path to common.cmake> -C<path to platform specific cache file> ..
cmake --build .
</pre></div>
</div>
</div>
<div class="section" id="building-the-vsi">
<h2><a class="toc-backref" href="#id5">Building the VSI</a><a class="headerlink" href="#building-the-vsi" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Get Paraview (see above)</li>
<li>Edit the CMake configuration for Mantid<ul>
<li>Via CMake enable <code class="docutils literal notranslate"><span class="pre">MAKE_VATES</span></code> (If editing from the GUI, press <code class="docutils literal notranslate"><span class="pre">Configure</span></code> after checking this)</li>
<li>Via CMake set <code class="docutils literal notranslate"><span class="pre">ParaView_DIR</span></code> to the directory where paraview has been built.</li>
</ul>
</li>
<li>Make Mantid</li>
</ul>
<p>This should produce the VSI related binaries for Mantid as well as plugins usable by ParaView.</p>
<div class="section" id="sample-mantid-cmake-command">
<h3><a class="toc-backref" href="#id6">Sample Mantid cmake command</a><a class="headerlink" href="#sample-mantid-cmake-command" title="Permalink to this headline">¶</a></h3>
<p>This build command enables the VSI:</p>
<div class="highlight-sh notranslate"><div class="highlight"><pre>cmake -G Ninja -DCMAKE_BUILD_TYPE<span class="o">=</span>Release -DMAKE_VATES<span class="o">=</span>TRUE -DParaView_DIR<span class="o">=</span>~/Code/paraview/build ../Code/Mantid
cmake --build .
</pre></div>
</div>
</div>
<div class="section" id="additional-libraries-for-paraview-mantid">
<h3><a class="toc-backref" href="#id7">Additional Libraries for Paraview/Mantid</a><a class="headerlink" href="#additional-libraries-for-paraview-mantid" title="Permalink to this headline">¶</a></h3>
<p>Ubuntu: The package list from <a class="reference internal" href="GettingStarted.html#gettingstarted"><span class="std std-ref">Getting Started</span></a> contains all the required libraries.</p>
</div>
</div>
<div class="section" id="using-paraview-plugins">
<h2><a class="toc-backref" href="#id8">Using Paraview Plugins</a><a class="headerlink" href="#using-paraview-plugins" title="Permalink to this headline">¶</a></h2>
<p>This section will be fleshed-out or appear as a separate page in the near future.</p>
<ul class="simple">
<li>Launch the Paraview GUI</li>
<li>Go to Tools -> Manage Plugins and load the MantidParaview… libraries listed above (except for MantidParaViewQtWidgets)</li>
<li>There are several reasons why you may get a warning symbol when you try to load the plugins (see troubleshooting)</li>
<li>Of those loaded plugins, you may wish to expand them using the (+) tree and assigning them as autoload, so that they are immediately available the next time Paraview is launched.</li>
<li>You can now open a sqw file in Paraview.</li>
<li>Use the Rebinning Cutter filter to rebin,integrate,rearrange,slice the workspace.</li>
</ul>
</div>
<div class="section" id="help">
<h2><a class="toc-backref" href="#id9">Help</a><a class="headerlink" href="#help" title="Permalink to this headline">¶</a></h2>
<p>We suggest contacting the core Mantid development team if any problems are experienced.</p>
</div>
<div class="section" id="troubleshooting">
<h2><a class="toc-backref" href="#id10">Troubleshooting</a><a class="headerlink" href="#troubleshooting" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li>Can’t load plugins<ul>
<li>Have you built both Mantid and Paraview to be either Debug or Release (both the same)?</li>
<li>Do you have the Mantid binaries present and in the right order in the system path (windows)?</li>
</ul>
</li>
<li>Can’t start-up Paraview<ul>
<li>Try deleting or temporarily renaming the ParaView directory in <code class="docutils literal notranslate"><span class="pre">%APPDATA/Roaming%</span></code> Paraview may be crashing as it’s trying to autoload plugins that are causing problems.</li>
</ul>
</li>
<li>Cannot complete the loading of a file<ul>
<li>Check you have <code class="docutils literal notranslate"><span class="pre">MANTIDPATH</span></code> set correctly.</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<div class="container">
<ul class="nav navbar-nav" style=" float: right;">
<li>
<a href="BuildingWithCMake.html" title="Previous Chapter: Building with CMake"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm hidden-tablet">« Building with...</span>
</a>
</li>
<li>
<a href="Standards/index.html" title="Next Chapter: Standards"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm hidden-tablet">Standards »</span>
</a>
</li>
<li><a href="#">Back to top</a></li>
</ul>
<p>
</p>
</div>
</footer>
</body>
</html>