Getting started

PyPrimeMesh supports a Python client for Ansys Prime server that provides core Ansys meshing technology.

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

For more information on getting a licensed copy of Ansys, visit Ansys <ansys>.

Note: PyPrimeMesh client release has one to one compatibility with Ansys Prime Server release. That is, PyPrimeMesh client is only compatible with its corresponding Ansys Prime Server. See the below table:

PyPrimeMesh Client Release	Ansys Prime Server Release
0.2.0	23.1.0 (23R1)
0.3.0	23.1.1 (23R1 SP1)

Installation

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

You can install PyPrimeMesh with all dependencies directly from PyPI with this code:

pip install ansys-meshing-prime[all]

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

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

The preceding code installs 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 a licensed copy of the latest version of Ansys 2023 R1 locally.

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