launch_prime

ansys.meshing.prime.launch_prime(prime_root=None, ip='127.0.0.1', port=50055, timeout=10.0, n_procs=None, version=None, **kwargs)

Launch an instance of Ansys Prime Server and get a client for it.

Parameters:

prime_root: Optional[str]

Root directory which contains the Ansys Prime Server.

ip: str

IP address to start the server at. The default IP address is 127.0.0.1.

port: int

Port at which the server is started. The default port is 50055.

timeout: float

Maximum time in seconds to wait for the client to connect to the server. The default is 10.0 seconds

n_procs: Optional[int]

When running in distributed mode, specify the number of distributed processes to spawn. Process marked as Node 0 will host the GRPC server. If None is specified, server will be launched as the only process (normal mode).

Returns:

Client

The instance of the client that is connected to the launched server.

Raises:

FileNotFoundError

When there is an error in file paths used to launch the server.

ConnectionError

When there is an error in connecting to the GRPC server.