Solver documentation needs a working tutorial, updates, and corrections
@ryanspilker ci sta già lavorando.
Dal 7/4/2026.
Valutazione
Questa issue non è ancora stata valutata.
Descrizione
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
- Lingua principale
- HTML
- Stelle
- 3
- Fork
- 26
- Merge medio
- 4g 1h
- PR unite (30g)
- 2
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di SimVascular/simvascular.github.io
-
enhancement
SimVascular/simvascular.github.io#103 · 6 commenti · 2 assegnatari ·
-
Creation of CFD User Guide Apertadocumentation
SimVascular/simvascular.github.io#100 · 19 commenti · 2 assegnatari ·
-
documentation
SimVascular/simvascular.github.io#90 · 2 commenti · 1 assegnatario ·
-
enhancement
SimVascular/simvascular.github.io#85 · 5 commenti · 3 assegnatari ·
-
svMultiPhysics: Add documentation describing the valid range of node and element IDs in text files Apertaenhancement
SimVascular/simvascular.github.io#81 · 1 assegnatario ·