Installation

Requirements

System Requirements

  • Python 3.13+ (3.14 targeted)

  • Vulkan 1.2+ capable GPU and drivers

  • glslc shader compiler (from the Vulkan SDK)

  • GLFW3 system library

  • uv — workspace packages resolve only through uv run

Install uv if you don’t have it:

curl -LsSf https://astral.sh/uv/install.sh | sh

Per-Platform Setup

Arch / Manjaro

sudo pacman -S vulkan-devel glfw shaderc

Ubuntu / Debian

sudo apt install libvulkan-dev libglfw3-dev glslc

macOS

Install the Vulkan SDK (includes MoltenVK and glslc), then:

brew install glfw

Clone & Install

git clone https://github.com/simvx/simvx.git
cd simvx

# Install all workspace packages in editable mode
uv pip install -e packages/core -e packages/graphics -e packages/web -e packages/editor -e packages/ide

# Dev tools + docs
uv sync --group dev --group docs

Verify Installation

Check the Vulkan driver:

vulkaninfo --summary

Import-check the packages:

from simvx.core import Node, SceneTree, Vec3, Property
from simvx.graphics import App

Run the core test suite:

uv run --package simvx-core pytest

Next