deflex.restore_scenario

deflex.restore_scenario(filename, scenario_class=<class 'deflex.scenario.DeflexScenario'>)[source]

Restore a full Scenario from a dump file (.dflx).

If only the results are needed use restore_results() instead. By default a DeflexScenario is created but a different Scenario class can be passed The Scenario has to be equal to the dumped Scenario otherwise the restore will fail.

Parameters:
  • filename (str) – The path to the dumped file (.dflx).
  • scenario_class (class) – A child of the deflex.Scenario class or the Scenario class itself.
Returns:

Return type:

deflex.Scenario