NIST 5G Open-Source Testbed Automation Tool

The automation tool is designed to support diverse software components for 5G O-RAN testbeds. It provides a framework for deploying and configuring these components, allowing users to quickly set up and test different configurations. The automation scripts are primarily written in Linux shell, C/C++, and Python, and are designed to be modular and extensible. This allows users to configure the components to meet specific requirements, and add components as needed.

Below is a list of the software components that are supported by this automation tool. The list may change over time as new components are added or existing components are updated. The software components are grouped by their function in the 5G O-RAN testbed.

Additionally, the diagram below illustrates the connectivity between the components that have been experimentally verified. The components are grouped by their function in the 5G O-RAN testbed. The lines connecting the components indicate the communication paths between them. A solid line indicates a default configuration, a dashed line indicates a configuration that requires additional configuration changes to be operational, and a dashed red line indicates a configuration not yet supported in the default tool, but which is under active or planned development.

• Certain equipment, instruments, software, or materials are identified on this site in order to specify the experimental procedures adequately. Such identification is not intended to imply recommendation or endorsement of any product or service by NIST, nor is it intended to imply that the materials or equipment identified are necessarily the best available for the purpose.

System/Platform Requirements

The automation tool is designed to be run on a Linux-based operating system, specifically distro flavors based on Ubuntu 20.04 LTS, Ubuntu 22.04 LTS, and Ubuntu 24.04 LTS. The tool requires a minimum of 35 GB of hard drive storage, 6 GB of base memory (RAM), and at least two processors (with 6 processors recommended). A stable internet connection is required during the installation process to ensure that all necessary dependencies can be downloaded and installed successfully.

Licensing Information

NIST-developed software is provided by NIST as a public service. You may use, copy and distribute copies of the software in any medium, provided that you keep intact this entire notice. You may improve, modify and create derivative works of the software or any portion of the software, and you may copy and distribute such modifications or works. Modified works should carry a notice stating that you changed the software and should note the date and nature of any such change. Please explicitly acknowledge the National Institute of Standards and Technology as the source of the software.   See full NIST Software Disclaimer for further details.

Disclaimers

NIST-developed software is expressly provided "AS IS." NIST MAKES NO WARRANTY OF ANY KIND, EXPRESS, IMPLIED, IN FACT OR ARISING BY OPERATION OF LAW, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT AND DATA ACCURACY. NIST NEITHER REPRESENTS NOR WARRANTS THAT THE OPERATION OF THE SOFTWARE WILL BE UNINTERRUPTED OR ERROR-FREE, OR THAT ANY DEFECTS WILL BE CORRECTED. NIST DOES NOT WARRANT OR MAKE ANY REPRESENTATIONS REGARDING THE USE OF THE SOFTWARE OR THE RESULTS THEREOF, INCLUDING BUT NOT LIMITED TO THE CORRECTNESS, ACCURACY, RELIABILITY, OR USEFULNESS OF THE SOFTWARE.

See full NIST Software Disclaimer.