launch_and_connect

ansys.sherlock.core.launcher.launch_and_connect(host='127.0.0.1', port=9090, single_project_path='', sherlock_command_args='', year=None, release_number=None, timeout=120)

Launch Sherlock, start gRPC on a given host and port, and wait until connected to Sherlock.

Available Since: 2025R2

Parameters:

host: str, optional

IP address to start gRPC on. The default is "127.0.0.1", which is the IP address for the local host.

port: int, optional

Port number for the connection.

single_project_pathstr, optional

Path to the Sherlock project if invoking Sherlock in the single-project mode.

sherlock_command_argsstr, optional

Additional command arguments for launching Sherlock.

year: int, optional

4-digit year of the Sherlock release to launch. If not provided, the latest installed version of Sherlock will be launched.

release_number: int, optional

Release number of Sherlock to launch. If not provided, the latest installed version of Sherlock will be launched.

timeout: int, optional

Maximum time (in seconds) to wait for the connection to Sherlock to be established. Default is 120 seconds.

Returns:

:

Sherlock

The instance of sherlock.

str

Path to the Sherlock installation directory.

Return type:

tuple[Sherlock, str]

Examples

>>> from ansys.sherlock.core import launcher
>>> project = "C:\\Default Projects Directory\\ODB++ Tutorial"
>>> sherlock, ansys_install_path = launcher.launch_and_connect(
>>>     port=9092,
>>>     single_project_path=project,
>>>     sherlock_command_args="-noGUI",
>>>     year=2025,
>>>     release_number=1,
>>>     timeout=30)