Change ACP startup#

By default, the launch_acp() function will start ACP from the unified installer, using the latest available version.

Change the default launch configuration#

To change this behavior, you can use the ansys-launcher command line tool to configure how ACP is started.

Note

The virtual environment in which PyACP is installed must be activated before running the ansys-launcher command.

On Windows, the executable may be called ansys-launcher.exe.

$ ansys-launcher configure ACP
Usage: ansys-launcher configure ACP [OPTIONS] COMMAND [ARGS]...

Options:
--help  Show this message and exit.

Commands:
direct
docker_compose
connect

As indicated in the preceding output, three methods are available for starting ACP:

  • direct: Start ACP directly by providing the path to the acp_grpcserver executable.

  • docker_compose: Start ACP using Docker Compose.

  • connect: Connect to an already running ACP server.

You may configure any of the three methods with the ansys-launcher tool. For example, to use the direct method, run the following command:

ansys-launcher configure ACP direct

The tool prompts you for the required information, providing the default value in square brackets. You can accept the default value by pressing the Enter key or input a new value by typing it and then pressing the Enter key.

$ ansys-launcher configure ACP direct

binary_path:
    Path to the ACP gRPC server executable.
[/usr/ansys_inc/v242/ACP/acp_grpcserver]:

stdout_file:
    File in which the server stdout is stored.
[/dev/null]:

stderr_file:
    File in which the server stderr is stored.
[/dev/null]:

Overwrite default launch mode for ACP (currently set to 'docker_compose')? [y/N]: Y

Updated ~/.config/ansys_tools_local_product_launcher/config.json

The new configuration is used by the launch_acp() function. Note that you may have to restart your Python session for the changes to take effect.

Choose the launch mode at runtime#

To switch between the launch modes, you can specify the launch_mode argument when calling the launch_acp() function. Note that the selected launch mode must already be configured with the ansys-launcher tool.

import ansys.acp.core as pyacp

acp = pyacp.launch_acp(launch_mode="docker_compose")

You may use the config parameter to fully customize the launch of ACP at runtime. This parameter expects a configuration object matching the selected launch_mode:

import os
import ansys.acp.core as pyacp

acp = pyacp.launch_acp(
    config=pyacp.DockerComposeLaunchConfig(
        image_name_acp="ghcr.io/ansys/acp:latest",
        image_name_filetransfer="ghcr.io/ansys/tools-filetransfer:latest",
        keep_volume=True,
        license_server=f"1055@{os.environ['LICENSE_SERVER']}",
    ),
    launch_mode="docker_compose",
)