Skip to main content

An interactive GUI to create and visualize Sionna RT scenes, paths and radio maps

Project description

Sionna RT GUI

An interactive GUI to simulate and visualize Sionna RT scenes, paths, and radio maps.

Sionna RT GUI screenshot

Getting started

This project requires Python 3.10 or later. Sionna RT will be installed automatically as part of the dependencies.

Installing from PyPI

pip install sionna-rt-gui

Then, start the GUI with:

sionna-rt-gui

Select a scene from Sionna RT's built-in scenes using the dropdown in the top-left corner, or by passing it as a command-line argument:

sionna-rt-gui path/to/scene.xml

Installing from source

If you would like to tweak the GUI or build on top of it, you can clone this repository and install it from source:

python3 -m venv ./.venv
source ./.venv/bin/activate
pip install -r ./requirements.txt

Then, start the GUI with:

python ./scripts/run.py

GUI controls

The left-hand window can be used to trigger and configure all simulation options for radio devices, radio maps, and paths.

Press ? or H to show a help window listing supported keyboard shortcuts.

Animations: the position of radio devices can be animated over time. To do so,

  1. Select the radio device to animate.
  2. Use the transformation gizmo to place it in the scene.
  3. In the Selection window, click 'Add current position'
  4. Move the radio device to its next position and repeat until the trajectory is complete.

The device will move along the path when animation playback is enabled under the Animation section of the main window.

Command-line options

Configuration files

All available options and their defaults are defined in src/sionna_rt_gui/config.py.

Almost all parameters can be set using YAML configuration files, see e.g. configs/sionna_rt_gui/example.yaml. Pass a config file with the --config argument:

sionna-rt-gui --config path/to/config.yaml

Live reload mode

For development, use --watch to enable live code reloading:

python ./scripts/run.py --watch

This monitors source files and automatically reloads the GUI when changes are detected. You can also trigger a manual reload with Shift + R.

Limitations

The following features are not supported in the GUI at the moment:

  • Slice plane
  • Mesh-based radio maps

Acknowledgements

This project uses the Polyscope and Dear ImGui libraries with the Bess Dark theme. Sionna RT scenes use map data from OpenStreetMap.

License

Copyright (c) 2025-2026 NVIDIA Corporation. Licensed under the Apache License 2.0. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sionna_rt_gui-0.1.0-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file sionna_rt_gui-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: sionna_rt_gui-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for sionna_rt_gui-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a99f62dcd961c611ff8c78ff4ddec4748c8011af8672dc75f3a483d269d06966
MD5 a06bbdb75eb2e3da64087759ba2da6d8
BLAKE2b-256 37e1d04eddb45655f50ae9ac1023a725d39d58af2d9ab081b3738653b10648c6

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page