Installation

Before proceeding, ensure your system meets the system requirements.

Just want to try SRB quickly? Use the Docker path with a locally built image or a release image selected by its complete sha256 digest.

Installation Methods

SRB supports three installation methods, each with different trade-offs:

A. Native

• ✅ Full system integration
• ✅ Smooth development experience
• ❗ Complex setup process
• ❗ Potential dependency conflicts

B. Docker (Recommended)

• ✅ Simple installation & deployment
• ✅ Reproducible environment & easy to update
• ⚠️ Moderate development experience (via Dev Containers)
• ✅ Includes helper scripts for GUI, headless, and ephemeral sessions
• ✅ Least-privilege profile for lightweight commands
• ❗ Isaac Sim’s trusted profile grants host-adjacent access (not suitable for HPC)

C. Apptainer/Singularity

• ✅ Deployable to HPC clusters
• ❗ Requires local Docker to build the Apptainer image (.sif)
• ❗ Limited interactive development support

Temporary Docker sessions

The runner uses --rm, so the container filesystem is discarded when the process exits. The safe profile has no persistent host mounts. It requires an already built local image, or an explicitly supplied registry image pinned by its full sha256 digest; it never downloads a mutable latest fallback.

Do not pipe a mutable branch’s setup script directly into a shell. Clone or otherwise authenticate the repository first, inspect the runner, and follow the Docker installation guide.