From 4b0acaa31536ef855805765f118609e802865b89 Mon Sep 17 00:00:00 2001 From: mychele Date: Thu, 9 Dec 2021 09:42:07 -0500 Subject: [PATCH] Update README --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f2ec51..5d84b43 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Colosseum Near-Real-Time RIC This is a minimal version of the O-RAN Software Community near-real-time RIC (Bronze release) adapted and extended to work on the [Colosseum](https://www.colosseum.net/) wireless network emulator. -The scripts in this repository will start a minimal near-real-time RIC in the form of Docker containers (namely, `dbaas`, `e2mgr`, `e2rtmansim`, `e2term`). +The scripts in this repository will start a minimal near-real-time RIC in the form of Docker containers (namely, `db`, `e2mgr`, `e2rtmansim`, `e2term`). The repository also features a sample xApp, which connects to the [SCOPE](https://github.com/wineslab/colosseum-scope) RAN environment through the following [E2 termination](https://github.com/wineslab/colosseum-scope-e2). If you use this software, please reference the following paper: @@ -57,7 +57,7 @@ From the `setup-scripts` directory: The `setup-scripts` directory contains scripts to initialize the near-real-time RIC on Colosseum. - `import-base-images.sh`: script to import the base Docker images needed to build the RIC Docker containers. These images are provided as part of the XXX Colosseum LXC container. - `setup-lib.sh`: contains the IP addresses and ports used by the Docker containers of this repository. This script has been adapted from [here](https://gitlab.flux.utah.edu/johnsond/ric-profile/-/blob/master/setup-lib.sh) -- `setup-ric.sh`: script to build, configure, and start the near-real-time RIC containers of this repository (namely, `dbaas`, `e2mgr`, `e2rtmansim`, `e2term`). This script has been adapted from [here](https://gitlab.flux.utah.edu/johnsond/ric-profile/-/blob/master/setup-ric.sh) +- `setup-ric.sh`: script to build, configure, and start the near-real-time RIC containers of this repository (namely, `db`, `e2mgr`, `e2rtmansim`, `e2term`). This script has been adapted from [here](https://gitlab.flux.utah.edu/johnsond/ric-profile/-/blob/master/setup-ric.sh) - `start-ric-arena.sh`: script to start the near-real-time RIC on external testbeds, e.g., on the [Arena platform](https://ece.northeastern.edu/wineslab/arena.php) - `setup-sample-xapp.sh`: script to setup a sample xApp Docker container. This xApp is capable of connecting to the [SCOPE](https://github.com/wineslab/colosseum-scope) RAN environment through the following [E2 termination](https://github.com/wineslab/colosseum-scope-e2). Custom or standard-compliant service models can be implemented on top of the RAN E2 termination and the sample xApp, as done for example [in these]() [papers](https://ece.northeastern.edu/wineslab/papers/bonati2021intelligence.pdf) - `start-xapp.sh`: script to configure and start the sample xApp. The ID of the gNB targeted by the xApp needs to be provided in the script, as discussed below @@ -65,7 +65,7 @@ The `setup-scripts` directory contains scripts to initialize the near-real-time ### setup directory This directory contains the implementations of the near-real-time RIC Docker container initialized through the scripts in the [`setup-scripts`](setup-scripts) directory. -- `dbaas`: implementation of a Redis database (`dbaas`) container +- `dbaas`: implementation of a Redis database (`db`) container - `e2`: implementation of the E2 termination (`e2term`) container - `e2mgr`: implementation of the E2 manager (`e2mgr`) and of the routing manager simulator (`e2rtmansim`) container - `sample-xapp`, `xapp-bs-connector`: implementation of the sample xApp provided in this repository and components to connect to the near-real-time RIC and [SCOPE](https://github.com/wineslab/colosseum-scope) RAN environment