Getting started#

PyFluent provides Pythonic access to Ansys Fluent.

To run PyFluent, you must have a licensed copy of Ansys Fluent installed locally. PyFluent supports Fluent 2022 R2 and later.

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

Install the package#

The ansys-fluent-core package supports Python 3.7 through Python 3.10 on Windows and Linux.

Install the latest release from PyPi with:

pip install ansys-fluent-core

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

git clone
cd pyfluent
pip install pip -U
pip install -e .
python codegen/  # Generates the API files

Any changes that you make locally are reflected in your setup after you restart the Python kernel.

Launch Fluent#

To launch Fluent from PyFluent, use the launch_fluent method:

import ansys.fluent.core as pyfluent
solver = pyfluent.launch_fluent(precision="double", processor_count=2, mode="solver")

Once Fluent is active, you can use the interface to send Fluent TUI commands to Fluent. For example, you can read a case file, update a setting, and iterate the solver with:'elbow.cas.h5')"yes"), 3)

If you want to interact with the Fluent graphical user interface, pass show_gui=True to the launch_fluent function:

session = pyfluent.launch_fluent(precision="double", processor_count=2, show_gui=True, mode="solver")

If you want to print the debug information for development, set the following environment variable:

pyfluent.set_log_level('DEBUG') # for development, by default only errors are shown

Additional PyFluent libraries#

You can also install and use these additional PyFluent libraries: