pysyncrosim.library.Library.run

Library.run(scenarios=None, project=None, copy_external_inputs=False)

Runs a list of Scenario objects.

Parameters:

  • scenarios (Scenario, String, Int, or List) – List of Scenrios, SyncroSim Scenario instance, name of Scenario, or Scenario ID.

  • project (Project, optional) – SyncroSim Project instance, name of Project, or Project ID.

  • copy_external_inputs (Logical, optional) – If False, then a copy of external input files (e.g. GeoTIFF files) is not created for each job. Otherwise, a copy of external inputs is created for each job. Applies only when jobs > 1. The number of jobs is set using the ‘core_Multiprocessing’ datasheet. The default is False.

Returns:

result_dict – Dictionary of Results Scenarios.

Return type:

Dictionary