pysyncrosim.library.Library.projects

Library.projects(name=None, pid=None, summary=True, overwrite=False)

Creates or opens one or more SyncroSim Projects in the Library.

Parameters:

  • name (String, optional) – Name of Project. The default is None.

  • pid (Int, optional) – Project ID. The default is None.

  • summary (Logical, optional) – If True, returns a DataFrame of Project information. If False, returns a list of Project objects. Default is True.

  • overwrite (Logical, optional) – If True, then overwrites an existing Project. Default is False.

Returns:

DataFrame containing Project information, including ID, Name, Owner, Last Modified, and Read Only, or List of Projects if summary=False.

Return type:

Project, List of Projects, or pandas.DataFrame