Product launcher#

Defines a function for launching Ansys products.

ansys.tools.local_product_launcher.launch.launch_product(product_name, *, launch_mode=None, config=None)#

Launch a product instance.

Parameters:

  • product_name (str) – Name of the product to launch.

  • launch_mode (Optional[str], 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.

  • config (Optional[TypeVar(LAUNCHER_CONFIG_T, bound= DataclassProtocol)], default: None) – Configuration to use for launching the product. The default is None, in which case the default configuration is used.

Return type:

ProductInstance

Returns:

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.