pysyncrosim.helper.library
- pysyncrosim.helper.library(name, session=None, packages=None, force_update=False, overwrite=False, use_conda=None, use_ssim_env=True)
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.
packages (String, optional) – The SyncroSim packages to be added to the Library. If None, then the Library will be created without any packages. 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.
use_ssim_env (Logical, optional) – If True (Default), will use the currently running SyncroSim environment if available. If False, will not use the currently running SyncroSim environment.
- Returns:
SyncroSim Library class instance.
- Return type: