The launcher.py module

Summary

Functions

launch_speos	Start the Speos Service remotely using the product instance management API.
launch_remote_speos	Start the Speos Service remotely using the product instance management API.
launch_local_speos_rpc_server	Launch Speos RPC server locally.

Description

Module to start Speos RPC Server.

Module detail

launcher.launch_speos(version=None)

Start the Speos Service remotely using the product instance management API.

Prerequisite : product instance management configured.

Parameters:

versionstr, optional

The Speos Service version to run, in the 3 digits format, such as “242”. If unspecified, the version will be chosen by the server.

Returns:

ansys.speos.core.speos.Speos

An instance of the Speos Service.

launcher.launch_remote_speos(version=None)

Start the Speos Service remotely using the product instance management API.

When calling this method, you need to ensure that you are in an environment where PyPIM is configured. This can be verified with pypim.is_configured.

Parameters:

versionstr, optional

The Speos Service version to run, in the 3 digits format, such as “242”. If unspecified, the version will be chosen by the server.

Returns:

ansys.speos.core.speos.Speos

An instance of the Speos Service.

launcher.launch_local_speos_rpc_server(version=DEFAULT_VERSION, port=DEFAULT_PORT, server_message_size=MAX_SERVER_MESSAGE_LENGTH, client_message_size=MAX_CLIENT_MESSAGE_SIZE, logfile_loc=None, log_level=20, speos_rpc_path=None, use_insecure=False)

Launch Speos RPC server locally.

This method only work for SpeosRPC server supporting UDS or WNUA transport. For release 251, minimal requirement is 2025.1.4. For release 252, minimal requirement is 2025.2.4. From release 261, grpc transport is always supported.

Warning

Do not execute this function with untrusted function argument or environment variables. See the security guide for details.

Parameters:

versionstr

The Speos server version to run, in the 3 digits format, such as “242”. If unspecified, the version will be chosen as ansys.speos.core.kernel.client.LATEST_VERSION.

portUnion[str, int], optional

Port number where the server is running. By default, ansys.speos.core.kernel.client.DEFAULT_PORT.

server_message_sizeint

Maximum message length value accepted by the Speos RPC server, By default, value stored in environment variable SPEOS_MAX_MESSAGE_LENGTH or 268 435 456.

client_message_size: int

Maximum Message size of a newly generated channel By default, MAX_CLIENT_MESSAGE_SIZE.

logfile_locstr

location for the logfile to be created in.

log_levelint

The logging level to be applied to the server, integer values can be taken from logging module. By default, logging.WARNING = 20.

speos_rpc_pathOptional[str, Path]

location of Speos rpc executable

use_insecure: bool

Whether to use insecure transport mode for the Speos RPC server. By default, False.

Returns:

ansys.speos.core.speos.Speos

An instance of the Speos Service.