Skip to content

Commit bb2b62e

Browse files
ktboltktbolt
committed
Renamae quickguide and update docs for MultiPhysics.
1 parent e5918c9 commit bb2b62e

File tree

220 files changed

+243
-244
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

220 files changed

+243
-244
lines changed

documentation/quickguide.html renamed to documentation/getting_started.html

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@
9292
<summary class="navTitle"><i class="iconInHeader fa-solid fa-user"></i>User Guides</summary>
9393
<div>
9494
<div class="navSubLink active">
95-
<a href="quickguide.html">Getting Started</a>
95+
<a href="getting_started.html">Getting Started</a>
9696
</div>
9797
<div class="navSubLink">
9898
<a href="modeling.html">Modeling</a>
@@ -211,76 +211,76 @@ <h4 class="skipTo tutorial">Tutorial</h4>
211211
<!-- The first <zero-md> element should have the id="math" attribute -->
212212
<!-- All <zero-md> elements should have the "no-shadow" attribute -->
213213
<span id="getting_started">
214-
<zero-md id="math" src="quickguide/intro/getting_started/readme.md" no-shadow></zero-md>
214+
<zero-md id="math" src="getting_started/intro/getting_started/readme.md" no-shadow></zero-md>
215215
</span>
216216
<span id="introduction">
217-
<zero-md src="quickguide/intro/intro/readme.md" no-shadow></zero-md>
217+
<zero-md src="getting_started/intro/intro/readme.md" no-shadow></zero-md>
218218
</span>
219219
<span id="intro_pipeline">
220-
<zero-md src="quickguide/intro/pipeline/readme.md" no-shadow></zero-md>
220+
<zero-md src="getting_started/intro/pipeline/readme.md" no-shadow></zero-md>
221221
</span>
222222
<span id="intro_tools">
223-
<zero-md src="quickguide/intro/tools/readme.md" no-shadow></zero-md>
223+
<zero-md src="getting_started/intro/tools/readme.md" no-shadow></zero-md>
224224
</span>
225225
<span id="intro_projects">
226-
<zero-md src="quickguide/intro/projects/readme.md" no-shadow></zero-md>
226+
<zero-md src="getting_started/intro/projects/readme.md" no-shadow></zero-md>
227227
</span>
228228
<span id="intro_mitk">
229-
<zero-md src="quickguide/intro/mitk/readme.md" no-shadow></zero-md>
229+
<zero-md src="getting_started/intro/mitk/readme.md" no-shadow></zero-md>
230230
</span>
231231
<span id="gui">
232-
<zero-md src="quickguide/gui/intro/readme.md" no-shadow></zero-md>
232+
<zero-md src="getting_started/gui/intro/readme.md" no-shadow></zero-md>
233233
</span>
234234
<span id="menubar">
235-
<zero-md src="quickguide/gui/menubar/readme.md" no-shadow></zero-md>
235+
<zero-md src="getting_started/gui/menubar/readme.md" no-shadow></zero-md>
236236
</span>
237237
<span id="toolbar">
238-
<zero-md src="quickguide/gui/toolbar/readme.md" no-shadow></zero-md>
238+
<zero-md src="getting_started/gui/toolbar/readme.md" no-shadow></zero-md>
239239
</span>
240240
<span id="gui_display">
241-
<zero-md src="quickguide/gui/display/readme.md" no-shadow></zero-md>
241+
<zero-md src="getting_started/gui/display/readme.md" no-shadow></zero-md>
242242
</span>
243243
<span id="image_windowing">
244-
<zero-md src="quickguide/gui/image_windowing/readme.md" no-shadow></zero-md>
244+
<zero-md src="getting_started/gui/image_windowing/readme.md" no-shadow></zero-md>
245245
</span>
246246
<span id="gui_data_manager">
247-
<zero-md src="quickguide/gui/data_manager/readme.md" no-shadow></zero-md>
247+
<zero-md src="getting_started/gui/data_manager/readme.md" no-shadow></zero-md>
248248
</span>
249249
<span id="gui_tool_panel">
250-
<zero-md src="quickguide/gui/tool_panel/readme.md" no-shadow></zero-md>
250+
<zero-md src="getting_started/gui/tool_panel/readme.md" no-shadow></zero-md>
251251
</span>
252252
<span id="gui_image_navigator">
253-
<zero-md src="quickguide/gui/image_navigator/readme.md" no-shadow></zero-md>
253+
<zero-md src="getting_started/gui/image_navigator/readme.md" no-shadow></zero-md>
254254
</span>
255255
<span id="tutorial">
256-
<zero-md src="quickguide/tutorial/intro/readme.md" no-shadow></zero-md>
256+
<zero-md src="getting_started/tutorial/intro/readme.md" no-shadow></zero-md>
257257
</span>
258258
<span id="tutorial_starting_simvascular">
259-
<zero-md src="quickguide/tutorial/starting_simvascular/readme.md" no-shadow></zero-md>
259+
<zero-md src="getting_started/tutorial/starting_simvascular/readme.md" no-shadow></zero-md>
260260
</span>
261261
<span id="tutorial_create_project">
262-
<zero-md src="quickguide/tutorial/create_project/readme.md" no-shadow></zero-md>
262+
<zero-md src="getting_started/tutorial/create_project/readme.md" no-shadow></zero-md>
263263
</span>
264264
<span id="tutorial_add_image_data">
265-
<zero-md src="quickguide/tutorial/add_image_data/readme.md" no-shadow></zero-md>
265+
<zero-md src="getting_started/tutorial/add_image_data/readme.md" no-shadow></zero-md>
266266
</span>
267267
<span id="tutorial_create_paths">
268-
<zero-md src="quickguide/tutorial/create_paths/readme.md" no-shadow></zero-md>
268+
<zero-md src="getting_started/tutorial/create_paths/readme.md" no-shadow></zero-md>
269269
</span>
270270
<span id="tutorial_create_segmentations">
271-
<zero-md src="quickguide/tutorial/create_segmentations/readme.md" no-shadow></zero-md>
271+
<zero-md src="getting_started/tutorial/create_segmentations/readme.md" no-shadow></zero-md>
272272
</span>
273273
<span id="tutorial_create_solid_model">
274-
<zero-md src="quickguide/tutorial/create_solid_model/readme.md" no-shadow></zero-md>
274+
<zero-md src="getting_started/tutorial/create_solid_model/readme.md" no-shadow></zero-md>
275275
</span>
276276
<span id="tutorial_create_finite_element_mesh">
277-
<zero-md src="quickguide/tutorial/create_finite_element_mesh/readme.md" no-shadow></zero-md>
277+
<zero-md src="getting_started/tutorial/create_finite_element_mesh/readme.md" no-shadow></zero-md>
278278
</span>
279279
<span id="tutorial_create_simulation">
280-
<zero-md src="quickguide/tutorial/create_simulation/readme.md" no-shadow></zero-md>
280+
<zero-md src="getting_started/tutorial/create_simulation/readme.md" no-shadow></zero-md>
281281
</span>
282282
<span id="tutorial_summary">
283-
<zero-md src="quickguide/tutorial/summary/readme.md" no-shadow></zero-md>
283+
<zero-md src="getting_started/tutorial/summary/readme.md" no-shadow></zero-md>
284284
</span>
285285
</section>
286286
</section>

