maki/openairinterface5g
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Standardize documentation headings (remove multiple # H1)

Browse Source 
- Remove multiple single top-level (# H1) headings per file
 - Use (# H2 and ###### H6) sub-headings for consistency
 - Remove any trailing # in the headings
 - This ensures proper table of contents rendering in MkDocs.

 - Also removed RUN_NR_multiple_BWPs.md as it is moved to MAC usage
This commit is contained in:
Robert Schmidt
2026-01-22 10:55:05 +01:00
committed by Shubhika Garg
parent a9ba6290b9
commit 5c480ffd50
36 changed files with 489 additions and 482 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/system_requirements.md
+13 -13
View File
@@ -18,7 +18,7 @@ This document describes the minimal and performant system requirements for OpenA
[[_TOC_]]
# Supported CPU Architecture
## Supported CPU Architecture
|Architecture |
|------------------------------------------ |
@@ -29,7 +29,7 @@ This document describes the minimal and performant system requirements for OpenA
- On `x86_64` platform the CPU should support `avx2` instruction set (Minimum requirement).
# Supported Operating System
## Supported Operating System
|Operating System |
|-----------------|
@@ -40,17 +40,17 @@ This document describes the minimal and performant system requirements for OpenA
|Rocky 9 |
# Minimum Hardware Requirement for x86_64 Platforms
## Minimum Hardware Requirement for x86_64 Platforms
The minimum hardware requirements depends on the radio unit you would like to use or the test case that you would like to execute.
## Simulated Radio
### Simulated Radio
OAI offers an inbuilt simulated radio, [RFSimulator](../radio/rfsimulator/README.md). It can be used to familiarize oneself with OAI, for development and debugging, and offers the possibility to use basic channel models. It is not designed to do high performance testing. The below requirements are valid for both 4G and 5G RAN and UE Stack.
The following requirements are minimum requirements for all use cases:
### Minimum requirements for gNB Stack
#### Minimum requirements for gNB Stack
- CPU: 2
- Minimum frequency > 2GHz
@@ -61,7 +61,7 @@ The following requirements are minimum requirements for all use cases:
**NOTE**: We have not tested on Intel Atom or Celeron processors, and they
likely won't work well.
### Minimum requirements for UE Stack
#### Minimum requirements for UE Stack
- CPU: 2
- Minimum frequency > 2GHz
@@ -70,13 +70,13 @@ likely won't work well.
**NOTE**: We have not tested on Intel Atom or Celeron processors
## USRP B2XX or Blade RF
### USRP B2XX or Blade RF
USRP B2XX or Blade RF are USB based radios recommended to use with USB 3.0. You can choose a minimum hardware to do functional testing and performance hardware for performance testing. This hardware you can find in Mini-PCs or laptops.
The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
### Minimum requirements for both gNB and UE Stack
#### Minimum requirements for both gNB and UE Stack
- CPU: 3
- Memory: 5Gi
@@ -84,7 +84,7 @@ The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
- USB 3.0
- Intel i5, AMD Ryzen 5
### Recommended for performance for gNB and UE Stack
#### Recommended for performance for gNB and UE Stack
- CPU: 4
- Boost Frequency > 3GHz
@@ -97,7 +97,7 @@ The minimum requirements stated in [simulated radio](.##simulated-radio) apply.
Apart from this you should follow [tuning and security tips](./tuning_and_security.md) to
tune your system to get high performance.
## USRP N3XX/X3XX/X4XX/AW2S
### USRP N3XX/X3XX/X4XX/AW2S
USRP N3XX/X3XX/X4XX requires two dedicated 10G SFP+ connections. For these radios we only recommend having performance hardware. This hardware you can find in Desktop servers or rack/blade servers. For the gNB, the same applies in case of using AW2S radios.
@@ -108,7 +108,7 @@ tune your system to get high performance.
**NOTE**: In case you are using Mellanox NIC cards then you have to download `mlnx-ofed` and configure your NIC for performance.
### Recommended for performance for gNB Stack
#### Recommended for performance for gNB Stack
- CPU: 8-10
- Boost Frequency > 4GHz
@@ -118,7 +118,7 @@ tune your system to get high performance.
- (Optional) Realtime kernel to have better Jitter statistics
- Intel x710/xx710/E-810 or Mellanox connect 5x or 6x
### Recommended for performance for UE Stack
#### Recommended for performance for UE Stack
- CPU: 4
- Boost Frequency > 4GHz
@@ -128,7 +128,7 @@ tune your system to get high performance.
- (Optional) Realtime kernel to have better Jitter statistics
- Intel x710/xx710/E-810 or Mellanox connect 5x or 6x
## O-RAN Radio Units
### O-RAN Radio Units
We have dedicated documentation for O-RAN Radio Units. [Refer to 7.2 FH documentation](./ORAN_FHI7.2_Tutorial.md) before purchasing a Desktop server or rack/blade server.