STKRuntime#
- class ansys.stk.core.stkruntime.STKRuntime#
object
Connect to STKRuntime using gRPC.
Overview#
Attach to STKRuntime. grpc_host is the IP address or DNS name of the gRPC server. grpc_port is the integral port number that the gRPC server is using. grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds). grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default. grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials, see https://grpc.io/docs/guides/auth/ for more information). |
|
Create a new STK Runtime instance and attach to the remote host. grpc_host is the IP address or DNS name of the gRPC server. grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535). grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds). grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default. user_control specifies if the application returns to the user’s control (the application remains open) after terminating the Python API connection. no_graphics controls if runtime is started with or without graphics. grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials, see https://grpc.io/docs/guides/auth/ for more information). |
Import detail#
from ansys.stk.core.stkruntime import STKRuntime
Method detail#
- STKRuntime.attach_to_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, grpc_channel_credentials) STKRuntimeApplication#
Attach to STKRuntime.
grpc_host is the IP address or DNS name of the gRPC server. grpc_port is the integral port number that the gRPC server is using. grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds). grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default. grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials, see https://grpc.io/docs/guides/auth/ for more information).
- STKRuntime.start_application(grpc_host: str = localhost, grpc_port: int = 40704, grpc_timeout_sec: int = 60, grpc_max_message_size: int = 0, user_control: bool = False, no_graphics: bool = True, grpc_channel_credentials) STKRuntimeApplication#
Create a new STK Runtime instance and attach to the remote host.
grpc_host is the IP address or DNS name of the gRPC server. grpc_port is the integral port number that the gRPC server is using (valid values are integers from 0 to 65535). grpc_timeout_sec specifies the time allocated to wait for a grpc connection (seconds). grpc_max_message_size is the maximum size in bytes that the gRPC client can receive. Set to zero to use the gRPC default. user_control specifies if the application returns to the user’s control (the application remains open) after terminating the Python API connection. no_graphics controls if runtime is started with or without graphics. grpc_channel_credentials are channel credentials to be attached to the grpc channel (most common use case: SSL credentials, see https://grpc.io/docs/guides/auth/ for more information).