PyPrimeMesh is a Python client to Ansys Prime Server, which delivers core Ansys meshing technology.

For information on PyPrimeMesh, refer to the latest documentation.

For queries related to PyPrimeMesh, post on the PyPrimeMesh Discussions page.

For bugs or enhancement requests, post an issue on the PyPrimeMesh Issues page.

For assistance, reach out to the support team at [email protected].

The ansys-meshing-prime package supports Python 3.8 to Python 3.11 on the Windows and Linux operating systems.

PyPrimeMesh can be installed with all dependencies directly from PyPi by running this command:

pip install ansys-meshing-prime[all]

Alternatively, you can clone this repository and install the client using these commands:

git clone https://github.com/ansys/pyprimemesh
cd pyprimemesh
pip install -e .[all]

The preceding commands install all functionality that is important to development. To install a basic version of the client, use this command instead:

pip install -e .

You must have Ansys 2023 R1 or later installed for access to Ansys Prime Server. Optionally, CAD readers can be configured. Ansys Prime Server requires an Ansys Mechanical PrepPost or Fluids PrepPost (CFD) license to run.

To launch PyPrimeMesh, use this code:

import ansys.meshing.prime as prime

with prime.launch_prime() as prime_client:
    model = prime_client.model

PyPrimeMesh is licensed under the MIT license.

PyPrimeMesh makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys Prime Server by adding a Python interface without changing the core behavior or license of the original software. The use of Ansys Prime Server requires a legally licensed copy of Ansys 2023 or later.