Welcome to the PyAnsys project. While this project originated as a single
it is now a collection of many Python packages for using Ansys products through Python:
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
PyMAPDL : Pythonic interface to MAPDL
PyMAPDL Reader: Pythonic interface to read legacy MAPDL result files (MAPDL 14.5 and later)
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
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
for each package, you can post issues and request new features. You can also email
questions to PyAnsys Support.
You must install the applicable packages for an Ansys product on your local machine.
While there are multiple ways to install a Python package, using pip, the package installer for Python, is recommended.
For your convenience, this section provides
pip commands for downloading
and installing the most recent PyAnsys packages and links to comprehensive resources.
pip install pyaedt
pip install ansys-dpf-core
pip install ansys-dpf-post
pip install ansys-mapdl-core
pip install ansys-mapdl-reader
pip install ansys-fluent-core
pip install ansys-fluent-parametric
pip install ansys-fluent-visualization
pip install ansys-platform-instancemanagement
Granta MI BoM Analytics#
pip install ansys-grantami-bomanalytics
The PyAnsys project publishes and consumes shared software components that enable interoperability between PyAnsys packages and minimize maintenance. For more information, see the Shared Components documentation.
The OpenAPI Common library is a shared component. Here is the command for downloading and installing the most recent package and links to its comprehensive resources:
pip install ansys-openapi-common
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.