pysyncrosim.session.Session.__init__

Session.__init__(location=None, silent=True, print_cmd=False, conda_filepath=None, mono_path=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

  • mono_path (Str, optional) – Path to mono executable on Linux. If None, automatically searches PATH. Specify custom path if mono is not in your PATH. Example: Session(location=”/opt/syncrosim”, mono_path=”/usr/local/bin/mono”)

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.