# ns3-o-ran-e2

================================

This ns-3 module enables the support for running multiple terminations of an O-RAN-compliant E2 interface inside the simulation process. It has been developed as part of a collaborative effort between the [Institute for the Wireless Internet of Things (WIoT)](https://wiot.northeastern.edu) at Northeastern University, Mavenir, and the University of Padova.

## References

More information can be found in the paper

> A. Lacava, M. Polese, R. Sivaraj, R. Soundrarajan, B. S. Bhati, T. Singh, T. Zugno, F. Cuomo, T. Melodia "Programmable and Customized Intelligence for Traffic Steering in 5G Networks Using Open RAN Architectures" in arXiv:2209.14171 October 2022 [pdf](https://arxiv.org/pdf/2209.14171.pdf) [bibtex](https://ece.northeastern.edu/wineslab/wines_bibtex/andrea/LacavaAMC22.txt)

## How to use

This module can be used with an extension of the [ns3-mmWave module](https://github.com/nyuwireless-unipd/ns3-mmwave) that will soon be released. The module needs to be cloned in the contrib folder. The [e2sim library](https://github.com/o-ran-sc/sim-e2-interface) needs to be installed.

We will provide further instructions as part of this README file.

## Authors

The ns3-o-ran-e2 module is the result of the development effort carried out by different people. The main contributors are:

- Andrea Lacava, Northeastern University and Sapienza, University of Rome
- Michele Polese, Northeastern University
- Tommaso Zugno, University of Padova
- Rajarajan Sivaraj and team, Mavenir

We welcome contributions through pull requests. A contribution guide will be provided soon.