It is distributed under OAI Public License V1.1.
The license information is distributed under LICENSE file in the same directory.
Please see NOTICE file for third party software that is included in the sources.
- General overview of documentation
- The implemented features
- System Requirements for Using OAI Stack
- How to build
- How to run the modems
Not all information is available in a central place, and information for specific sub-systems might be available in the corresponding sub-directories. To find all READMEs, this command might be handy:
find . -iname "readme*"
Note: This section and the
exec_config/,exec_dir/, andexec_scripts/directories were added by Goodsol Lee (@goodsollee) on top of upstream OpenAirInterface. They are not part of the official OAI distribution.
These utilities provide a streamlined way to bring up a full 5G SA network end
to end — the OAI 5G core, a gNB, and one or more nr-UEs — in either RF
simulation (--rfsim) or over a USRP, with optional channel emulation.
| Path | Purpose |
|---|---|
exec_config/ |
Ready-to-use gNB/eNB/UE .conf files for many scenarios (RFsim, USRP B210/X300/N300, SA/NSA, bands n78/n41/n66/b7, open5gs core, dual connectivity). |
exec_dir/cn/ |
OAI 5G Core Network deployment via docker-compose (MySQL subscriber DB, gNB configs, resources). Based on the OAI 5G Core Summer Workshop 2023 — see exec_dir/cn/README.md. |
exec_dir/multi-ue.sh |
Creates a Linux network namespace (veth pair) per UE so multiple nr-UEs can run isolated on one host. |
exec_scripts/ |
Convenience wrappers to build and run each component (below) plus channel-emulation helpers. |
Run the scripts from inside exec_scripts/:
cd exec_scripts
# 1. Build OAI (eNB/gNB/nrUE with USRP support). On the first build, add -I to
# install dependencies (see the commented line in build.sh).
./build.sh
# 2. Start the OAI 5G core network (docker-compose); stop it with ./cn_stop.sh.
./cn_start.sh
# 3. Start the gNB (RF simulator by default; edit the script for USRP).
./gnb_start.sh
# 4. Start a UE in its own network namespace (prompts for a UE index).
./ue_start.sh # stop with ./ue_stop.sh
# 5. (Optional) Configure routing/DNS inside the UE namespace.
sudo ./ue_routing.sh
# 6. (Optional) Start the FlexRIC near-RT RIC (E2).
./ric_start.shThe RF simulator's channel model can be driven at runtime over its telnet interface:
channel_emul.pygenerates a random-walk channel trace intochannel_trace/traces.csv.channel_mod.pyreads per-UE SNR traces (channel_trace/snr<N>.csv) and periodically injectschannelmod modify <ue> noise_power_dB <value>into a running gNB (telnet0.0.0.0:9090), so each UE sees a time-varying channel.
Launch the gNB with the telnet server and channel model enabled (e.g.
--telnetsrv ... --rfsimulator.options chanmod); see the commented examples in
exec_scripts/gnb_start.sh and exec_scripts/ue_start.sh.
The OpenAirInterface (OAI) software is composed of the following parts:
openairinterface5g
├── charts
├── ci-scripts : Meta-scripts used by the OSA CI process. Contains also configuration files used day-to-day by CI.
├── CMakeLists.txt : Top-level CMakeLists.txt for building
├── cmake_targets : Build utilities to compile (simulation, emulation and real-time platforms), and generated build files.
├── common : Some common OAI utilities, some other tools can be found at openair2/UTILS.
├── doc : Documentation
├── docker : Dockerfiles to build for Ubuntu and RHEL
├── executables : Top-level executable source files (gNB, eNB, ...)
├── maketags : Script to generate emacs tags.
├── nfapi : (n)FAPI code for MAC-PHY interface
├── openair1 : Layer 1 (3GPP LTE Rel-10/12 PHY, NR Rel-15 PHY)
├── openair2 : Layer 2 (3GPP LTE Rel-10 MAC/RLC/PDCP/RRC/X2AP, LTE Rel-14 M2AP, NR Rel-15+ MAC/RLC/PDCP/SDAP/RRC/X2AP/F1AP/E1AP), E2AP
├── openair3 : Layer 3 (3GPP LTE Rel-10 S1AP/GTP, NR Rel-15 NGAP/GTP)
├── openshift : OpenShift helm charts for some deployment options of OAI
├── radio : Drivers for various radios such as USRP, AW2S, RFsim, 7.2 FHI, ...
├── targets : Some configuration files; only historical relevance, and might be deleted in the future
└── tools : Tools for use by the developers/ci machines: code analysis and formatting
You can ask your question on the mailing lists.
Your email should contain below information:
- A clear subject in your email.
- For all the queries there should be [Query] in the subject of the email and for problems there should be [Problem].
- In case of a problem, add a small description.
- Do not share any photos unless you want to share a diagram.
- OAI gNB/DU/CU/CU-CP/CU-UP configuration file in
.confformat only. - Logs of OAI gNB/DU/CU/CU-CP/CU-UP in
.logor.txtformat only. - In case your question is related to performance, include a small description of the machine (Operating System, Kernel version, CPU, RAM and networking card) and diagram of your testing environment.
- Known/open issues are present on GitLab, so keep checking.
Always remember a structured email will help us understand your issues quickly.
