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

Frequently Asked Questions

Q: Where can I download the Simu5G code?

A: Welcome on board! Visit this page to download Simu5G.

Q: What am I (not) allowed to do with Simu5G code?

A: Please read the license and readme within the download package.

Q: Should I cite any paper if I use Simu5G in an academic work?

A: Well, standard academic practice says you should. Like it or not, citations are the academic currency. Please see our papers page and cite the appropriate one(s). Please also read the "readme" file within the download package.

Q: Can I redistribute my own code that incorporates (some of) Simu5G's code?

A: You can do so within the terms of Simu5G's license. However, please note that this software is an academic product, just like papers are. If you build on someone else's scientific ideas, you will obviously cite their paper reporting these ideas.
Accordingly, if you re-distribute code that includes ours (in full or in part), the fact that you are doing so in full compliance to the license does not exempt you from also complying with standard academic practices regarding attribution and citation.
This means that it is still your duty to ensure that users of your software:

  1. are made aware that your software includes our work, and
  2. they will cite our paper(s) for correct attribution (along with your own work, possibly).
These requirements are easily met by including a reference to our paper(s) in the readme of your code.

Q: How is Simu5G different from the Vienna 5G SL simulator?

A: The Vienna 5G SL simulator is a MATLAB-based simulator that allows one to evaluate average PHY-layer performance by means of Monte Carlo simulations. A system-level version of it, called Vienna 5G System Level Simulator, allows one to trade accuracy for scale, thus enabling the evaluation of larger-scale networks in terms of average performance. This simulator is well tailored for the evaluation of lower-layer procedures, including signal-processing techniques. However, it cannot be used to evaluate multi-layer, end-to-end scenarios. On the other hand, Simu5G is a discrete-event, end-to-end, application-level simulator. You can model applications in it, and have endpoints communicate at the application layer with their packets traversing all the protocol layers, through arbitrarily complex network scenarios.

Q: How is Simu5G different from other end-to-end simulators, such as 5G LENA or 5G-air-simulator?

A: As far as we know, Simu5G is the only one to support the following features:

Q: Can I integrate Simu5G with other models, e.g., run a simulation where a WiFi host communicates with a 5G UE?

A: Simu5G is a model library for the OMNeT++ simulation framework. Any other model library written for OMNeT++ can be integrated with it. Notably, Simu5G makes extensive use of models from the INET framework (e.g., routers and hosts).

Q: Is Simu5G compatible with SimuLTE? Can I run simulations with both 4G and 5G nodes?

A: Yes and yes. More to the point, you can also run 5G simulations with ENDC deployments (i.e., a 4G eNB acting as a master and a 5G gNB acting as a slave). See the description page.

Q: What hardware is required to run Simu5G as an emulator?

A: An off-the-shelf desktop pc with two network interfaces can run an emulation of a multicell 5G network carrying application traffic up to several Mbps. See our demo in the emulation page.

Q: How do I get involved?

A: Cool! You have some choices here:

The Simu5G community is proud of you!