pysyncrosim.library.Library

class pysyncrosim.library.Library(location=None, session=None, use_conda=None, packages=None)

A class to represent a SyncroSim Library.

__init__(location=None, session=None, use_conda=None, packages=None)

Initializes a pysyncrosim Library instance.

Parameters:

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

• session (Session) – pysyncrosim Session instance.

• use_conda (Logical, optional) – If True, then uses Conda environment for this Library. If False, then does not use Conda environment. If None, then uses the Conda environment specified in the SyncroSim Library. The default is None.

• packages (String or List of Strings, optional) – List of package names to add to the Library. The default is None.

Return type:

None.

Methods

__init__([location, session, use_conda, ...])	Initializes a pysyncrosim Library instance.
add_packages(packages[, versions])	Adds one or more SyncroSim packages to this Library.
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.
folders()	Retrieves a dataframe of folder information for this Library.
projects([name, pid, summary, overwrite])	Creates or opens one or more SyncroSim Projects in the Library.
remove_packages(packages)	Removes one or more SyncroSim packages from this Library.
run([scenarios, project, copy_external_inputs])	Runs a list of Scenario objects.
save_datasheet(name, data[, append, force, ...])	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

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.
packages	Retrieves the package(s) this Library is using.
readonly	Gets or sets the read-only status of this Library.
session	Retrieves the Session associated with this Library.
use_conda	Retrieves the Conda environment for this Library.