forked from SimVascular/simvascular.github.io-archive
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocsInstallation.html
More file actions
455 lines (344 loc) · 19.9 KB
/
docsInstallation.html
File metadata and controls
455 lines (344 loc) · 19.9 KB
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
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<!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="">
<meta name="author" content="">
<title>SimVascular Docs</title>
<link href="css/bootstrap.css" rel="stylesheet" type="text/css" />
<link href="css/shop-item.css" rel="stylesheet" type="text/css" />
<link href="css/codestyle.css" rel="stylesheet" type="text/css" />
<link rel="stylesheet" href="font-awesome-4.1.0/css/font-awesome.min.css">
<link rel="stylesheet" href="https://code.ionicframework.com/ionicons/1.5.2/css/ionicons.min.css">
<link rel="shortcut icon" href="img/favicon.ico">
<!-- 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]-->
</head>
<body>
<!-- Navigation -->
<nav class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<!-- Brand and toggle get grouped for better mobile display -->
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-main-collapse">
<i class="fa fa-bars" id="barIcon"></i>
</button>
<a class="navbar-brand" id="brandName" href="index.html">
<img src="img/svlogo/svLogoSmallText.png" alt="...">
</a>
</div>
<!-- Collect the nav links, forms, and other content for toggling -->
<div class="collapse navbar-collapse navbar-right navbar-main-collapse">
<ul class="nav navbar-nav">
<!-- USER GUIDES -->
<li>
<a href="#" id="dropdownMenu1" data-toggle="dropdown">
<b><span class="fa fa-user"></span> User Guides</b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenu1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsInstallation.html"><b><span class="fa fa-sign-in fa-rotate-90"></span> Installation</b></a></li>
<li role="presentation" class="divider"></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsQuickGuide.html"><b><span class="icon ion-ios7-bolt"></span> Quick Guide</b></a></li>
<li role="presentation" class="divider"></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsModelGuide.html"><b><span class="icon ion-settings"></span> Modeling</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsMeshing.html"><b><span class="icon ion-ios7-keypad"></span> Meshing</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsFlowSolver.html"><b><span class="icon ion-play"></span> Simulation</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docssvFSI.html"><b><span class="icon ion-plus-round"></span> svFSI</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsROMSimulation.html"><b><span class="icon ion-plus-round"></span> ROM Simulation</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsGenBC.html"><b><span class="icon ion-refresh"></span> GenBC</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsPythonInterface.html"><b><span class="icon ion-refresh"></span> Python Interface</b></a></li>
</ul>
</li>
<!-- CLINCAL CASES -->
<li>
<a href="#" id="dropdownMenu1" data-toggle="dropdown">
<b><i class="fa fa-stethoscope"></i> Clinical Cases</b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenu1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="clinicalCase3.html"><b><span class="fa fa-user-md"></span> Coronary Normal</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="clinicalCase1.html"><b><span class="fa fa-user-md"></span> Aortofemoral Normal - 1</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="clinicalCase2.html"><b><span class="fa fa-user-md"></span> Aortofemoral Normal - 2</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="clinicalCase4.html"><b><span class="fa fa-user-md"></span> Healthy Pulmonary</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://simtk.org/projects/sv_tests"><b><span class="fa fa-user-md"></span> All demo projects</b></a></li>
</ul>
</li>
<!-- DEVELOPER GUIDES -->
<li>
<a href="#" id="dropdownMenu1" data-toggle="dropdown">
<b><span class="fa fa-caret-square-o-right"></span> Developer Guides</b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenu1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="docsCompile.html"><b><span class="fa fa-file-text-o"></span> Compile Source Code</b></a></li>
</ul>
</li>
<!-- svCOMMUNITY -->
<li>
<a href="#" id="dropdownMenu1" data-toggle="dropdown">
<b><i class="fa fa-users"></i> svCommunity</b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenu1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://simtk.org/forums/viewforum.php?f=188"><b><span class="fa fa-users"></span> Public Forum</b></a></li>
<li role="presentation" class="divider"></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://simtk.org/mailman/listinfo/simvascular-news"><b><span class="fa fa-sign-in"></span> Join News Mailing List</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://simtk.org/pipermail/simvascular-news/"><b><span class="fa fa-pencil-square-o"></span> News Mailing List Archive</b></a></li>
<li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/SimVascular/SimVascular/issues"><b><span class="fa fa-bug"></span> Report bugs and request features</b></a></li>
</ul>
</li>
<!-- REFERENCES -->
<li>
<a href="docsRefs.html" id="dropdownMenu1" >
<b><span class="icon ion-document-text"></span>References</b>
</a>
</li>
<!-- Archives -->
<li>
<a href="#" id="dropdownMenu1" data-toggle="dropdown">
<b> Archives</b>
</a>
<ul class="dropdown-menu" role="menu" aria-labelledby="dropdownMenu1">
<li role="presentation"><a role="menuitem" tabindex="-1" href="archiveQuickGuideSV2.html"><b>SimVascular 2.0</b></a></li>
</ul>
</li>
<!-- <li><a href="docsQuickGuide.html" id="btnQuickGuide"><b><span class="icon ion-ios7-bolt"></span> Quick Guide</b></a></li>
<li><a href="docsModelGuide.html" id="btnModelGuide"><b><span class="icon ion-settings"></span> Modeling</b></a></li>
<li><a href="docsMeshing.html" id="btnMeshing"><b><span class="icon ion-ios7-keypad"></span> Meshing</b></a></li>
<li><a href="docsPresolver.html" id="btnPresolver"><b><span class="icon ion-log-in"></span> svPre</b></a></li>
<li><a href="docsFlowSolver.html" id="btnFlowSolver"><b><span class="icon ion-play"></span> svSolver</b></a></li>
<li><a href="docsRefs.html" id="btnRefs"><b><span class="icon ion-document-text"></span> References</b></a></li>
<li><a href="clinicalCase1.html" id="btnRefs"><b>Case Studies</b></a></li> -->
</ul>
</div>
<!-- /.navbar-collapse -->
</div>
<!-- /.container -->
</nav>
<!-- Page Content -->
<!--Nav Bar -->
<div class="row">
<div class="col-xs-1 col-sm-1 hidden-md hidden-lg">
</div>
<!-- ONE COLUMN OF SPACE -->
<nav class="hidden-xs hidden-sm col-md-2 col-lg-2 bs-docs-sidebar">
<ul id="sidebar" class="nav nav-stacked fixed manInstallation"> <!--Nav Bar -->
<p><h3>Installation</h3></p>
<li><a href="#installationDownload">Download</a></li>
<li><a href="#installationWindows">Windows</a></li>
<li><a href="#installationMac">Mac</a>
<li><a href="#installationLinux">Linux</a>
</ul>
</nav>
<!--Main Content -->
<div class="col-xs-10 col-sm-10 col-md-9 col-lg-9" id="manualContent">
<!-- ACTUAL CONTENT -->
<div class="manInstallation"><section id="installationDownload" class="group"><h1>Downloading SimVascular</h1>
<ol>
<li><p>Go to <a href="https://simtk.org/project/xml/downloads.xml?group_id=188" target="_blank">SimVascular download webpage</a>.</p></li>
<li><p>Login to SimTK. If you don’t have a SimTK account you will need to create one.</p></li>
<li><p>From the SimVascular <strong>Download links</strong> menu select the installer for your operating system and version.</p></li>
<li><p>List your intended use for the software and agree to the license agreement.</p></li>
<li><p>You may also download <strong>svSolver</strong> and <strong>svFSI</strong> solvers from this same web page.</p></li>
</ol>
<p>Note: SimVascular is not guaranteed to work if installed on operating system versions not listed in the <strong>Download links</strong> menu.</p>
</section>
<section id="installationWindows" class="group"><h1>Installation Instructions for Windows</h1>
<p><br></p>
<h3>Supported Versions</h3>
<pre class="highlight plaintext"><code>Windows 10 64-bit
</code></pre>
<p><br></p>
<h3>Installing SimVascular</h3>
<ol>
<li>Download the SimVascular Windows installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>.</li>
</ol>
<p><br></p>
<h3>Installing svSolver</h3>
<ol>
<li><p>Download the svSolver Windows installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>.</p></li>
<li><p>The solver is installed at C:\Program Files\SimVascular\svSolver\yyyy-mm-dd.</p></li>
</ol>
</section>
<section id="installationMac" class="group"><h1>Installation Instructions for Apple OS X</h1>
<p><br></p>
<h3>Supported Versions</h3>
<p>Mac OS X versions 10.11 or higher.</p>
<pre class="highlight plaintext"><code>SimVascular is compiled on MacOS 10.11 and should be compatible with newer versions of MacOS.
</code></pre>
<p><br></p>
<h3>Installing SimVascular</h3>
<ol>
<li><p>Download the SimVascular MacOS installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>.</p></li>
<li><p>Double-click on the downloaded installation (.dmg) file.</p></li>
<li><p>Agree to the terms of service.</p></li>
<li><p>Drag the SimVascular application to the Applications folder.</p>
<figure>
<img class="svImg svImgXl" src="documentation/installation/imgs/macDrag.png">
<figcaption class="svCaption" ></figcaption>
</figure></li>
<li><p>Launch SimVascular through your Applications folder or Launchpad.</p>
<pre class="highlight plaintext"><code>SimVascular is not a registered app with Apple so when you open it a warning dialog is displayed stating “SimVascular can’t be opened because it is from an unidentified developer.”. You can then open SimVascular by going to 'System Preferences>Security & Privacy>General' and click on “Open Anyway”.
</code></pre></li>
<li><p>Setup SimVascular to run from a terminal. (optional)</p>
<pre class="highlight plaintext"><code>sudo /Applications/SimVascular.app/Contents/Resources/setup-symlinks.sh
This creates a script called 'simvascular' in /usr/local/bin/ that can be executed from the command line.
</code></pre></li>
</ol>
<p><br></p>
<h3>Installing svSolver</h3>
<ol>
<li><p>Download the svSolver MacOS installer.</p></li>
<li><p>Double-click on the downloaded installation (.pkg) file.</p></li>
<li><p>Follow the instructions.</p></li>
<li><p>The solver is installed in /usr/local/sv/svsolver/yyyy-mm-dd</p></li>
</ol>
<h3>Installing MPI</h3>
<pre class="highlight plaintext"><code>svSolver uses MPICH implementation of MPI. To install MPI type the follow command in a terminal window
brew install mpich2
Note that some applications may install a different implementation (e.g. Open MPI) of MPI. This may interfere with the MPI version needed by the svSolver or cause the solver not to execute correctly.
</code></pre>
</section>
<section id="installationLinux" class="group"><h1>Installation Instructions for Linux</h1>
<p><br></p>
<h3>Supported Versions</h3>
<p>Ubuntu 14.04</p>
<pre class="highlight plaintext"><code>SimVascular requires a newer version of GLIBCXX than is shipped with Ubuntu 14.
</code></pre>
<p>Ubuntu 16.04 and 18.04</p>
<pre class="highlight plaintext"><code>No system updates should be required.
</code></pre>
<p>Red Hat 7 / CentOS 7</p>
<pre class="highlight plaintext"><code>Red Hat 7 releases are considered alpha with very limited testing.
CentOS 7 requires an updated compiler.
</code></pre>
<p><br></p>
<h3>Installing SimVascular on Ubuntu 14.04</h3>
<ol>
<li><p>Download the SimVascular Ubuntu installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>. </p></li>
<li><p>Double-click on the downloaded installation (.deb) file.</p>
<pre class="highlight plaintext"><code>SimVascular is installed in /usr/local/sv/simvascular/yyyy-mm-dd, where yyyy-mm-dd represents the SimVascular release date (e.g. 2018-11-25).
</code></pre></li>
<li><p>Install the gcc-4.9 compiler to get a newer version of GLIBCXX.</p>
<pre class="highlight plaintext"><code>% sudo add-apt-repository ppa:ubuntu-toolchain-r/test
% sudo apt-get update
% sudo apt-get install gcc-4.9 g++-4.9
</code></pre></li>
<li><p>To launch SimVascular:</p>
<pre class="highlight plaintext"><code>Go to Unity Dash and search for "SimVascular"
Click the SimVascular icon.
</code></pre></li>
<li><p>Setup SimVascular to run from a terminal. (optional)</p>
<pre class="highlight plaintext"><code>sudo bash /usr/local/sv/simvascular/yyyy-mm-dd/setup-symlinks.sh
This creates a script called 'simvascular' in /usr/local/bin/ that can be executed from the command line.
</code></pre></li>
</ol>
<h3>Installing SimVascular on Ubuntu 16.04 and 18.04</h3>
<ol>
<li><p>Download the SimVascular Ubuntu installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>. </p></li>
<li><p>Double-click on the downloaded installation (.deb) file.</p>
<pre class="highlight plaintext"><code>SimVascular is installed in /usr/local/sv/simvascular/yyyy-mm-dd, where yyyy-mm-dd represents the SimVascular release date (e.g. 2018-11-25).
</code></pre></li>
<li><p>To launch SimVascular:</p>
<pre class="highlight plaintext"><code>Go to Unity Dash and search for "SimVascular"
Click the SimVascular icon.
</code></pre></li>
<li><p>Setup SimVascular to run from a terminal. (optional)</p>
<pre class="highlight plaintext"><code>sudo bash /usr/local/sv/simvascular/yyyy-mm-dd/setup-symlinks.sh
This creates a script called 'simvascular' in /usr/local/bin/ that can be executed from the command line.
</code></pre></li>
</ol>
<h3>Installing SimVascular on CentOS 7</h3>
<ol>
<li><p>Download the SimVascular CentOS installer from <a href="https://simtk.org/frs/index.php?group_id=188">SimTK</a>. </p>
<pre class="highlight plaintext"><code>The intaller is a .tar.gz file that is manually installed.
</code></pre></li>
<li><p>Create a /usr/local/package directory if it does not already exist.</p>
<pre class="highlight plaintext"><code>% su root
% cd /usr/local
% mkdir package
</code></pre></li>
<li><p>Untar the contents of the installer .tar.gz file to the SimVascular application directory.</p>
<pre class="highlight plaintext"><code>% tar xzvf ~/Downloads/SimVascular-centos7-x64.Nov.25-2018.tar.gz
SimVascular is installed in /usr/local/package/simvascular/2018-11-25
</code></pre></li>
<li><p>Execute a shell script to setup SimVascular to run from the command line.</p>
<pre class="highlight plaintext"><code>% /usr/local/package/simvascular/2018-11-25/post-install.sh
This creates a 'simvascular' script file in /usr/local/bin.
</code></pre></li>
<li><p>Launch SimVascular </p>
<pre class="highlight plaintext"><code>% simvascular
</code></pre></li>
</ol>
<p><br></p>
<h4>Note</h4>
<pre class="highlight plaintext"><code>SimVascular may fail to launch if certain shared libraries are missing from your computer. Missing libraries can be installed using "sudo apt-get install [missing lib name]". The following commands can be used to install some libraries commonly missing from standard Ubuntu distributions:
sudo apt-get install libgstreamer0.10-0
sudo apt-get install libgstreamer-plugins-base0.10-dev
sudo apt-get install libxss
sudo apt-get install libxmu-dev (for OpenCASCADE)
sudo apt-get install libxi-dev (for OpenCASCADE)
</code></pre>
<p><br></p>
<h3>Installing svSolver</h3>
<ol>
<li><p>Download the svSolver Ubuntu installer.</p></li>
<li><p>Double-click on the downloaded installation (.deb) file.</p></li>
<li><p>The solver is installed in /usr/local/sv/svsolver/yyyy-mm-dd</p></li>
</ol>
<h3>Installing svFSI</h3>
<ol>
<li><p>Download the svFSI Ubuntu installer.</p></li>
<li><p>Double-click on the downloaded installation (.deb) file.</p></li>
<li><p>The solver is installed in /usr/local/sv/svfsi/yyyy-mm-dd</p></li>
</ol>
<h3>Installing MPI</h3>
<pre class="highlight plaintext"><code>Both svSolver and svFSI use MPI.
For Ubuntu 14:
sudo apt-get install libmpich2-dev
For Ubuntu 16:
sudo apt-get install libmpich-dev
Note that some applications may install a different implementation (e.g. Open MPI) of MPI. This may interfere with the MPI version needed by the svSolver or cause the solver not to execute correctly.
</code></pre>
<p><br>
<br>
<br></p>
</section>
</div>
</div>
</div>
<!-- /.container -->
<nav class="navbar navbar-default navbar-fixed-bottom">
<div class="container-fluid text-center">
<ul class="nav navbar-nav">
<li><a>Copyright © SimVascular Development Team - 2017</a></li>
</ul>
</div>
<!-- /.container -->
</nav>
<script src="js/jquery-1.11.0.js" type="text/javascript"></script><script src="js/bootstrap.min.js" type="text/javascript"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}
});
$('body').scrollspy({
target: '.bs-docs-sidebar',
offset: 40
});
</script>
<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-55333921-1', 'auto');
ga('send', 'pageview');
</script>
<script type="text/javascript"
src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
</body>
</html>