documentation/quickguide/gui/data_manager/readme.md renamed to documentation/getting_started/gui/data_manager/readme.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@ manage adding/removing <i>Tool</i> instances and changing some of the properties
99
When creating a new <i>Project</i> the <i> Data Manager </i> displays a list of core <i>Tool Types</i> (Fig. 6).
1010

1111
<figure>
12-
<img class="svImg svImgSm" src="/documentation/quickguide/gui/images/data-manager-new-project.png">
12+
<img class="svImg svImgSm" src="/documentation/getting_started/gui/images/data-manager-new-project.png">
1313
<figcaption class="svCaption">Fig. 6 &nbsp The <i>Data Manager</i> of a new <i>Project</i> listing
1414
the core <b>Images</b>, <b>Paths</b>, <b>Segmentations</b>, <b>Models</b>, <b>Meshes</b>, <b>Simulations</b>,
15-
<b>svFSI</b>, and <b>ROMSimulations</b> <b>Tool Types</b>.
15+
<b>MultiPhysics</b>, and <b>ROMSimulations</b> <b>Tool Types</b>.
1616
</figcaption>
1717
</figure>
1818

@@ -22,10 +22,10 @@ The <i> Data Manager </i> view of the
2222
created following the steps demonstrated in the <a href="#tutorial"> Tutorial</a> section is shown in Fig. 7.
2323

