= Getting Started with !InterDigital 5G NR Performance System =

=== Desciption ===
In this tutorial we'll demonstrate how to use [wiki:/hardware/SubSystems/IDPerformance InterDigital 5G-NR Performance platform]

== Prerequisites ==
In order to access the test bed, create a reservation and have it approved by the reservation service. Access to the resources are granted after the reservation is confirmed. Please follow the process shown on [wiki:cosmos_workflow the COSMOS work flow page] to get started. 

== Set up ==

Follow the steps below to gain access to this console and set up your node with an appropriate image. 
 1. Sign up for a [https://cosmos-lab.org/portal-2/ COSMOS account]
 2. [Documentation/Short/CreateRes Create a resource reservation on sandbox 1]
 3. [Documentation/Short/Login Login into your reserved domain.]
 4. Load baseline_uhd.ndz on your resource. [Documentation/Short/LoadImage  - this is done via OMF commands.]

When opening a terminal into console.sb1.cosmos-lab.org set up a tunnel from localhost:8080 to srv3-lg1.sb1.cosmos-lab.org:3005. This will be used by the browser to connect to a web server running on the server nodes. Alternatively, follow the instructions to establish a VPN tunnel to the [wiki:/Documentation/VPN COSMOS sandbox 1].

== Execution ==
=== Prepare the nodes ===


=== Configure Routing on compute nodes ===

 * Execute NR gNB setup script on srv3-lg1
{{{
userid@console:~$ ssh root@srv3-lg1.sb1.cosmos-lab.org
root@srv3-lg1:~$ cd /home/native/NR/scripts
root@srv3-lg1:/home/native/NR/scripts# ./setup_bs.sh
}}}

 * Execute NR UE setup script on srv4-lg1. 
{{{
userid@console:~$ ssh root@srv4-lg1.sb1.cosmos-lab.org
root@srv4-lg1:~$ cd /home/native/NR/scripts
root@srv4-lg1:/home/native/NR/scripts# ./setup_ue.sh
}}}

=== Start modem executables ===
 * SSH to the gNB MPU from “srv3-lg1.sb1.cosmos-lab.org”
{{{
root@srv3-lg1:~# ssh root@192.168.1.2 
(when prompted for a password use: root)
Start the NR gNB L1 & L23 executables
root@NR-SW-MPU:~# ./start_all.sh
}}}

 * SSH to the UE MPU from “srv4-lg1.sb1.cosmos-lab.org”
{{{
root@srv4-lg1:~# ssh root@192.168.2.3 
(when prompted for a password use: root)
Start the NR UE L1 & L23 executables
root@NR-SW-MPU:~# ./start_all.sh
}}}

The NR Platform will automatically “connect” a link between the gNB and UR.  This can be verified via the NR GUI

=== Halt the modem executables ===

The L1 executable should be stopped before terminating the L23 executable 
{{{
root@NR-SW-MPU:~# ./stop_L1.sh
}}}

In the session used to initially start the executables (gNB or UE) enter “ctrl C” to stop the L23 executable


=== NR GUI Setup & Instructions ===
Note that the GUI web server has already been started during Linux startup.

!!!!! ADD INstructions for ssh tunneling and/or VPN !!!!

=== Sending iperf data between the gNB and UE ===
The following commands are provided as an example of how to send Downlink iperf data traffic on the NR 28GHz mmW OTA link via the compute machines that are attached to the gNB and UE platforms

 * Open the 3rd “srv4-lg1” console session to the UE
{{{
console> ssh root@srv4-lg1.sb1.cosmos-lab.org
root@srv4-lg1:~#iperf3 -s -i 1
}}}

 * Open the 3rd “srv3-lg1” console session to the gNB 
{{{
console> ssh root@srv3-lg1.sb1.cosmos-lab.org
root@srv3-lg1:~# iperf3 -c 192.168.2.4 -i 1 -u -b 86M -l 1472 -t 3600
}}}

=== Analyze the NR link performance via the NR GUI ===

[[Image(NR-gui.png)]]