SimVascular / SimVascular/simvascular.github.io

Add WSL2 guidance for Windows users

Open
#103 6 comments 0 reactions 2 assignees View on GitHub

@ktbolt is already working on this.

Since Aug 12, 2026.

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

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

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.