API reference#

The user-facing modules are the Sionna-compatible loader, the scene compiler, the antenna selection and the 3GPP band classification, the dataset generator and its PyTorch dataset, the geodesy helper, the scene preview and the command line. The remaining modules are documented for contributors.

User-facing modules#

openworld_radio_twin

OpenWorld Radio Twin application package.

openworld_radio_twin.rt

Sionna-compatible loader extended with geographic scene compilation.

openworld_radio_twin.compiler

Compile geographic inputs into the canonical reusable scene directory.

openworld_radio_twin.antennas

Antennas of a compiled scene: acquired from a source, selected, placed and recorded.

openworld_radio_twin.spectrum

Link direction of registered frequency ranges, from the 3GPP operating bands.

openworld_radio_twin.dataset

High-level Python interface for reproducible dataset generation.

openworld_radio_twin.torch_dataset

A PyTorch dataset of the radio maps of a generated dataset or an extracted package.

openworld_radio_twin.geodesy

openworld_radio_twin.plotly_preview

VS Code-compatible interactive preview for compiled OWRT scenes.

openworld_radio_twin.cli

Request and result models#

openworld_radio_twin.models

openworld_radio_twin.batch

openworld_radio_twin.environment

openworld_radio_twin.scene_format

Canonical paths shared by scene compilation, batch generation, and loading.

openworld_radio_twin.conventions

Row orders, units, no-data values and data types of the written arrays.

openworld_radio_twin.radio_map_index

The Parquet index of a dataset or package: one row per complete radio map.

openworld_radio_twin.licences

Licences and credits of the data a scene is built from, and the dataset licence notice.

openworld_radio_twin.config

Providers#

openworld_radio_twin.providers

Remote geospatial data providers.

Simulation, artifacts and rendering#

Web application#