Simulation

Overview:

SimulationController

class branchpro.SimulationController(model, start_sim_time, end_sim_time)[source]

SimulationController Class: Class for the simulation of models in any of the subclasses in the ForwardModel.

Parameters:

  • model – (ForwardModel) Instance of the ForwardModel class used for the simulation.

  • start_sim_time – (integer) Time from which we start running the SimulationController.

  • end_sim_time – (integer) Time at which we stop running the SimulationController.

Notes

Always apply method switch_resolution before calling SimulationController.run() for a change of resolution!

run(parameters)[source]

Operates the simulate method present in any subclass of the ForwardModel.

Parameters:

parameters – An ordered sequence of parameter values.

switch_resolution(num_points)[source]

Change the number of points we wish to keep from our simulated sample of incidences.

Parameters:

num_points – (integer) number of points we wish to keep from our simulated sample of incidences.