Getting started

PyPrimeMesh is a Python client for Ansys Prime Server, which provides core Ansys meshing technology.

To use PyPrimeMesh, you must have a local installation of Ansys 2023 R1 or later. The Ansys version that you have installed dictates the features available to you.

For more information on getting a licensed copy of Ansys, visit the Ansys website.

Note

The PyPrimeMesh client release has one-to-one compatibility with the Ansys Prime Server release. That is, the PyPrimeMesh client is only compatible with its corresponding Ansys Prime Server.

This table provides compatibility information:

PyPrimeMesh client release	Ansys Prime Server release
0.2.x	23.1.0 (2023 R1)
0.3.x	23.1.1 (2023 R1 SP1)
0.4.x	23.2.0 (2023 R2)
0.5.x	24.1.0 (2024 R1)
0.6.x	24.2.0 (2024 R2)

Installation

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

You can install PyPrimeMesh with all dependencies directly from PyPI with 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 features that are important to development. To install a basic version of the client, use this command instead:

pip install -e .

Dependencies

You must have Ansys 2023 R1 or later installed to have 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.

Launch PyPrimeMesh

To launch PyPrimeMesh, use this code:

import ansys.meshing.prime as prime

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