pysyncrosim.library.Library

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

A class to represent a SyncroSim Library.

Methods

__init__	Initializes a pysyncrosim Library instance.
add_packages	Adds one or more SyncroSim packages to this Library.
backup	Creates a backup of a SyncroSim Library.
compact	Compacts a SyncroSim library to reduce its footprint on disk.
datasheets	Retrieves a DataFrame of Library Datasheets.
delete	Deletes a SyncroSim class instance.
folders	Retrieves a dataframe of folder information for this Library.
projects	Creates or opens one or more SyncroSim Projects in the Library.
remove_packages	Removes one or more SyncroSim packages from this Library.
run	Runs a list of Scenario objects.
save_datasheet	Saves a pandas DataFrane as a SyncroSim Datasheet.
scenarios	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.
environment	Retrieves the environment status of 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.