Installation#

OWRT is a Python package with optional extras. The core package compiles scenes and needs no GPU; Sionna RT, the web service and the tutorial notebooks are opt-in extras.

Requirements#

Python 3.10 to 3.12 (the project environment uses 3.11)
Conda for the scripted setup, or any virtual environment for a manual install
For ray tracing: Sionna RT 2.0.x, which runs on CPU through LLVM or on an NVIDIA GPU through CUDA
Network access to the public geodata providers when a scene is compiled for the first time

Scripted setup with Conda#

The setup script creates the named owrt environment with Python 3.11 and installs the development, Sionna RT and web extras into it:

git clone https://github.com/zhiheng-yang/openworld-radio-twin.git
cd openworld-radio-twin
./scripts/setup.sh
conda activate owrt

Verify that the Sionna runtime is visible before starting a GPU session:

python scripts/check_sionna.py

OWRT does not install CUDA or NVIDIA drivers. Sionna uses the runtime already exposed by the machine, and the same smoke test also runs on Sionna’s CPU backend.

Manual install and extras#

python -m pip install -e .              # scene compiler and dataset generator
python -m pip install -e '.[rt]'        # + Sionna RT 2.0.x
python -m pip install -e '.[web]'       # + FastAPI service and browser explorer
python -m pip install -e '.[tutorial]'  # + JupyterLab, ipywidgets, pythreejs, Plotly
python -m pip install -e '.[all]'       # everything above
python -m pip install -e '.[dev]'       # pytest and ruff
python -m pip install -e '.[docs]'      # Sphinx toolchain for this documentation

Extra	Adds	Needed for
`rt`	`sionna-rt`	`owrt.load_scene(...)`, Sionna dataset cases
`web`	`fastapi`, `uvicorn`	`owrt serve`, the explorer and batch pages, the HTTP API
`tutorial`	JupyterLab, `ipywidgets`, `pythreejs`, Plotly	The notebooks under Tutorials
`ui-test`	Playwright	Optional browser screenshot check
`dev`	pytest, ruff	Running the test suite
`docs`	Sphinx, pydata theme, MyST-NB	Building this site

Next step#

Continue with the Quickstart, or start the browser explorer as described in Web explorer.