code/network-generator/README.md

   1 # Network Generator
   2
   3 This projects generates a view of a telecommunication network composed of RAN,
   4 Transport, 5G-Core, O-Cloud and SMO functions associated with the O-RAN
   5 Alliance architecture.
   6
   7 Please note that a single 5G frequency represents a single sector, represents
   8 a single NRCellDU, represents a single O-RU, represents a single O-DU.
   9
  10 Each sector/cell covers an angel of 120° where the tower is represented by the
  11 center of a hexagon. 3 sectors/cells cover with azimuths [0°,120°,240°] cover
  12 an area around the tower. O-RUs are mounted add the tower. O-DUs are located in
  13 data center (o-cloud resource pool).
  14
  15 ## Prerequisites
  16
  17 ```
  18 $ cat /etc/os-release | grep -oP 'PRETTY_NAME="\K[^"]+'
  19 Ubuntu 22.04.3 LTS
  20
  21 $ python3 --version
  22 Python 3.10.12
  23 ```
  24
  25 ## Usage
  26
  27 ```
  28 python3 network_generator.py config.json
  29 ```
  30
  31 ## Output
  32
  33 By default the generated files can be found in the 'output' folder:
  34
  35 - [network.json](output/network.json)
  36 - [network.svg](output/network.svg)
  37 - [network.kml](output/network.kml)