topology-programming

Install

Install the package with pip install . You may want to run this within a virtual environment.

Note: use pip version 22.3.1, do not use 23.1.2.

If you have a later version, you can use the command bellow. python -m pip install --upgrade pip==22.3.1

In later versions one dependency, tmgen will not install.

Run

The main program is src/onset/simulator.py

Examples that load and run the Simulation module are in scrips/.

The simulator can be run from the command line with src/onset/net_sim.py.

The command-line version of the program expects 3 arguments minimum.

1. A network name, this name should have a .gml or .json file containing the network graph in data/graphs/{gml, json}/ (the file suffix is not expected by the command line interpreter, the file should be one of these two folders/formats. First, the program will check for it in data/graphs/gml/, and if it's not there it will look in data/graphs/json/).
2. The number of nodes in the network.
3. A name for the experiment to run. This will inform the program where to save the output and results within data/results/.

There are more arguments that you may pass. Changing the set of parameters will also change the output file destination. A full list of arguments and their description can be viewed by running python src/onset/net_sim.py --help.