Skip to content

Supported API

Public imports describe telecom capabilities. Compiled implementation modules, worker names, OAI source paths, and build targets are private.

Main workflow owners

Entry point Purpose
oai_python.bindings.nr.phy.link.NrPhyLink Persistent MAC-independent SISO PHY link
oai_python.bindings.nr.phy.stack.NrPhyStack Preconfigured one-UE MAC plus real-PHY stack
oai_python.bindings.nr.mac.link.UeGnbLink Persistent 1–16 UE abstract MAC/FAPI simulation
oai_python.bindings.nr.mac.gnb.scheduler_sdk.OpenGnbMac OAI scheduler owner with an optional Python policy seam
oai_python.bindings.nr.multicell.IndependentMultiCell Several isolated attributed cell owners

Every persistent owner is a context manager. Results and observations are owned Python values or copied arrays; native borrowed pointers are not part of the public API.

Granular capability roots

The 0.1 wheel exposes ten roots:

coding  common  security  uicc  nr
nas     fapi    nfapi     signaling  oran

Examples of stable semantic leaves include:

from oai_python.bindings.coding.crc import crc24a
from oai_python.bindings.nr.phy.pusch import GnbPuschReceiver, PuschConfig
from oai_python.bindings.nr.phy.ulsch.transmit import UlschTransmitter
from oai_python.bindings.fapi.p7 import pack_slot_indication

The installed .pyi files are the signature authority for arguments, return types, dtypes, shapes, errors, ownership, and lifecycle. IDE completion and static type checkers read the same declarations shipped with the wheel.

Compatibility promise

oai_python.bindings is the only public backend in 0.1. Applications select it explicitly in the import path; there is no runtime selector or fallback. Semantic public paths are stable within the 0.1 series. Private modules begin with _ and may change without notice.

The bindings are curated adapters over one pinned OAI revision. A project composition such as NrPhyLink owns lifecycle, validation, copying, isolation, and slot orchestration while its telecom outcomes come from the reviewed OAI operations. It is not presented as an upstream OAI C API.

See coverage and support tiers before treating an importable reference-only codec as a supported workflow.