ansys.rocky.core.launcher

Module that exposes functions to launch a Rocky application session.

Module Contents

Functions

launch_rocky(→ ansys.rocky.core.client.RockyClient)	Launch the Rocky executable with the PyRocky server enabled.
launch_freeflow(→ ansys.rocky.core.client.RockyClient)	Launch the FreeFlow executable with the PyRocky server enabled.

Attributes

MINIMUM_ANSYS_VERSION_SUPPORTED
COMPANY

ansys.rocky.core.launcher.MINIMUM_ANSYS_VERSION_SUPPORTED = 242

ansys.rocky.core.launcher.COMPANY = 'Ansys'

ansys.rocky.core.launcher.launch_rocky(rocky_exe: pathlib.Path | str | None = None, rocky_version: int | None = None, *, headless: bool = True, server_port: int = DEFAULT_SERVER_PORT, close_existing: bool = False) → 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_exe:

Path to the Rocky executable.

rocky_version:

Rocky version to run. If no executable is passed and the version is not specified, this method tries to find the path using the latest Ansys path returned by ansys-tools-path API.

headless:

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

server_port:

Set the port for Rocky RPC server.

close_existing:

Checks if a session exists under the given server_port and closes it before attempting to launch a new session.

Returns:

RockyClient

Rocky client instance connected to the launched Rocky app.

ansys.rocky.core.launcher.launch_freeflow(freeflow_exe: pathlib.Path | str | None = None, freeflow_version: int | None = None, *, headless: bool = True, server_port: int = DEFAULT_SERVER_PORT, close_existing: bool = False) → ansys.rocky.core.client.RockyClient

Launch the FreeFlow executable with the PyRocky server enabled.

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

Parameters:

freeflow_exe:

Path to the Freeflow executable.

freeflow_version:

Freeflow version to run. If no executable is passed and the version is not specified, this method tries to find the path using the latest Ansys path returned by ansys-tools-path API.

headless:

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

server_port:

Set the port for Rocky RPC server.

close_existing:

Checks if a session exists under the given server_port and closes it before attempting to launch a new session.

Returns:

RockyClient

Rocky client instance connected to the launched Rocky/Freeflow app.