search

ansys / pyprimemesh

Pythonic Meshing Client for Ansys Prime Server
https://prime.docs.pyansys.com/
MIT License
21 stars 9 forks source link
ansys engineering mesh meshing pyansys python

readme

PyPrimeMesh

pyansys PyPI - Version PyPI - Python Version GH-CI MIT black PyPI - Downloads

Overview

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

Documentation and issues

Documentation for the latest stable release of PyPrimeMesh is hosted at PyPrimeMesh documentation.

In the upper right corner of the documentation's title bar, there is an option for switching from viewing the documentation for the latest stable release to viewing the documentation for the development version or previously released versions.

You can also view or download the PyPrimeMesh cheat sheet. This one-page reference provides syntax rules and commands for using PyPrimeMesh.

On the PyPrimeMesh Issues page, you can create issues to report bugs and request new features. On the PyPrimeMesh Discussions page or the Discussions page on the Ansys Developer portal, you can post questions, share ideas, and get community feedback.

To reach the project support team, email pyansys.core@ansys.com.

Installation

The ansys-meshing-prime package supports Python 3.10 to Python 3.12 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 .

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 one of the following licenses to run. The system checks out the first available license from the list in the following order:

  1. CFD PrepPost

  2. CFD PrepPost Pro

  3. Mechanical Enterprise PrepPost

  4. Mechanical Enterprise

  5. Mechanical Pro

  6. Mechanical Premium

  7. Ansys LS-DYNA

Get started

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

Run tests

Run tests locally with this command:

    pytest

License and aknowledgments

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 R1 or later.