Skip to content

Commit 9a29481

Browse files
ktboltktbolt
authored
Merge pull request #71 from ktbolt/Add-Installing-SimVascular-section_70
Add installing simvascular section
2 parents 08f8104 + a8b45cf commit 9a29481

File tree

2 files changed

+104
-0
lines changed

2 files changed

+104
-0
lines changed

‎documentation/getting_started.html‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,7 @@ <h3>Getting Started</h3>
164164
</div>
165165
<!-- The second class after "skipTo" is the ID of the <span> element
166166
of the <zero-md> element that renders the markdown file -->
167+
167168
<div>
168169
<h4 class="skipTo introduction">Introduction</h4>
169170
<div>
@@ -173,6 +174,11 @@ <h4 class="skipTo introduction">Introduction</h4>
173174
<p class="skipTo intro_mitk">MITK Framework</p>
174175
</div>
175176
</div>
177+
178+
<div>
179+
<h4 class="skipTo installing">Installing SimVascular</h4>
180+
</div>
181+
176182
<div>
177183
<h4 class="skipTo gui">Graphical User Interface</h4>
178184
<div>
@@ -227,6 +233,9 @@ <h4 class="skipTo tutorial">Tutorial</h4>
227233
<span id="intro_mitk">
228234
<zero-md src="getting_started/intro/mitk/readme.md" no-shadow></zero-md>
229235
</span>
236+
<span id="installing">
237+
<zero-md src="getting_started/installing/readme.md" no-shadow></zero-md>
238+
</span>
230239
<span id="gui">
231240
<zero-md src="getting_started/gui/intro/readme.md" no-shadow></zero-md>
232241
</span>

‎documentation/getting_started/installing/readme.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# Installing SimVascular
2+
3+
The SimVascular application is distributed using installers downloaded from the <a href="https://simtk.org/frs/?group_id=188"> SimTK SimVascular Downloads </a> website. Installers are provided for the following platforms
4+
5+
<ul style="list-style-type:none;">
6+
<li> <b> Ubuntu 22 </b> - Intel 64-bit architecture (x86_64) </li>
7+
<li> <b> Ubuntu 24 </b> - Intel 64-bit architecture (x86_64) </li>
8+
<li> <b> MacOS Ventura </b> - ARM 64-bit architecture (Silicon) </li>
9+
<li> <b> MacOS Ventura </b> - Intel 64-bit architecture (x86_64) </li>
10+
<li> <b> Windows 11 </b> - Windows Subsystem for Linux (WSL) Ubuntu 24 </li>
11+
</ul>
12+
13+
The SimVascular application uses the <a href="https://www.mitk.org/wiki/The_Medical_Imaging_Interaction_Toolkit_(MITK)"> Medical Imaging Interaction Toolkit (MITK)<a/> framework for medical imaging applications incorporating a plugin architecture. This framework uses several software packages
14+
<ul style="list-style-type:none;">
15+
<li> <b> MITK </b> - Medical imaging plugin framework </li>
16+
<li> <b> Qt6 </b> - GUI </li>
17+
<li> <b> VTK </b> - Graphics and visualization </li>
18+
<li> <b> ITK </b> - Image processing </li>
19+
<li> <b> Python </b> - Embedded Python environment </li>
20+
<li> <b> HDF5 </b> - Hierarchical Data Format Version 5 </li>
21+
</ul>
22+
23+
All of these software packages are built from source for each platform and depend on the versions of libraries they are built against. The SimVascular application is then built with these software packages. Running SimVascular on a platform it was not specifically built for can fail due to missing libraries or incompatible library versions.
24+
25+
Running SimVascular requires that C++ and graphics libraries (e.g. OpenGL) be installed. It is difficult to get SimVascular running on an HPC cluster because of the graphics library requirements and other required software, local and remote, needed to view graphics images created remotely.
26+
27+
Other platform-specific libraries may also be required. The notes under each SimVascular installer describe which additional libraries need to be installed.
28+
29+
### Ubuntu
30+
Most Ubuntu workstations will have the required C++ and graphics libraries installed. Ubuntu uses OpenGL and the X Window System (X11) for graphics. The Qt software package uses several X protocol C-language Binding (XCB) libraries that may not be installed by default. These libraries can be installed using
31+
<pre>
32+
sudo apt install '^libxcb.*-dev' libx11-xcb-dev
33+
</pre>
34+
35+
If SimVascular fails at start-up then running it from the command-line will show a message explaining which library can't be found. You can then install the missing library using
36+
37+
<pre>
38+
sudo apt install MISSING_LIBRAY_NAME
39+
</pre>
40+
41+
42+
### MacOS
43+
MacOS does not come with C++ libraries fully installed by default. The libraries are installed by installing the Xcode Command Line Tools
44+
by running the following command in a terminal
45+
<pre>
46+
xcode-select --install
47+
</pre>
48+
49+
The latest versions of SimVascular now require that the <a href="https://www.openmp.org/"> OpenMP </a> library be installed for shared-memory multiprocessing. It can be installed using
50+
<pre>
51+
brew install libomp
52+
</pre>
53+
54+
If SimVascular fails at start-up then running it from the command-line will show a message explaining which library can't be found. You can then install the missing library using
55+
56+
<pre>
57+
brew install MISSING_LIBRAY_NAME
58+
</pre>
59+
60+
61+
62+
### Windows
63+
There is currently no native Windows 11 release of the latest version of SimVascular. However, SimVascular can be run on a Windows 11 computer in an Ubuntu 24 terminal using <a href="https://learn.microsoft.com/en-us/windows/wsl"> Windows Subsystem for Linux (WSL) </a>. The SimVascular application runs just as fast as a native Windows build. You can also run all of the SimVascular solvers there using all of the processors of your Windows computer. The following steps describe how to install SimVascular and set up your Ubuntu environment to run it.
64+
65+
<strong> Download and install SimVascular </strong><br>
66+
After you have created a WSL user account a terminal will open to your Ubuntu home directory. You will then can download the SimVascular-Ubuntu-24-2025.08.25.deb installer from a browser and move it to your Ubuntu home directory (your Ubuntu home directory can be seen from the Windows File Explorer app).
67+
68+
Run the following command in your Ubuntu terminal to install SimVascular
69+
<pre>
70+
sudo dpkg -i SimVascular-Ubuntu-24-2025.08.25.deb
71+
</pre>
72+
73+
This will install SimVascular in
74+
<pre>
75+
/usr/local/sv/simvascular/2025-08-25
76+
</pre>
77+
78+
<strong> Install additional libraries </strong><br>
79+
To set up your Ubuntu environment run the following commands in your terminal
80+
<pre>
81+
sudo apt update
82+
83+
sudo apt install build-essential
84+
85+
sudo apt install '^libxcb.*-dev' libx11-xcb-dev libglu1-mesa-dev libxrender-dev libxi-dev libxkbcommon-dev libxkbcommon-x11-dev
86+
87+
sudo apt install libnss3 libwebp-dev libharfbuzz-dev libsm6 libxkbfile-dev
88+
</pre>
89+
90+
You should now be able to run SimVascular using
91+
<pre>
92+
/usr/local/sv/simvascular/2025-08-25/simvascular
93+
</pre>
94+
95+

0 commit comments

Comments
 (0)