pymgipsim.Utilities.Scenario

class scenario(settings: settings, input_generation: input_generation, inputs: inputs, patient: patient, controller: controller)[source]

Bases: object

Stores all the necessary information to uniquely define a simulation.

Mirrors the scenario JSON file.

Note

Undefined/ not required field are None.

Parameters:

  • settings (settings) – General, simulator wide settings.

  • input_generation (input_generation) – Defines parameters for random input generation.

  • inputs (inputs) – Defines the events (start time, magnitude and duration) of specific inputs.

  • patient (patient) – Describes the simulated virtual cohort.