pysyncrosim.library
- pysyncrosim.library(name, session=None, package=None, addons=None, template=None, forceUpdate=False, overwrite=False, use_conda=None)
Creates a new SyncroSim Library and opens it as a Library class instance.
- Parameters:
name (String) – Name of new Library to create.
session (Session, optional) – Connects the Python session to the SyncroSim executable. If None, then creates a Session class instance using the default installation path to the SyncroSim executable. The default is None.
package (String, optional) – The package type. if None selected, then “stsim” will be used.
addons (String or List of Strings, optional) – One or more addon packages. The default is None.
template (String, optional) – Creates Library with specified template. The default is None.
forceUpdate (Logical, optional) – If False, then user is prompted to approve required updates. The default is False.
overwrite (Logical, optional) – Overwrite existing Library. The default is False.
use_conda (Logical, optional) – If True, then runs the Library in a conda environment. The default is None, meaning the Library properties determine whether the Library is run in a conda environment. When new Libraries are created, the default for use_conda is False.
- Returns:
SyncroSim Library class instance.
- Return type: