Skip to main content

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

Project description

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.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 .

Dependencies

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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys_meshing_prime-0.6.1.tar.gz (340.8 kB view details)

Uploaded Source

Built Distribution

ansys_meshing_prime-0.6.1-py3-none-any.whl (444.0 kB view details)

Uploaded Python 3

File details

Details for the file ansys_meshing_prime-0.6.1.tar.gz.

File metadata

  • Download URL: ansys_meshing_prime-0.6.1.tar.gz
  • Upload date:
  • Size: 340.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.14

File hashes

Hashes for ansys_meshing_prime-0.6.1.tar.gz
Algorithm Hash digest
SHA256 4bd4fc587c9fd12e8379df376c6d942fcd7e5700d36db3d786f23d5289f398fe
MD5 c73edda21c91113a27f153c9afee6a0c
BLAKE2b-256 dbd253eda840804ef61b77c064353f7a7dd454c9a530a08d0b6c056c0a2b6f44

See more details on using hashes here.

File details

Details for the file ansys_meshing_prime-0.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_meshing_prime-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6b1adbf37a44fd23b055b84f51d385bd7f852b46eaffd42542f0d0e3661e5947
MD5 bf6a7a96e63ca5377edc36df2a4b613f
BLAKE2b-256 99025e15f12aea0cd1fe970e71ebfe4607b2ed118f0c38d5cf73a4a32f64f059

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page