Skip to main content

Prime Mesh Python client library 2026 R1

Client

Last update: 02.04.2026

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

Provides the Client class for PyPrimeMesh.

Parameters:

server_process

Server process in the system. The default is None.

ip

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

port

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

timeout

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

credentials

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

uds_id

Id for the Unix Domain Socket (UDS). The default is None.

client_certs_dir

Directory containing client certificates for mutual TLS.

Raises

——

ValueError

Failed to load the communicator.

Methods

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

Attributes

Name Description
Client.model Get model associated with the client.

Connect with Ansys