pysyncrosim.project.Project.scenarios

Project.scenarios(name=None, sid=None, optional=False, summary=None, results=False)

Retrieve a DataFrame of Scenarios in this Project.

Parameters:

  • name (String, optional) – Scenario name. The default is None.

  • sid (Int, optional) – Scenario ID. The default is None.

  • optional (Logical, optional) – Return optional information. The default is False.

  • summary (Logical, optional) – If set to False, then returns all Scenarios as SyncroSim Scenario instances. The default is None.

  • results (Logical, optional) – Return only a list of Results Scenarios. The default is False.

Returns:

If optional=False, then returns a DataFrame of Scenario information including Scenario ID, Project ID, Name, and Is Result. If optional=True, also returns Parent ID, Owner, Last Modified, Read Only, Merge Dependencies, Ignore Dependencies, and Auto Gen Tags.

Return type:

pandas.DataFrame