The ansys.rocky.core library#

Summary#

client

Module that defines the RockyClient class, which acts as a proxy for a Rocky

examples

Helper module to download project code examples.

exceptions

Module where the exception classes of the project are contained.

launcher

Module that exposes functions to launch a Rocky application session.

rocky_api_proxies

Module that defines the ApiElementProxy classes, which acts as a proxy for a

serializers

Module that defines the ApiElementProxy classes, which acts as a proxy for a

ApiClientError

Provides the generic exception for the PyRocky API.

ApiServerError

Provides the Exception class for an error generated within the API layer.

LaunchError

Provides the error raised when problems occurs during launch of the Rocky app.

connect

Connect to a Rocky/Freeflow app instance.

connect_to_rocky

This function is deprecated.

launch_container

Launch a Rocky or FreeFlow container with the PyRocky server enabled.

launch_freeflow

Launch the FreeFlow executable with the PyRocky server enabled.

launch_rocky

Launch the Rocky executable with the PyRocky server enabled.

Description#

PyRocky is a Python client for Ansys Rocky application.

Module detail#