5G New Radio User Plane Simulation Model for INET & OMNeT++

Download this project as a .zip file Download this project as a tar.gz file

Install Guide

Obtaining Simu5G

You have three options to get Simu5G on your machine:

  • Download the Simu5G tarball (zip, tar.gz) including the latest stable release. This version requires OMNeT++ v5.6.2 and INET v4.2.2;
  • Download the latest code directly from the Simu5G repository on GitHub. This version requires OMNeT++ v6.0pre10 and INET v4.3.2. Note that this is the development branch, hence this version of the code might be unstable;
  • Download and run one of the Simu5G Plug-and-Play Virtual Machines.

If you selected one of the first two options, then read the following instructions.

Prerequisites

Simu5G can be compiled on any platform supported by OMNeT++ and INET frameworks.

You should have working OMNeT++ and INET Framework installations. See the required versions above, depending on the Simu5G version you selected.

Make sure your OMNeT++ installation works OK (e.g. try running the samples) and it is in the PATH environment variable (to test it, type the command "which nedtool" into the terminal). On Windows, open a console with the "mingwenv.cmd" command. The PATH and other variables will be automatically adjusted for you. Use this console to compile and run INET and Simu5G.

Install and test INET according to the installation instructions found in the archive. Be sure to check if the INET examples are running fine before continuing.

Building Simu5G from the IDE

  1. Extract the downloaded Simu5G tarball next to the "inet4" directory (i.e. into your workspace directory, if you are using the IDE).
  2. Start the IDE, and ensure that the 'inet' project is open and correctly built.
  3. Import the project using: File | Import | General | Existing projects into Workspace. Then select the workspace dir as the root directory, and be sure NOT to check the "Copy projects into workspace" box. Click Finish.
  4. You can build the project by pressing CTRL-B (Project | Build all)
  5. To run an example from the IDE, select the simulation example's folder under 'simulations', and click 'Run' on the toolbar.

Building Simu5G from the command line

  1. Extract the downloaded Simu5G tarball next to the "inet4" directory
  2. Change to the Simu5G directory.
  3. Type ". setenv". This will add the Simu5g/bin directory to the PATH environment variable.
  4. Type "make makefiles". This should generate the makefiles.
  5. Type "make" to build the Simu5G executable (debug version). Use "make MODE=release" to build release version.
  6. Run an examples by changing into one of the directories under 'simulations/NR', and executing "./run"
Prev: Guides