Installation#

The Nyx renderer plugin is distributed as the gs-nyx Python wheel. TODO: Update this with the official published name

Requirements#

  • Python 3.10, 3.11, or 3.12

  • Windows 11, or Linux (validated on Ubuntu 22.04; manylinux 2.34+ wheels)

  • A CUDA-capable NVIDIA GPU (compute capability 7.0+)

  • CUDA 12.9 or newer, with NVIDIA driver 575 or newer. The wheels bundle their CUDA runtime, but the driver must be installed on the host.

Installing the wheel#

pip install gs-nyx-plugin

To pin a specific version (recommended for reproducibility):

pip install "gs-nyx-plugin==0.1.0"

Verifying the install#

import gs_nyx
print(gs_nyx.__version__)

If the import fails with a CUDA-related error, confirm that nvidia-smi runs successfully, the wheel cannot fall back to a CPU renderer.

Next steps#

  • Walk through the Quickstart to render your first frame.

  • Read Concepts for the mental model behind scenes, assets, and render modes.