The launch.py module#

Summary#

launch_product

Launch a product instance.

Description#

Defines a function for launching Ansys products.

Module detail#

launch.launch_product(product_name: str, *, launch_mode: str | None = None, config: ansys.tools.common.launcher.interface.LAUNCHER_CONFIG_T | None = None) → ansys.tools.common.launcher.product_instance.ProductInstance#

Launch a product instance.

Parameters#

product_namestr

Name of the product to launch.

launch_modestr, default: None

Launch mode to use. The default is None, in which case the default launched mode is used. Options available depend on the launcher plugin.

configLAUNCHER_CONFIG_T, default: None

Configuration to use for launching the product. The default is None, in which case the default configuration is used.

Returns#

ProductInstance

Object that can be used to interact with the started product.

Raises#

TypeError

If the type of the configuration object does not match the type requested by the launcher plugin.