2424
<figure>
25-
<img class="svImg svImgSm" src="/documentation/quickguide/intro/images/demo-data-manager.png">
25+
<img class="svImg svImgSm" src="/documentation/getting_started/intro/images/demo-data-manager.png">
2626
<figcaption class="svCaption">Fig. 7 &nbsp An example of a <i>Project</i> displayed in the <i>Data Manager</i>.
2727
Instances of <i>Tools</i> added to the <i>Project</i> (e.g. <b>aorta</b>) are shown below the core <b>Images</b>, <b>Paths</b>,
28-
<b>Segmentations</b>, <b>Models</b>, <b>Meshes</b>, <b>Simulations</b>, <b>svFSI</b>, and
28+
<b>Segmentations</b>, <b>Models</b>, <b>Meshes</b>, <b>Simulations</b>, <b>MultiPhysics</b>, and
2929
<b>ROMSimulations</b> <b>Tool Types</b>.
3030
</figcaption>
3131
</figure>
@@ -88,28 +88,28 @@ The <i> Data Manager </i> has two GUI controls that are selected with the left m
8888

8989
<tr>
9090
<td>
91-
<img src="/documentation/quickguide/gui/images/data-manager-gui-control-arrow-1.png" width="30" height="22">
91+
<img src="/documentation/getting_started/gui/images/data-manager-gui-control-arrow-1.png" width="30" height="22">
9292
</td>
9393
<td> Selecting the arrow toggles the display of the <i>Tool</i> instances. <br><br>
9494
Double clicking on a <i>Tool Type</i> performs the same function.
9595
</td>
9696
<td>
97-
<b> Toggle off</b><img src="/documentation/quickguide/gui/images/data-manager-gui-control-arrow-2.png" width="160" height="23"> <br> <br>
98-
<b> Toggle on</b> <img src="/documentation/quickguide/gui/images/data-manager-gui-control-arrow-3.png" width="160" height="70">
97+
<b> Toggle off</b><img src="/documentation/getting_started/gui/images/data-manager-gui-control-arrow-2.png" width="160" height="23"> <br> <br>
98+
<b> Toggle on</b> <img src="/documentation/getting_started/gui/images/data-manager-gui-control-arrow-3.png" width="160" height="70">
9999
</td>
100100
</tr>
101101

102102
<tr>
103103
<td>
104-
<img src="/documentation/quickguide/gui/images/data-manager-gui-control-box-1.png" width="30" height="22">
104+
<img src="/documentation/getting_started/gui/images/data-manager-gui-control-box-1.png" width="30" height="22">
105105
</td>
106106
<td> Selecting the CheckBox toggles the display of <i>Tool</i> geometry in the <i>Display</i>.
107107
The CheckBox changes to blue when on. <br> <br>
108108
Selecting the box for a <i>Tool Type</i> toggles the display for all instances of that <i>Tool</i>.
109109
</td>
110110
<td>
111-
<b> Toggle off</b><img src="/documentation/quickguide/gui/images/data-manager-gui-control-box-3.png" width="160" height="70"> <br> <br>
112-
<b> Toggle on</b> <img src="/documentation/quickguide/gui/images/data-manager-gui-control-box-2.png" width="160" height="70">
111+
<b> Toggle off</b><img src="/documentation/getting_started/gui/images/data-manager-gui-control-box-3.png" width="160" height="70"> <br> <br>
112+
<b> Toggle on</b> <img src="/documentation/getting_started/gui/images/data-manager-gui-control-box-2.png" width="160" height="70">
113113
</td>
114114
</tr>
115115
</table>
@@ -122,7 +122,7 @@ opens a menu containing options common to all <i>Tool Types</i> and additional o
122122
Specialized options are located at the bottom of a menu and are separated from the common options by a line (Fig 8.).
123123

124124
<figure>
125-
<img class="svImg svImgLg" src="/documentation/quickguide/gui/images/data-manager-type-menu.png">
125+
<img class="svImg svImgLg" src="/documentation/getting_started/gui/images/data-manager-type-menu.png">
126126
<figcaption class="svCaption"> Fig. 8 &nbsp The menu for a <b>Paths</b> Tool Type showing common options in the top portion
127127
of the menu (<b>Global Reinit</b> through <b>Paste</b>) and specialized options (<b>Create Path</b>,
128128
<b>Import Paths</b> and <b>Export All as Legacy Paths</b>) separated from them by a line.
@@ -211,7 +211,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
211211

212212
<tr>
213213
<td> Images </td>
214-
<td> <img src="/documentation/quickguide/gui/images/data-manager-image-type-menu.png" width="150" height="200"> </td>
214+
<td> <img src="/documentation/getting_started/gui/images/data-manager-image-type-menu.png" width="150" height="200"> </td>
215215
<td>
216216
<i>Add/Replace Image</i> - Add or replace the image volume data for the <i>Project</i>. Image data can be DICOM or VTK VTI files.
217217
<br><br>
@@ -223,7 +223,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
223223

