# nvlabs/sionna-rk architecture

> Architecture diagram of the GitHub repository nvlabs/sionna-rk, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nvlabs/sionna-rk
- Repository: https://github.com/nvlabs/sionna-rk

## Overview

Sionna Research Kit is a GPU-accelerated research platform for an OpenAirInterface-based 5G RAN. In this plugin slice, OAI initializes plugin interfaces; channel emulation can select a file- or ZeroMQ-sourced CIR and apply it through a CUDA emulator. Other branches provide neural receiver and demapper implementations, LDPC decoding, data capture, link adaptation, and RIC xApps. The excerpts establish channel-emulation wiring and top-level initialization; unsampled plugin internals and xApp connections are not inferred.

Main entry points: [`plugins/channel_emulation/common/channel_emulator.c`](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/common/channel_emulator.c) (CIR orchestration), [`plugins/common/src/plugins.c`](https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.c) (Plugin registry), [`plugins/common/src/plugins.h`](https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.h) (Plugin interfaces), [`plugins/channel_emulation/file_loader/src/cir_file.c`](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/file_loader/src/cir_file.c) (File CIR loader)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["Plugin integration"]
  node_registry["Plugin registry<br/>[plugins.c]"]
  node_plugin_api["Plugin interfaces<br/>[plugins.h]"]
end

subgraph group_channel["Channel emulation"]
  node_channel_control["CIR orchestration<br/>[channel_emulator.c]"]
  node_cir_file["File CIR loader<br/>[cir_file.c]"]
  node_cir_zmq["ZeroMQ CIR loader<br/>[cir_zmq.c]"]
  node_cuda_emulator["CUDA emulator<br/>[chn_emu.c]"]
end

subgraph group_ai["AI PHY plugins"]
  node_demapper_api["Demapper plugin API"]
  node_neural_demapper["TensorRT demapper<br/>[trt_demapper.cpp]"]
  node_neural_receiver["TensorRT receiver<br/>[trt_receiver.cpp]"]
  node_data_capture["Demapper capture"]
  node_ldpc["CUDA LDPC decoder<br/>[nr_ldpc_cuda.c]"]
end

subgraph group_adaptation["Link adaptation"]
  node_olla["OLLA adaptation"]
  node_olla_core["SNR offset OLLA"]
  node_mcs_logging["MCS history logging"]
end

subgraph group_operations["RAN tools"]
  node_ric_monitor["MCS monitor<br/>[monitor_mcs.py]"]
  node_zmq_client["Stats client"]
  node_zmq_server["Stats server"]
end

node_oai(("OAI RAN"))

node_oai -->|"initializes plugins"| node_registry
node_registry -->|"uses interfaces"| node_plugin_api
node_registry -->|"initializes channel"| node_channel_control
node_plugin_api -->|"includes API"| node_demapper_api
node_plugin_api -->|"includes API"| node_channel_control
node_channel_control -->|"loads and initializes"| node_cir_file
node_channel_control -->|"loads and initializes"| node_cir_zmq
node_channel_control -->|"loads and initializes"| node_cuda_emulator
node_channel_control -->|"reads CIR"| node_cir_file
node_channel_control -->|"reads CIR"| node_cir_zmq

