-
Notifications
You must be signed in to change notification settings - Fork 0
Home
This page's aim is to make you familiar with the syntax used for creating your experiment in netlab. For information on how to install netlab, please see our README.md. If you want to contribute, please have a look at CONTRIBUTING.md for information on how to do that and how the code is structured.
netlab is here to make your life a lot easier. Thus we tried to keep creating new experiments as simple and intuitive as possible. With that in mind, some specialized parameters might be missing in our syntax – feel free to give us feedback or open an issue or PR if you think they should be added.
The file used for loading your experiment has to follow TOML syntax. Generally speaking, it is divided in these parts. To keep the documentation compact, they all have their own sub-pages with detailed explaination and examples.
- general experiment info (such as name, run time, etc.)
- networks
- node groups
- event generators
All keys are case-insensitive. Therefore, e.g. Name = "Test" and name = "Test" have the same effect. Wherever you do not specify a value, the default value is applied. If you enable debug logging (by adding the -d flag) you can see, which fields are concerned.
You can find some examples from minimal to exceedingly complex in the examples folder.