siminterface package¶
Submodules¶
siminterface.simulator module¶
-
class
siminterface.simulator.
Simulator
¶ Bases:
spinterface.spinterface.SimulatorInterface
-
apply
(actions: spinterface.spinterface.SimulatorAction)¶ Applies set of actions.
actions: SimulationAction
state: SimulationStateInterface
-
init
(network_file, service_functions_file, config_file, seed)¶ Creates a new simulation environment.
- network_file : str
- (Absolute) path to the network description.
- service_functions_file : str
- (Absolute) path to the service function description file.
- config_file : str
- Config file with parameter settings for the simulator (eg, seed, flow inter-arrival times, …)
- seed : int
- Seed for reproducible randomness
state: SimulationStateInterface
-
network_metrics
()¶ Processes the metrics and parses them in a format specified in the SimulatorState class.
-
parse_network
() → dict¶ Converts the NetworkX network in the simulator to a dict in a format specified in the SimulatorState class.
-
Module contents¶
-
class
siminterface.
Simulator
¶ Bases:
spinterface.spinterface.SimulatorInterface
-
apply
(actions: spinterface.spinterface.SimulatorAction)¶ Applies set of actions.
actions: SimulationAction
state: SimulationStateInterface
-
init
(network_file, service_functions_file, config_file, seed)¶ Creates a new simulation environment.
- network_file : str
- (Absolute) path to the network description.
- service_functions_file : str
- (Absolute) path to the service function description file.
- config_file : str
- Config file with parameter settings for the simulator (eg, seed, flow inter-arrival times, …)
- seed : int
- Seed for reproducible randomness
state: SimulationStateInterface
-
network_metrics
()¶ Processes the metrics and parses them in a format specified in the SimulatorState class.
-
parse_network
() → dict¶ Converts the NetworkX network in the simulator to a dict in a format specified in the SimulatorState class.
-