Summary

Functions

launch_rocky

Launch the Rocky executable with the PyRocky server enabled.

Description

Module that exposes functions to launch a Rocky application session.

Module detail

launcher.launch_rocky(rocky_exe: pathlib.Path | str | None = None, *, headless: bool = True, server_port: int = DEFAULT_SERVER_PORT) → ansys.rocky.core.client.RockyClient

Launch the Rocky executable with the PyRocky server enabled.

This method waits for Rocky to start up and then returns a `RockyClient instance.

Parameters:

rocky_exeOptional[Path], optional

Path to the Rocky executable. If a path is not specified, this method tries to find the path using AWP_ROOT* environment variables.

headlessbool, optional

Whether to launch Rocky in headless mode. The default is True.

server_port: int, optional

Set the port for Rocky RPC server.

Returns:

RockyClient

Rocky client instance connected to the launched Rocky app.