SimVascular / SimVascular/simvascular.github.io

Solver documentation needs a working tutorial, updates, and corrections

Open
#91 11 comments 0 reactions 1 assignee View on GitHub

@ryanspilker is already working on this.

Since Apr 7, 2026.

bug
Dominant language
HTML
Stars
3
Forks
26
Avg merge
4d 1h
Merged PRs (30d)
2

Description

Description

No working tutorial is currently available in this documentation that leads to a completed simulation with the supported solver, svMultiPhysics. The Simulations Tool lacks a tutorial and has documentation that needs updates and corrections. The MultiPhysics Tool has a tutorial that is incomplete, currently not working, and written twice. Both tools' documentation pages are marked as beta versions.

Reproduction

A new user following the Getting Started Guide and continuing through the tutorial sections of the other guides in the documentation currently fails to complete a hemodynamic simulation.

Expected behavior

A new user should find a straightforward path starting with the Getting Started Guide to complete a first simulation with the Simulations Tool or the MultiPhysics Tool.

Additional context

The MultiPhysics Tool's tutorial with corrections should enable a new user to complete a simulation, but it is missing final steps and fails due to another issue, SimVascular/SimVascular#1182.

Code of Conduct
  • I agree to follow this project's Code of Conduct and Contributing Guidelines

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.