ansys-cfx-core 0.2.2

PyCFX is a Python wrapper for Ansys CFX, the gold standard CFD software for turbomachinery applications.

Overview

PyCFX is a Python wrapper for Ansys CFX, the industry-leading CFD software for turbomachinery applications. You can use it to perform these tasks:

• Launch CFX from a local Ansys installation.

• Create, modify, and run CFX simulations in a Python environment.

• Postprocess simulation results.

Documentation and issues

Documentation for the latest stable release of PyCFX is hosted at PyCFX 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.

On the PyCFX Issues page, you can create issues to report bugs and request new features.

For general PyAnsys support, email [e-mail].

Installation

PyCFX supports Python 3.10 through 3.14 on Windows and Linux.

You can install it from PyPI with this command:

pip install ansys-cfx-core

For developers

If you plan on doing local development of PyCFX with Git, install the latest release with these commands:

git clone https://github.com/ansys/pycfx

python -m pip install -U pip tox

cd pycfx
pip install -e .[doc,tests,style]
python codegen/allapigen.py  # Generates the API files

Dependencies

You must have a licensed copy of Ansys CFX installed locally. PyCFX supports CFX 2025 R2 Service Pack 3 and later.

On Windows, the Ansys CFX installer automatically sets the required environment variables. For example, using CFX 2025 R2 installed in the default directory, the installer sets the AWP_ROOT252 environment variable to C:\Program Files\ANSYS Inc\v252.

On Linux, you must set the required environment variable manually. For example, using CFX 2025 R2 in the default directory, run this command:

export AWP_ROOT252=/usr/ansys_inc/v252

To make this setting persistent for the current user, add this same export command to the ~/.profile file or equivalent.

Getting started

Launch CFX

To launch CFX from Python using a local installation, run these commands:

import ansys.cfx.core as pycfx
pypre = pycfx.PreProcessing.from_install()   # Start CFX-Pre
pysolve = pycfx.Solver.from_install()        # Start a Solver session
pypost = pycfx.PostProcessing.from_install() # Start CFD-Post

Find examples in the examples/ folder of the repository.

License and acknowledgments

PyCFX is licensed under the MIT license.

PyCFX makes no commercial claim over Ansys whatsoever. This library extends the functionality of Ansys CFX by adding a Python interface to CFX without changing the core behavior or license of the original software. The use of PyCFX to run the CFX software requires a legally licensed copy of CFX.

For more information on CFX, see the Ansys CFX page on the Ansys website.