pysyncrosim.library.Library

class pysyncrosim.library.Library(location, session)

A class to represent a SyncroSim Library.

__init__(location, session)

Initializes a pysyncrosim Library instance.

Parameters
  • location (String) – Filepath to Library location on disk.

  • session (Session) – pysyncrosim Session instance.

Return type

None.

Methods

__init__(location, session)

Initializes a pysyncrosim Library instance.

backup()

Creates a backup of a SyncroSim Library.

datasheets([name, summary, optional, empty, ...])

Retrieves a DataFrame of Library Datasheets.

delete([project, scenario, force])

Deletes a SyncroSim class instance.

disable_addons(name)

Disable addon package(s) of a SyncroSim Library.

enable_addons(name)

Enable addon package(s) of a SyncroSim Library.

projects([name, pid, summary, overwrite])

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

run([scenarios, project, jobs, ...])

Runs a list of Scenario objects.

save_datasheet(name, data[, scope])

Saves a pandas DataFrane as a SyncroSim Datasheet.

scenarios([name, project, sid, pid, ...])

Retrieves a Scenario or DataFrame of Scenarios in this Library.

update()

Updates a SyncroSim Library.

Attributes

addons

Retrieves the addon(s) this Library is using.

date_modified

Retrieves the last date this Library was modified.

description

Gets or sets the description for this Library.

info

Retrieves information about this Library.

location

Retrieves the file path to this Library.

name

Retrieves or sets the name of this Library.

owner

Gets or sets the owner of this Library.

package

Retrieves the package this Library is using.

readonly

Gets or sets the read-only status of this Library.

session

Retrieves the Session associated with this Library.