Setup¶
Install the toolchain, configure the Python environment, and keep submodule checkouts healthy on a fresh machine.
This page is the single source of truth for development-environment setup: toolchain requirements, the Python environment, per-component build prerequisites, and submodule health. The Usage guide assumes everything here is already in place.
Toolchain¶
Component |
Requirement |
Source of truth |
|---|---|---|
.NET SDK |
8.x (CI also installs 7 and 9) |
|
JDK |
11–21; set |
|
cmake, clang |
any recent version |
|
Maven |
any recent version |
|
Python |
3.11.x |
|
Python environment¶
Install a Python in the supported range (uv is recommended because it does not touch the system interpreter), then point Poetry at it:
pipx install poetry==2.2.1
pipx install uv
uv python install 3.11
poetry env use $(uv python find 3.11)
poetry install
If the distribution’s default python3 is outside the supported range (for
example Ubuntu 26.04 ships 3.14), skipping poetry env use makes Poetry pick
it and the install fails: the project supports 3.11.x only.
Per-component build prerequisites¶
VSharp. .NET SDK 8.x:
GameServers/VSharp/global.jsonpins SDK 8.0.0. Build withmake build_VSharp.usvm. A JDK in the supported range; when several are installed, point
JAVA_HOMEat the one to use (for example/usr/lib/jvm/java-17-openjdk-amd64). Build withmake build_usvm.Maps. cmake and clang (used by VSharp.CoverageInstrumenter). Build with
make build_maps.runstrat tests. Two pre-built net8.0 artifacts that no other target produces:
dotnet build tools/runstrat/resources/ForTests -c Release dotnet build GameServers/VSharp/VSharp.Runner -c Release
Note that
make build_SVMsbuildsVSharp.ML.GameServer.Runner, notVSharp.Runner.
Submodules¶
Initialize all submodules after cloning:
git submodule update --init --recursive
Check their health (reports uninitialized or wiped checkouts and exits non-zero on any finding):
make check_submodules
A wiped worktree (files deleted inside a submodule) is repaired with:
git -C <submodule-path> reset --hard HEAD
If the submodule’s .git directory is missing, re-run
git submodule update --init --recursive instead.
GPU¶
To use a GPU, the correct torch and torch_geometric versions should be
installed depending on your host device. You may first need to pip uninstall
these packages, provided by requirements. Then follow installation instructions
provided on the torch and
torch_geometric
websites.