Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Pre-release / design spec — this site documents a framework still under design. APIs and schemas described here are proposals subject to change.
RF Data Generation Framework
RF Data Generation Framework

Start Here

  • Overview
  • Principles
  • Documentation Style Guide
  • Contributing
    • Docs Quality Checks

User Guide

  • Overview
    • Install
    • Quickstart
    • Your First Scene

Concepts

  • Concepts
    • Architecture
    • Core Types
    • Coordinate Systems
    • Records, Receivers, and Assets
    • Emitters
      • Library Landscape
      • Coverage
    • Channels
      • Transmit (TX) Impairments
      • Channel Propagation
      • RX Capture
      • RX Hardware
    • Scenes
      • Scene Composition
      • Scene Geometry
    • Labels
    • Annotations
    • Storage
    • Evidence and Release Qualification
    • Dataset Consumption
    • Signal Catalog

How-To Guides

  • How-to Guides
    • Generate a small local dataset
    • Modify a scenario preset
    • Choose a channel chain
    • Configure multi-RX output
    • Generate a dense urban dataset
    • Inspect and audit a dataset
    • Resume or repair a partial run
    • Export or convert a dataset
    • Add a custom emitter
    • Add a custom channel transformation
    • Add a custom labeler
    • Add a custom placement strategy
    • Add a custom annotation template
    • Add a custom annotator
    • Add a custom store
    • Run on Spark
    • Annotate an existing dataset
    • Scenario Presets

Reference

  • Overview
    • Schemas
      • Config Schema
      • Label Schema
      • Storage Layout
      • Annotation Templates
      • Plugin Metadata
    • Data Formats
      • IQ Layout Policy
      • TorchSig Interop
      • Scene Geometry Assets
    • Algorithms And Math
      • Emitter Algorithms
      • Radar Emitter Algorithms
      • ADS-B Emitter Algorithm
      • LoRa and BLE Emitter Algorithms
      • Wi-Fi and Zigbee Emitter Algorithms
      • Drone Emitter Algorithms
      • Cellular Emitter Algorithms
      • Capture Replay
      • Scene Composition Algorithm
      • Placement-strategy selection guide
      • Fingerprint Math
      • Fingerprint Parameter Priors
      • RF Frontend Models
      • 3GPP TR 38.901 propagation tables
      • Noise Floor Table
    • Operations
      • CLI
      • Compute Environment
      • Cloud Backends
      • Logging & Observability
      • Build and CI
    • Quality Contracts
      • Determinism
      • Metrics
      • Test Contracts
      • Test Fixtures
      • Contract Tests
      • Integration Tests
      • Golden-Set Verification
      • Property-Based Tests
      • Test Execution
    • Project Contracts
      • Project Layout
      • Maturity Matrix
    • Glossary

API Reference

  • API Reference
    • Enums
    • Core Types
    • rfgen.config
    • rfgen.emitters
    • rfgen.channels
    • rfgen.device_fingerprint
    • rfgen.propagation
    • rfgen.rx_frontend
    • Calibrated RF Chain API
    • rfgen.rt_assets
    • rfgen.scene
    • rfgen.labels
    • rfgen.annotators
    • rfgen.storage
    • rfgen.dataset
    • rfgen.adapters
    • rfgen.executors
    • rfgen.credentials
    • rfgen.registry
    • rfgen.log_sinks
    • rfgen.execution_evidence
    • rfgen.manifest
    • rfgen.manifest_verification
    • rfgen.attestation
    • rfgen.supply_chain_evidence
    • rfgen.admission_estimation
    • rfgen.release_support_inventory
    • rfgen.benchmark_qualification
    • rfgen.quota_enforcement and rfgen.quota_runtime
    • Installed-wheel public surface
    • rfgen.errors

Background

  • Overview
    • Design Decisions
    • Sionna stack
    • RF Fingerprinting And SEI
    • Literature Review
    • Labeling Conventions in the RFML Field
    • Roadmap
    • Open Questions
    • Validation Strategy

Validation

  • Scientific validation reports
    • Scientific validation: TorchSig digital-constellation emitter
    • Scientific validation: linear-FM chirp radar emitter
    • Scientific validation: production radar transmit waveforms
    • Scientific validation: TorchSig FSK emitter
    • Scientific validation: TorchSig OFDM emitter
    • Scientific validation: TorchSig AM emitter
    • Scientific validation: emitters/torchsig_fm
    • Scientific validation: TorchSig chirp (comms) emitter
    • Scientific validation: CW tone emitter
    • Scientific validation: Device fingerprint sampler
    • Validation: transmitter power amplifier nonlinearity
    • Validation: tx_impairments/phase_noise
    • Validation: TX IQ imbalance, DAC quantization, and carrier-frequency offset
    • Scientific validation: additive white Gaussian noise channel
    • Scientific validation: receiver front-end mixer, IF filter, and resampler chain
    • Scientific validation: receiver thermal noise, ADC quantization, and automatic gain control
    • Validation: rx_frontend/phase_noise_iq
    • Calibrated stateful RF chain
    • RT material assets
    • Layer 3 Doc-vs-Impl Audit (2026-06-26)
Back to top
Copyright © 2026, Superpose
Made with Sphinx and @pradyunsg's Furo