224224
<tr>
225225
<td> Paths </td>
226-
<td> <img src="/documentation/quickguide/gui/images/data-manager-paths-type-menu.png" width="150" height="200"> </td>
226+
<td> <img src="/documentation/getting_started/gui/images/data-manager-paths-type-menu.png" width="150" height="200"> </td>
227227
<td>
228228
<i> Create Path </i> - Create an instance of a <i>Paths</i> tool. <i>Paths</i> are then created from <i>Image</i> tool data.<br>
229229
<i> Import Paths </i> - Create an instance of a <i>Paths</i> tool from a <i>Path</i> data contained in SimVascular .pth or legacy .paths file. <br>
@@ -233,7 +233,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
233233

234234
<tr>
235235
<td> Segmentations </td>
236-
<td> <img src="/documentation/quickguide/gui/images/data-manager-seg-type-menu.png" width="150" height="200"> </td>
236+
<td> <img src="/documentation/getting_started/gui/images/data-manager-seg-type-menu.png" width="150" height="200"> </td>
237237
<td>
238238
<i> Create Contour Group </i> - Create an instance of a <i>Segmentations</i> tool. <i>Segmentations</i> are created using geometry from a <i>Paths</i> tool. <br>
239239
<i> Import Segmentations </i> - Create an instance of a <i>Segmentations</i> tool from the data contained in a SimVascular .ctgr file. <br>
@@ -244,7 +244,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
244244

245245
<tr>
246246
<td> Models </td>
247-
<td> <img src="/documentation/quickguide/gui/images/data-manager-models-type-menu.png" width="150" height="200"> </td>
247+
<td> <img src="/documentation/getting_started/gui/images/data-manager-models-type-menu.png" width="150" height="200"> </td>
248248
<td>
249249
<i> Create Model </i> - Create an instance of a <i>Models</i> tool.
250250
A <i>Model</i> is created using segmentation geometry from one or more <i>Segmentations</i> tools. <br>
@@ -262,7 +262,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
262262

263263
<tr>
264264
<td> Meshes </td>
265-
<td> <img src="/documentation/quickguide/gui/images/data-manager-meshes-type-menu.png" width="150" height="200"> </td>
265+
<td> <img src="/documentation/getting_started/gui/images/data-manager-meshes-type-menu.png" width="150" height="200"> </td>
266266
<td>
267267
<i> Create Mesh </i> - Create an instance of a <i>Meshes</i> tool.
268268
A mesh is created using a model from a <i>Models</i> tool. <br>
@@ -277,7 +277,7 @@ The following table lists each <i>Tool Type</i> with a brief description of each
277277

278278
<tr>
279279
<td> Simulations </td>
280-
<td> <img src="/documentation/quickguide/gui/images/data-manager-sims-type-menu.png" width="150" height="200"> </td>
280+
<td> <img src="/documentation/getting_started/gui/images/data-manager-sims-type-menu.png" width="150" height="200"> </td>
281281
<td>
282282
<i> Create Simulation job </i> - Create an instance of a <i>Simulations</i> tool.
283283
A CFD simulation job is created using a model from a <i>Models</i> tool and a mesh from
@@ -286,18 +286,18 @@ The following table lists each <i>Tool Type</i> with a brief description of each
286286
</tr>
287287

288288
<tr>
289-
<td> svFSI </td>
290-
<td> <img src="/documentation/quickguide/gui/images/data-manager-fsi-type-menu.png" width="150" height="200"> </td>
289+
<td> MultiPhysics </td>
290+
<td> <img src="/documentation/getting_started/gui/images/data-manager-fsi-type-menu.png" width="150" height="200"> </td>
291291
<td>
292-
<i> Create svFSI job </i> - Create an instance of a <i>svFSI</i> tool.
292+
<i> Create MultiPhysics job </i> - Create an instance of a <i>MultiPhysics</i> tool.
293293
A multi-physics simulation job is created using a model from a <i>Models</i> tool and
294294
a mesh from a <i>Meshes</i> tool. <br>
295295
</td>
296296
</tr>
297297

298298
<tr>
299299
<td> ROMSimulations </td>
300-
<td> <img src="/documentation/quickguide/gui/images/data-manager-rom-type-menu.png" width="150" height="200"> </td>
300+
<td> <img src="/documentation/getting_started/gui/images/data-manager-rom-type-menu.png" width="150" height="200"> </td>
301301
<td>
302302
<i> Create ROM Simulation job </i> - Create an instance of a <i>ROMSimulation</i> tool.
303303
A reduced-order model (ROM) simulation job is created using a model from a

