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

Per-Platform Setup

Arch / Manjaro

sudo pacman -S vulkan-devel glfw glslc

Ubuntu / Debian

sudo apt install libvulkan-dev libglfw3-dev glslc

macOS

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

brew install glfw

Install SimVX

# With uv (recommended)
uv pip install -e packages/core -e packages/graphics

# With pip
pip install -e packages/core -e packages/graphics

# Include editor and IDE
uv pip install -e packages/core -e packages/graphics -e packages/editor -e packages/ide

Development Setup

git clone <your-simvx-repo-url>
cd simvx

# Install all workspace packages + dev tools
uv sync --group dev --group docs

# Run tests
uv run --package simvx-core pytest
uv run --package simvx-graphics pytest

Verify Installation

from simvx.core import Node, SceneTree, Vec3, Property
print("Core OK")

from simvx.graphics import App
print("Graphics OK")