launch_acp#

ansys.acp.core.launch_acp(config=None, launch_mode=None, timeout=30.0)#

Launch an ACP instance.

Launch the ACP gRPC server with the given configuration. If no configuration is provided, the configured default is used.

Parameters:

  • config (DirectLaunchConfig | DockerComposeLaunchConfig | None, default: None) – The configuration used for launching ACP. If unspecified, the default for the given launch mode is used.

  • launch_mode (LaunchMode | None, default: None) – Specifies which ACP launcher is used. One of direct or docker_compose. If unspecified, the configured default is used. If no default is configured, direct is used.

  • timeout (float | None, default: 30.0) – Timeout to wait until ACP responds. If None is specified, the check that ACP has started is skipped.

Return type:

ACP[ControllableServerProtocol]

Returns:

ACP instance which can be used to control the server, and instantiate objects on the server.