README.md

   1 # ns3-o-ran-e2
   2
   3 ================================
   4
   5 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.
   6
   7 ## References
   8
   9 More information can be found in the paper
  10
  11 > 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)
  12
  13 ## How to use
  14
  15 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.
  16
  17 We will provide further instructions as part of this README file.
  18
  19 ## Authors
  20
  21 The ns3-o-ran-e2 module is the result of the development effort carried out by different people. The main contributors are:
  22
  23 - Andrea Lacava, Northeastern University and Sapienza, University of Rome
  24 - Michele Polese, Northeastern University
  25 - Tommaso Zugno, University of Padova
  26 - Rajarajan Sivaraj and team, Mavenir
  27
  28 We welcome contributions through pull requests. A contribution guide will be provided soon.