pysyncrosim.session.Session

class pysyncrosim.session.Session(location=None, silent=True, print_cmd=False)

A class to represent a SyncroSim Session.

__init__(location=None, silent=True, print_cmd=False)

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.

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.

add_packages(packages)

Installs a package.

packages([installed])

Retrieves DataFrame of installed packages.

remove_packages(packages)

Uninstalls a package.

update_packages([packages])

Updates a package to the newest version.

version()

Retrieves SyncroSim version.

Attributes

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.