pysyncrosim.session.Session
- class pysyncrosim.session.Session(location=None, silent=True, print_cmd=False, conda_filepath=None)
A class to represent a SyncroSim Session.
- __init__(location=None, silent=True, print_cmd=False, conda_filepath=None)
Initializes a pysyncrosim Session instance.
- Parameters:
location (Str, optional) – Filepath to SyncroSim executable. If None, then uses default location on windows. The default is None.
silent (Logical, optional) – If True, will not print warnings from the console. The default is True.
print_cmd (Logical, optional) – If True, arguments from the console command will be printed. The default is False.
conda_filepath (Str, optional) – Filepath to conda executable. If None, then uses default location
- Raises:
ValueError – Raises error if the location given does not exist.
RuntimeError – Raises error if the version of the SyncroSim installation is incompatible with the current version of pysyncrosim.
- Return type:
None.
Methods
__init__
([location, silent, print_cmd, ...])Initializes a pysyncrosim Session instance.
install_conda
([software])Installs Miniforge or Miniconda to the default installation path within the SyncroSim installation folder.
install_packages
(packages[, version])Installs one or more SyncroSim packages.
packages
([installed])Retrieves DataFrame of installed packages.
sign_in
()Signs in to SyncroSim.
sign_out
()Signs out of SyncroSim.
uninstall_packages
(packages[, version])Uninstalls one or more SyncroSim packages.
version
()Retrieves SyncroSim version.
view_profile
()Retrieves your SyncroSim profile information if signed in.
Attributes
conda_filepath
Gets or sets the filepath to the conda executable.
location
Retrieves the location for this Session.
print_cmd
Gets or sets the print_cmd status of the SyncroSim Session.
silent
Gets or sets the silent status for this Session.