pysyncrosim.library.Library
- class pysyncrosim.library.Library(location=None, session=None, use_conda=None)
A class to represent a SyncroSim Library.
- __init__(location=None, session=None, use_conda=None)
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, use_conda])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[, 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
Retrieves the addon(s) this Library is using.
Retrieves the last date this Library was modified.
Gets or sets the description for this Library.
Retrieves information about this Library.
Retrieves the file path to this Library.
Retrieves or sets the name of this Library.
Gets or sets the owner of this Library.
Retrieves the package this Library is using.
Gets or sets the read-only status of this Library.
Retrieves the Session associated with this Library.
Retrieves the Conda environment for this Library.