Skip to content

ansys/pydpf-post

Repository files navigation

PyDPF-Post

PyAnsys Python pypi MIT

PyDPF-Post is part of the Ansys Data Processing Framework (DPF), which provides reusable operators that let you access and transform simulation data coming from different Ansys and third-party result files.

PyDPF-Post leverages PyDPF-Core, a package for building more advanced and customized workflows using Ansys DPF. After loading a simulation's result file in PyDPF-Post, you can extract simulation metadata and results and then apply postprocessing operations on them.

PyDPF-Core is physics-agnostic and operator-oriented. It is a direct exposure of the DPF features and objects with a few helpers. It is not restricted to postprocessing.

PyDPF-Post on the other hand provides a high-level, physics-oriented API for postprocessing. It has a more Pythonic and user-friendly API dedicated to postprocessing, with new objects meant to provide a specific interface for each type of physics and analysis (such as mechanics static versus transient versus fluids). Most importantly, there is no need to manipulate operators or workflows.

Documentation and issues

Documentation for the latest stable release of PyPDF-Post is hosted at PyDPF-Post documentation.

The PyDPF-Post documentation has five sections:

  • Getting started: Learn how to install PyDPF-Post in user mode and quickly begin using it.
  • User guide: Understand key concepts for using PyDPF-Post.
  • API reference: Understand how to use Python to interact programmatically with PyDPF-Post.
  • Examples: Explore examples that show how to use PyDPF-Post to perform nay different types of operations.
  • Contribute: Learn how to contribute to the PyDPF-Post codebase or 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 PyDPF-Post cheat sheet. This one-page reference provides syntax rules and commands for using PyDPF-Post.

On the PyDPF-Post Issues page, you can create issues to report bugs and request new features. On the PyDPF-Post 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.