Install Guide

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.

Obtaining Simu5G

Latest release: Simu5G 1.2.2.

In order to get Simu5G on your machine, you have the following options:

1. Download and install Simu5G directly from the OMNeT++ IDE
2. Download the source code and build Simu5G manually
3. Download and run Simu5G Plug-and-Play.

1) Download and install Simu5G from the OMNeT++ IDE

This is the easiest way to get Simu5G:

1. Open the OMNeT++ IDE on your machine and make sure that the 'inet4.5' project is open and correctly built in your workspace
2. In the menu bar, click Help | Install Simulation Models... | Select Simu5G 1.2.2 and click Install Project
3. Wait until the building process is complete. This may take up several minutes.

Back to top

2) Download and build the source code

Download the Simu5G tarball including the latest stable release (zip, tar.gz). This version requires OMNeT++ v6.0 and INET v4.5. For previous releases, visit this link.

Alternatively, you can download the most recent code directly from the Simu5G repository on GitHub. Current master branch requires OMNeT++ v6.0 and INET v4.5. Note: this is the development branch, hence this version of the code might be unstable;

Building from the OMNeT++ IDE

1. Extract the downloaded Simu5G tarball next to the "inet4.5" directory (i.e. into your workspace directory, if you are using the IDE).
2. Start the IDE, and ensure that the 'inet4.5' 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 from the command line

1. Extract the downloaded Simu5G tarball next to the "inet4.5" 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"

Back to top

3) Simu5G Plug-and-Play

If you cannot wait to try Simu5G... COOL! You are in the right place!

You can download the following Virtual Machine appliance, import it into your favorite virtualization software (e.g. Oracle Virtualbox, VMWare Player), and start simulating! You do not need to carry out the complete installation procedure, we already did the boring stuff for you ;)

This guide assumes you have Oracle Virtualbox 6.1 installed on your machine.

1. Download Simu5G PnP from here.
   This VM includes Ubuntu 20.04, with OMNeT++ 6.0, INET 4.4.0, Simu5G 1.2.1. We also included Veins 5.2 in case you want to simulate 5G-enabled vehicular networks.
2. Open Virtualbox, then click File -> Import Appliance...
3. In the dialog window, browse your file system and select the downloaded file (with .ova extension). Then, click Next.
4. Check the VM configuration, then click Import.
5. Select the new VM on the left side of the Virtualbox main window, then click Start.

Back to top

Prev: Guides