Add WSL2 guidance for Windows users
@ktbolt is already working on this.
Since Aug 12, 2026.
Assessment
This issue has not been assessed yet.
Description
Problem
The documentation needs clearer guidance for installing and using SimVascular-related tools through Windows Subsystem for Linux 2 (WSL2).
Solution
- Document the recommended WSL2 setup.
- Identify required Windows and Linux configuration steps.
- Document installation and environment requirements.
- Explain how users should access files and run the relevant tools.
- Add common troubleshooting guidance and known limitations.
- Link the completed guidance from the appropriate Getting Started documentation.
Additional context
This topic is related to the broader Getting Started documentation update, but it has enough platform-specific requirements and troubleshooting considerations to be tracked separately. This issue is being separated from #59 so that the general Getting Started update and the platform-specific WSL2 guidance can progress and be reviewed independently. Following a discussion between @ryanspilker and @justran-csuf, @justran-csuf will lead the WSL2-specific guidance if his availability permits. @ryanspilker will assist with coordination, review, and integration with the broader Getting Started documentation.
Code of Conduct
- I agree to follow this project's Code of Conduct and Contributing Guidelines
- Dominant language
- HTML
- Stars
- 3
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from SimVascular/simvascular.github.io
-
Creation of CFD User GuideMay be free again @ktbolt claimed this 81 days ago, and no pull request is open. Opendocumentation
SimVascular/simvascular.github.io#100 · 19 comments · 2 assignees ·
-
Solver documentation needs a working tutorial, updates, and correctionsMay be free again @ryanspilker claimed this 179 days ago, and no pull request is open. Openbug
SimVascular/simvascular.github.io#91 · 11 comments · 1 assignee ·
-
Update svMultiPhysics documentation with Docker image link (simvascular/svmultiphysics)May be free again @ktbolt claimed this 183 days ago, and no pull request is open. Opendocumentation
SimVascular/simvascular.github.io#90 · 2 comments · 1 assignee ·
-
Update coronary documentationMay be free again @menon-karthik claimed this 198 days ago, and no pull request is open. Openenhancement
SimVascular/simvascular.github.io#85 · 5 comments · 3 assignees ·
-
svMultiPhysics: Add documentation describing the valid range of node and element IDs in text filesMay be free again @ktbolt claimed this 313 days ago, and no pull request is open. Openenhancement
SimVascular/simvascular.github.io#81 · 1 assignee ·