Solver documentation needs a working tutorial, updates, and corrections
@ryanspilker ya está trabajando en esto.
Desde el 7/4/2026.
Evaluación
Este issue todavía no se ha evaluado.
Descripción
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
- Lenguaje dominante
- HTML
- Estrellas
- 3
- Forks
- 26
- Merge medio
- 6 d 12 h
- PR fusionados (30 d)
- 2
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de SimVascular/simvascular.github.io
-
Add WSL2 guidance for Windows usersQuizá libre de nuevo @ktbolt la tomó hace 62 días y no hay ningún pull request abierto. Abiertoenhancement
SimVascular/simvascular.github.io#103 · 6 comentarios · 2 asignados ·
-
Creation of CFD User GuideQuizá libre de nuevo @ktbolt la tomó hace 91 días y no hay ningún pull request abierto. Abiertodocumentation
SimVascular/simvascular.github.io#100 · 19 comentarios · 2 asignados ·
-
Update svMultiPhysics documentation with Docker image link (simvascular/svmultiphysics)Quizá libre de nuevo @ktbolt la tomó hace 193 días y no hay ningún pull request abierto. Abiertodocumentation
SimVascular/simvascular.github.io#90 · 2 comentarios · 1 asignado ·
-
Update coronary documentationQuizá libre de nuevo @menon-karthik la tomó hace 208 días y no hay ningún pull request abierto. Abiertoenhancement
SimVascular/simvascular.github.io#85 · 5 comentarios · 3 asignados ·
-
svMultiPhysics: Add documentation describing the valid range of node and element IDs in text filesQuizá libre de nuevo @ktbolt la tomó hace 323 días y no hay ningún pull request abierto. Abiertoenhancement
SimVascular/simvascular.github.io#81 · 1 asignado ·