mrahman2-vt / srsran_project

Open source O-RAN 5G CU/DU solution from Software Radio Systems (SRS) https://docs.srsran.com/projects/project

srsRAN Project

The srsRAN Project is a complete 5G RAN solution, featuring an ORAN-native CU/DU developed by SRS.

The solution includes a complete L1/2/3 implementation with minimal external dependencies. Portable across processor architectures, the software has been optimized for x86 and ARM. srsRAN follows the 3GPP 5G system architecture implementing the functional splits between distributed unit (DU) and centralized unit (CU). The CU is further disaggregated into control plane (CU-CP) and user-plane (CU-UP).

See the srsRAN Project for information, guides and project news.

For build instructions and user guides see the srsRAN Project documentation.

For community announcements and support, join our discussion board.

Features and Roadmap

For application features and feature roadmap see here.

License

For license details, see LICENSE file.

Build Preparation

• Build tools:

  • cmake: https://cmake.org/

• Mandatory requirements:

  • libfftw: https://www.fftw.org/
  • libsctp: https://github.com/sctp/lksctp-tools
  • yaml-cpp: https://github.com/jbeder/yaml-cpp
  • PolarSSL/mbedTLS: https://www.trustedfirmware.org/projects/mbed-tls/
  • googletest: https://github.com/google/googletest/
    • You can skip test building by using the cmake option -DBUILD_TESTS=OFF. GoogleTest is not mandatory when building without tests.

You can install the build tools and mandatory requirements for some example distributions with the commands below:

Ubuntu 22.04

sudo apt-get install cmake make gcc g++ pkg-config libfftw3-dev libmbedtls-dev libsctp-dev libyaml-cpp-dev libgtest-dev

Fedora

sudo yum install cmake make gcc gcc-c++ fftw-devel lksctp-tools-devel yaml-cpp-devel mbedtls-devel gtest-devel

Arch Linux

sudo pacman -S cmake make base-devel fftw mbedtls yaml-cpp lksctp-tools gtest

The srsRAN Project uses RF drivers to support different radio types. Currently, only UHD is supported however additional drivers are under development:

• RF driver:
  • UHD: https://github.com/EttusResearch/uhd
    • See UHD documentation for installation instructions.

Build Instructions

Download and build srsRAN:

git clone https://github.com/srsran/srsRAN_Project.git
cd srsRAN_Project
mkdir build
cd build
cmake ..
make
make test

Run PHY testvector tests:

A number of PHY tests are based on MATLAB generated testvectors. By default, those tests are disabled. The following steps are required to enable them:

1. Download the PHY testvector set.
2. Copy the PHY testvectors to its location within srsRAN:

tar -xzf phy_testvectors.tar.gz -C /path_to_your_local_repository/srsgnb/

3. Enable the use of PHY testvectors by modifying the root CMakeLists as shown below:

option(USE_PHY_TESTVECTORS   "Enable testvector PHY tests"              ON)

4. Do a fresh srsRAN build.