launch

ansys.sherlock.core.launcher.launch(host='127.0.0.1', port=9090, single_project_path='', sherlock_command_args='', year=None, release_number=None, transport_mode='mtls', certs_dir=None, uds_dir=None, uds_id=None)

Launch Sherlock using the specified host and port for the gRPC connection.

Available Since: 2025R2

Parameters:

• host (str) – 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) – int, optional: Port number for the connection.

• single_project_path (str) – Path to the Sherlock project if invoking Sherlock in the single-project mode.

• sherlock_command_args (str) – Additional command arguments for launching Sherlock.

• year (int | None) – 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 | None) – int, optional: Release number of Sherlock to launch. If not provided, the latest installed version of Sherlock will be launched.

• transport_mode (str) – str, optional: See launch_and_connect() for usage.

• certs_dir (str) – str, optional: Directory containing the mTLS certificates. Default is “./certs”.

• uds_dir (str) – str, optional: Directory for the UDS socket file. Default is “$HOME/.conn”.

• uds_id (str) – str, optional: Identifier for the UDS socket file name. Default is no identifier.

Return type:

str

Returns:

:

str

Path to the Sherlock installation directory.

Examples

>>> from ansys.sherlock.core import launcher
>>> project = "C:\\Default Projects Directory\\ODB++ Tutorial"
>>> ansys_install_path = launcher.launch(
>>>     port=9092, single_project_path=project, year=2024, release_number=2)