Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove redundant docs after moving to SimVascular website #137

Merged
merged 2 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions docs/pages/GUI.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,29 +27,6 @@ interactive elements and graphical networks.
This architecture supports an intuitive user experience for
generating and managing 0D input files through a graphical interface.

# User guide

# How to Use
1. Create a virtual environment with the required `flask` dependency. If using `conda`, use the below commands:
```bash
conda create -n svZeroDGUI python=3.10 flask
conda activate svZeroDGUI
```
2. Navigate to the `applications` folder and then to the `create_0dmodel` subdirectory.
3. Launch the `app.py` file.
```bash
python applications/svZeroDGUI/app.py
```
4. Select a node type and name the node.
- For vessels, after drawing the node, click on it to open a form
where you can enter details such as vessel length, diameter, and more.
- For junctions, click the node to specify if it’s a Normal %Junction
or a Blood Vessel %Junction.
5. To draw edges between nodes, toggle the `Draw on` button on the right.
Once active, you can start connecting nodes by drawing edges between them.
6. When you wish to stop drawing edges and continue adding or moving nodes,
click the `Draw off` button.
7. Once you’ve completed the network, click `Export to JSON` on the right.
If there are any incorrect connections or patterns, an alert will prompt you
to make necessary changes so the network can be processed by svZeroDSolver.
8. Open the downloaded JSON file and add any additional information,
such as boundary condition data, before running it through svZeroDSolver.
A user guide is available on the [SimVascular website](https://simvascular.github.io/documentation/rom_simulation.html#0d-solver-gui).
6 changes: 6 additions & 0 deletions docs/pages/add_block.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,3 +156,9 @@ system.dC_dy.coeffRef(global_eqn_ids[current_block_equation_id], global_var_ids[

* Add `MyNewBlock.h` and `MyNewBlock.cpp` to `src/model/CMakeLists.txt`

<p> <br> </p>

## 5. Add the new block to svZeroDVisualization.

* Follow the instructions [here](@ref visualization) to make sure your new block can be visualized graphically.

Loading
Loading