vacp2p
/
wakurtosis
mirror of https://github.com/vacp2p/wakurtosis.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated gennet readme

This commit is contained in:
Alberto Soutullo 2023-01-22 19:46:23 +01:00
parent 3e637d6f76
commit ca372f1a3e
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
gennet-module/Readme.md
View File

@ -1,5 +1,4 @@
Module to generate network models (in JSON) and waku configuration files (in TOMLs) for wakurtosis runs.
Module to generate network models (in JSON) and node configuration files (in TOMLs) for wakurtosis runs.
## generate_network.py
generate_network.py generates one network and per-node configuration files. The tool is configurable with specified number of nodes, topics, network types, node types and number of subnets.
@ -39,6 +38,16 @@ Example of configuration file:
}
```
It has also a Dockerfile to run it in a docker container. Example assuming our configiguration file is in `config` folder:
```commandline
> docker build -t gennet .
> docker run --name gennet-container -v ${dir}/config/:/config gennet --config-file /config/my_config_file.json --output-dir /config/topology_generated
```
In this way, it will mount `config` as a volume, allowing the docker container to get our `my_config_file.json`, and writing the results on a new folder called `topology_generated` which as it will be in `config`, the host will have access to it.
## batch_gen.sh
batch_gen.sh can generate given number of Waku networks and outputs them to a directory. Please make sure that the output directory does NOT exist; both relative and absolute paths work. The Wakunode parameters are generated at random; edit the MIN and MAX for finer control. The script requires bc & /dev/urandom.<br>