From 7de74a6f0fecbab2de342213205e33c77b839997 Mon Sep 17 00:00:00 2001 From: Martin Skorupski Date: Fri, 3 Nov 2023 11:45:42 +0100 Subject: [PATCH] Add hint for output validation - new chapter for output validation - hint in Prerequisites section added Issue-ID: OAM-379 Change-Id: Ifb9c25f8cf4728e7171fed8cc5f41009d5129eef Signed-off-by: Martin Skorupski --- code/network-generator/README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/code/network-generator/README.md b/code/network-generator/README.md index f07a3df..11851c8 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,6 +22,9 @@ $ python3 --version Python 3.10.12 ``` +For validation purposes libyang is recommended. +Please follow the libyang [installation instructions](https://github.com/CESNET/libyang). + ## Usage ``` @@ -32,6 +35,17 @@ python3 network_generator.py config.json 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. -- 2.16.6