documentation/quickguide/gui/display/readme.md renamed to documentation/getting_started/gui/display/readme.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ context with medical image data. This enables matching geometric data (e.g. mode
77
The layout of the <i>Display</i> windows and its GUI components are shown in Fig. 5.
88

99
<figure>
10-
<img class="svImg svImgMd" src="/documentation/quickguide/gui/images/display.png">
10+
<img class="svImg svImgMd" src="/documentation/getting_started/gui/images/display.png">
1111
<figcaption class="svCaption"> Fig. 5 &nbsp The standard four-window view comprising three 2D and one 3D views.
1212
</figure>
1313

@@ -92,7 +92,7 @@ the mouse cursor.
9292
<h3 id="window_menus"> Window Menus</h3>
9393

9494
The three icons
95-
<img src="/documentation/quickguide/gui/images/display_icon_menu.png" width="70" height="30"> </td> displayed in the upper right
95+
<img src="/documentation/getting_started/gui/images/display_icon_menu.png" width="70" height="30"> </td> displayed in the upper right
9696
corner each window provides options to customize the view and crosshair behavior when selected using the left mouse button.
9797

9898
<table class="table table-bordered" style="width:100%">
@@ -103,9 +103,9 @@ corner each window provides options to customize the view and crosshair behavior
103103
</tr>
104104

105105
<tr>
106-
<td><img src="/documentation/quickguide/gui/images/window-icon-1.png" width="28" height="24"> </td>
106+
<td><img src="/documentation/getting_started/gui/images/window-icon-1.png" width="28" height="24"> </td>
107107
<td>
108-
<img src="/documentation/quickguide/gui/images/window-menu-1.png" width="180" height="180">
108+
<img src="/documentation/getting_started/gui/images/window-menu-1.png" width="180" height="180">
109109
</td>
110110
<td>
111111
<ul style="list-style-type:none;">
@@ -115,31 +115,31 @@ corner each window provides options to customize the view and crosshair behavior
115115
<li> <b> Crosshair rotation </b> - Select to toggle using crosshairs to rotate two planes </li>
116116
<li> <b> Coupled crosshair rotation </b> - Select to toggle using crosshairs to rotate planes both planes </li>
117117
<li> <b> Swivel mode </b> - Select to toggle using crosshairs to rotate planes in about all three axes </li>
118-
<li> <img src="/documentation/quickguide/gui/images/window-ts-slider.png" width="140" height="30">
118+
<li> <img src="/documentation/getting_started/gui/images/window-ts-slider.png" width="140" height="30">
119119
- The <b>T</b>thicker <b>S</b>slices slider controls how many slices around the current one are used for a maximum intensity projection </li>
120120
</ul>
121121
</td>
122122

123123
</tr>
124124

125125
<tr>
126-
<td><img src="/documentation/quickguide/gui/images/window-icon-2.png" width="28" height="24"> </td>
126+
<td><img src="/documentation/getting_started/gui/images/window-icon-2.png" width="28" height="24"> </td>
127127
<td> Changes the view layout </td>
128128
<td> The view is changed to a full-screen layout for the window and plane the mouse cursor is in.
129-
When selected, it changes to <img src="/documentation/quickguide/gui/images/window-icon-4.png" width="28" height="24">
129+
When selected, it changes to <img src="/documentation/getting_started/gui/images/window-icon-4.png" width="28" height="24">
130130
</td>
131131
</tr>
132132

133133
<tr>
134-
<td><img src="/documentation/quickguide/gui/images/window-icon-4.png" width="28" height="24"> </td>
134+
<td><img src="/documentation/getting_started/gui/images/window-icon-4.png" width="28" height="24"> </td>
135135
<td> Changes the view layout </td>
136136
<td> Expands the corresponding window to full screen within the four window view </td>
137137
</tr>
138138

139139
<tr>
140-
<td><img src="/documentation/quickguide/gui/images/window-icon-3.png" width="28" height="24"> </td>
140+
<td><img src="/documentation/getting_started/gui/images/window-icon-3.png" width="28" height="24"> </td>
141141
<td>
142-
<img src="/documentation/quickguide/gui/images/window-menu-2.png" width="180" height="180">
142+
<img src="/documentation/getting_started/gui/images/window-menu-2.png" width="180" height="180">
143143
</td>
144144
<td>
145145
<ul style="list-style-type:none;">

0 commit comments

Comments
 (0)