X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=code%2Fnetwork-generator%2FREADME.md;h=0f91dfb841a402d9cb9b715d8e0e2107d68e03dc;hb=75e7c88e53a85bad86adef4d0e717c1ef964ac74;hp=f07a3df42156e427c895107f726c2ebcf0a3479f;hpb=ac1ee96974203b526b2722210a3071bae836f6e6;p=oam.git diff --git a/code/network-generator/README.md b/code/network-generator/README.md index f07a3df..0f91dfb 100644 --- a/code/network-generator/README.md +++ b/code/network-generator/README.md @@ -7,7 +7,7 @@ Alliance architecture. Please note that a single 5G frequency represents a single sector, represents a single NRCellDU, represents a single O-RU, represents a single O-DU. -Each sector/cell covers an angel of 120° where the tower is represented by the +Each sector/cell covers an angle of 120° where the tower is represented by the center of a hexagon. 3 sectors/cells cover with azimuths [0°,120°,240°] cover an area around the tower. O-RUs are mounted add the tower. O-DUs are located in data center (o-cloud resource pool). @@ -22,16 +22,30 @@ $ python3 --version Python 3.10.12 ``` +For validation purposes libyang is recommended. +Please follow the libyang [installation instructions](https://github.com/CESNET/libyang). + ## Usage ``` -python3 network_generator.py config.json +python3 -m network_generation config.json ``` ## Output By default the generated files can be found in the 'output' folder: -- [network.json](output/network.json) -- [network.svg](output/network.svg) -- [network.kml](output/network.kml) +- [o-ran-network-operational.json](output/o-ran-network-operational.json) +- [o-ran-network.svg](output/o-ran-network.svg) +- [o-ran-network.kml](output/o-ran-network.kml) + + +## Output validation + +``` +yanglint -f json model/yang/ietf-network-topology.yang output/o-ran-network-operational.json +``` + +## Development + +Read the [CONTRIBUTING.md](CONTRIBUTING.md) file.