Client

class ansys.meshing.prime.Client(*, server_process=None, ip='127.0.0.1', port=50055, timeout=20.0, credentials=None, **kwargs)

Provides the Client class for PyPrimeMesh.

Parameters:

server_processAny, optional

Server process in the system. The default is None.

ipstr, optional

IP address where the server is located. The default is defaults.ip().

portint, optional

Port where the server is deployed. The default is defaults.port().

timeoutfloat, optional

Maximum time to wait for connection. The default is defaults.connection_timeout().

credentialsAny, optional

Credentials to connect to the server. The default is None.

Raises:

ValueError

Failed to load the communicator.

Methods

Client.exit()	Close the connection with the server.
Client.run_on_server(recipe)	Run a recipe on the server.

Attributes

Client.model

Get model associated with the client.