simulation

Module containing the Simulation class for representing a simulation.

Classes:

• Simulation –

  A class to represent a simulation.

Simulation

Simulation(
    bank: Bank | None = None,
    scenario_manager: ScenarioManager | None = None,
)

A class to represent a simulation.

Methods:

• reset –

  Reset the simulation state.

• set_scenario –

  Set the current scenario for the simulation.

Attributes:

• current_scenario (Scenario) –

  Get the current scenario.

• end_date (date) –

  Get the end date of the available scenarios.

current_scenario property

current_scenario: Scenario

Get the current scenario.

end_date property

end_date: date

Get the end date of the available scenarios.

reset

reset() -> None

Reset the simulation state.

set_scenario

set_scenario(date: date) -> None

Set the current scenario for the simulation.