pyansys 2023.1.3

Pythonic interfaces to Ansys products

Welcome to the PyAnsys metapackage repository. This project originated as a single pyansys package, which provides support to Ansys product releases. Compatibility of these packages amongst themselves and with the Ansys product release they are linked to is ensured.

At this moment, this package ensures the compatibility between the following PyAnsys packages:

• PyAEDT : Pythonic interface to AEDT (Ansys Electronic Desktop)

• PyDPF-Core : Pythonic interface to DPF (Data Processing Framework) for building more advanced and customized workflows

• PyDPF-Post : Pythonic interface to DPF’s postprocessing toolbox for manipulating and transforming simulation data

• PyFluent : Pythonic interface to Ansys Fluent

• PyFluent-Parametric : Pythonic interface to Ansys Fluent parametric workflows

• PyFluent-Visualization : Pythonic interface to visualize Ansys Fluent simulations using Python

• PyMAPDL : Pythonic interface to MAPDL.

• PyMAPDL Reader: Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later)

• PyPIM: Pythonic interface to communicate with the PIM (Product Instance Management) API

• Granta MI BoM Analytics: Pythonic interface to Granta MI BoM Analytics services

• Shared Components: Shared software components to enable package interoperability and minimize maintenance

Much effort is underway to continue expanding and developing packages in the PyAnsys GitHub account. On the Issues page for each package, you can post issues and request new features. You can also email questions to PyAnsys Support.

By default, the PyAnsys package installs these core modules:

• PyAEDT

• PyDPF-Core

• PyDPF-Post

• PyFluent

• PyMAPDL

• PyPIM

• Granta MI BoM Analytics

• Shared Components

However, the pyansys package also contains certain extra targets, which can be installed upon request:

• mapdl-all: this target installs the core packages and PyMAPDL Reader.

• fluent-all: this target installs the core packages and PyFluent-Parametric and PyFluent-Visualization.

• all: this target install all extra pyansys packages.

Package installation

Two installation modes are provided: user and offline.

User mode installation

Before installing pyansys in user mode, ensure that you have the latest version of pip with:

python -m pip install -U pip

Then, install pyansys with:

python -m pip install pyansys

If you are interested in installing an extra target such as fluent-all:

python -m pip install pyansys[fluent-all]

If you are interested in installing a specific version such as 2023.1.3:

python -m pip install pyansys==2023.1.3

Offline mode installation

If you lack an internet connection on your installation machine, the recommended way of installing the pyansys metapackage is downloading the wheelhouse archive from the Releases Page for your corresponding machine architecture.

Each wheelhouse archive contains all the Python wheels necessary to install pyansys metapackage from scratch on Windows, Linux, and MacOS from Python 3.7 to 3.10. You can install this on an isolated system with a fresh Python installation or on a virtual environment.

For example, on Linux with Python 3.7, unzip the wheelhouse archive and install it with the following:

unzip pyansys-v2023.1.3-wheelhouse-Linux-3.7-core.zip wheelhouse
pip install pyansys -f wheelhouse --no-index --upgrade --ignore-installed

If you’re on Windows with Python 3.9, unzip to a wheelhouse directory and install using the same command as above.

Consider installing using a virtual environment.

Versioning system

The pyansys metapackage follows a semantic-like versioning system, though it has been adapted to the Ansys product release mechanism. In that sense, the following kind of versioning system is followed:

XXXX.Y.ZZ

Where:

• XXXX is the Ansys product release year (for example, 2022)

• Y is the Ansys product release within the same year (for example, 1, which relates to R1)

• ZZ is the patched versions to the pyansys metapackage, if any.

Consequently, the first pyansys metapackage compatible with the 2024 R2 release would be:

2024.2.0

And any subsequent patched version of that package would be:

2024.2.1
2024.2.2
2024.2.3
...

You can request for a specific version install when pip installing your package:

python -m pip install pyansys==2024.2.0

License and acknowledgments

All PyAnsys libraries are licensed under the MIT license.

PyAnsys libraries make no commercial claim over Ansys whatsoever. These libraries extend the functionality of Ansys products by adding Python interfaces to legally obtained software products without changing the core behaviors or licenses of the original software.

For more information about Ansys products, visit the Ansys web site.