click node_registry "https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.c"
click node_plugin_api "https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.h"
click node_channel_control "https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/common/channel_emulator.c"
click node_cir_file "https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/file_loader/src/cir_file.c"
click node_cir_zmq "https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/zmq_loader/src/cir_zmq.c"
click node_cuda_emulator "https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/cuda_emulator/src/chn_emu.c"
click node_demapper_api "https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_demapper/src/nr_demapper_extern.h"
click node_neural_demapper "https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_demapper/src/runtime/trt_demapper.cpp"
click node_neural_receiver "https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_receiver/src/runtime/trt_receiver.cpp"
click node_data_capture "https://github.com/nvlabs/sionna-rk/blob/main/plugins/data_acquisition/src/nr_demapper_capture.c"
click node_ldpc "https://github.com/nvlabs/sionna-rk/blob/main/plugins/ldpc_cuda/src/nr_ldpc_cuda.c"
click node_olla "https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_olla.c"
click node_olla_core "https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_olla.c"
click node_mcs_logging "https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_log.c"
click node_ric_monitor "https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/monitor_mcs.py"
click node_zmq_client "https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/zmq_stats_client.py"
click node_zmq_server "https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/zmq_stats_server.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_registry,node_plugin_api toneBlue
class node_channel_control,node_cir_file,node_cir_zmq,node_cuda_emulator toneAmber
class node_demapper_api,node_neural_demapper,node_neural_receiver,node_data_capture,node_ldpc toneMint
class node_olla,node_olla_core,node_mcs_logging toneRose
class node_ric_monitor,node_zmq_client,node_zmq_server,node_oai toneIndigo
```

## Components

### Plugin integration

- [Plugin registry](https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.c): `plugins/common/src/plugins.c`
- [Plugin interfaces](https://github.com/nvlabs/sionna-rk/blob/main/plugins/common/src/plugins.h): `plugins/common/src/plugins.h`

### Channel emulation

- [CIR orchestration](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/common/channel_emulator.c): `plugins/channel_emulation/common/channel_emulator.c`
- [File CIR loader](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/file_loader/src/cir_file.c): `plugins/channel_emulation/file_loader/src/cir_file.c`
- [ZeroMQ CIR loader](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/zmq_loader/src/cir_zmq.c): `plugins/channel_emulation/zmq_loader/src/cir_zmq.c`
- [CUDA emulator](https://github.com/nvlabs/sionna-rk/blob/main/plugins/channel_emulation/cuda_emulator/src/chn_emu.c): `plugins/channel_emulation/cuda_emulator/src/chn_emu.c`

### AI PHY plugins

- [Demapper plugin API](https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_demapper/src/nr_demapper_extern.h): `plugins/neural_demapper/src/nr_demapper_extern.h`
- [TensorRT demapper](https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_demapper/src/runtime/trt_demapper.cpp): `plugins/neural_demapper/src/runtime/trt_demapper.cpp`
- [TensorRT receiver](https://github.com/nvlabs/sionna-rk/blob/main/plugins/neural_receiver/src/runtime/trt_receiver.cpp): `plugins/neural_receiver/src/runtime/trt_receiver.cpp`
- [Demapper capture](https://github.com/nvlabs/sionna-rk/blob/main/plugins/data_acquisition/src/nr_demapper_capture.c): `plugins/data_acquisition/src/nr_demapper_capture.c`
- [CUDA LDPC decoder](https://github.com/nvlabs/sionna-rk/blob/main/plugins/ldpc_cuda/src/nr_ldpc_cuda.c): `plugins/ldpc_cuda/src/nr_ldpc_cuda.c`

### Link adaptation

- [OLLA adaptation](https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_olla.c): `plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_olla.c`
- [SNR offset OLLA](https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_olla.c): `plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_olla.c`
- [MCS history logging](https://github.com/nvlabs/sionna-rk/blob/main/plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_log.c): `plugins/link_adaptation/openairinterface5g/openair2/LAYER2/NR_MAC_gNB/link_adaptation_mcs_hist_log.c`

### RAN tools

- [MCS monitor](https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/monitor_mcs.py): `plugins/ric_xapps/src/monitor_mcs.py`
- [Stats client](https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/zmq_stats_client.py): `plugins/ric_xapps/src/zmq_stats_client.py`
- [Stats server](https://github.com/nvlabs/sionna-rk/blob/main/plugins/ric_xapps/src/zmq_stats_server.py): `plugins/ric_xapps/src/zmq_stats_server.py`

### Other components

- **OAI RAN**

## Connections

- OAI RAN → Plugin registry: initializes plugins (evidence: `plugins/common/src/plugins.c`)
- Plugin registry → Plugin interfaces: uses interfaces (evidence: `plugins/common/src/plugins.c`)
- Plugin registry → CIR orchestration: initializes channel (evidence: `plugins/common/src/plugins.c`)
- Plugin interfaces → Demapper plugin API: includes API (evidence: `plugins/common/src/plugins.h`)
- Plugin interfaces → CIR orchestration: includes API (evidence: `plugins/common/src/plugins.h`)
- CIR orchestration → File CIR loader: loads and initializes (evidence: `plugins/channel_emulation/common/channel_emulator.c`)
- CIR orchestration → ZeroMQ CIR loader: loads and initializes (evidence: `plugins/channel_emulation/common/channel_emulator.c`)
- CIR orchestration → CUDA emulator: loads and initializes (evidence: `plugins/channel_emulation/common/channel_emulator.c`)
- CIR orchestration → File CIR loader: reads CIR (evidence: `plugins/channel_emulation/common/channel_emulator.c`)
- CIR orchestration → ZeroMQ CIR loader: reads CIR (evidence: `plugins/channel_emulation/common/channel_emulator.c`)
