Skip to main content

Pythonic interface to Ansys Fluent

Project description

PyAnsys PyPI GH-CI MIT Black

Overview

PyFluent provides Pythonic access to Ansys Fluent. Its features enable the seamless use of Fluent within the Python ecosystem and broad access to native Fluent features, including the ability to:

  • Launch Fluent using a local Ansys installation

  • Use Fluent’s TUI (text user interface) commands for both meshing and solver features

  • Use Fluent’s built-in postprocessing capabilities

Documentation and issues

For comprehesive information on PyFluent, see the latest release documentation.

On the PyFluent Issues, you can create issues to submit questions, report bugs, and request new features. To reach the project support team, email pyansys.support@ansys.com.

Installation

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

Install the latest release from PyPI with:

pip install ansys-fluent-core

Alternatively, install the latest version from the PyFluent GitHub repository with:

pip install git+https://github.com/pyansys/pyfluent.git

If you plan on doing local “development” of PyFluent with Git, install with:

git clone https://github.com/pyansys/pyfluent.git
cd pyfluent
pip install pip -U
pip install -e .
python codegen/allapigen.py  # Generates the API files

Dependencies

You must have a locally-installed, licensed copy of Ansys to run Fluent. The first supported version is 2022 R2.

Getting started

Launching Fluent

You can launch Fluent from Python using the launch_fluent function:

import ansys.fluent.core as pyfluent
session = pyfluent.launch_fluent()
session.check_health()

To use a non-default installation location, set the PYFLUENT_FLUENT_ROOT environment variable to the <version>/fluent directory, where <version> is the Ansys release version that you would like to use. For example, v222 uses version 2022 R2.

Basic Usage

You can run Fluent TUI commands using the session.tui interface:

session.solver.tui.file.read_case(case_file_name='elbow.cas.h5')
session.solver.tui.define.models.unsteady_2nd_order("yes")
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available, there are the PyFluent Parametric and PyFluent Visualization packages.

  • The PyFluent Parametric package provides access to Fluent’s parametric workflows.

  • The PyFluent Visualization package provides postprocessing and visualization capabilities using pyvista and matplotlib.

License and acknowledgments

PyFluent is licensed under the MIT license.

This module, ansys-fluent makes no commercial claim over Ansys whatsoever. PyFluent extends the functionality of Fluent by adding a Python interface to Fluent without changing the core behavior or license of the original software. The use of the interactive control of PyFluent requires a legally licensed local copy of Fluent. For more information about Fluent, visit the Fluent page on the Ansys website.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys-fluent-core-0.11.dev0.tar.gz (654.9 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page