Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

PyAnsys Python PyPI GH-CI codecov MIT Black pre-commit.ci status

Overview

PyFluent-Visualization provides post-processing and visualization capabilities for PyFluent using PyVista and Matplotlib.

Documentation and issues

For comprehensive information on PyFluent-Visualization, see the latest release 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 PyFluent Visualization Issues page, you can create issues to submit questions, reports burgs, and request new features. To reach the project support team, email pyansys.core@ansys.com.

Installation

The ansys-fluent-visualization package supports Python 3.10 through Python 3.14 on Windows and Linux.

If you are using Python 3.10, download and install the wheel file for the vtk package from here for Windows or from here for Linux.

Install the latest release from PyPI with:

pip install ansys-fluent-visualization

There are optional dependencies depending on the desired usage mode. To run the plotter in interactive mode, install with:

pip install ansys-fluent-visualization[interactive]

For interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:

pip install ansys-fluent-visualization[single-window]

Alternatively, install the latest release from GitHub with:

pip install git+https://github.com/ansys/pyfluent-visualization.git

If you plan on doing local development of PyFluent-Visualization with Git, install with:

git clone https://github.com/ansys/pyfluent-visualization.git
cd pyfluent-visualization
pip install pip -U
pip install -e .

Dependencies

You must have a licensed copy of Ansys Fluent installed locally. PyFluent-Visualization supports Ansys Fluent 2022 R2 and later.

Getting started

Basic usage

The following code assumes that a PyFluent session has already been created and a Fluent case with input parameters has been set up. For a complete example, see Analyzing your results in the PyFluent-Visualization documentation.

from ansys.fluent.visualization import Contour, GraphicsWindow
from ansys.fluent.core.solver import VelocityInlets, PressureOutlets, using
from ansys.units import VariableCatalog

graphics_window = GraphicsWindow()

# Use an existing PyFluent solver session for the duration of this block
with using(solver_session):
   # Define a contour plot of static pressure across all velocity inlets and pressure outlets
    pressure_contour = Contour(field=VariableCatalog.STATIC_PRESSURE, surfaces=VelocityInlets() + PressureOutlets())
    graphics_window.add_graphics(pressure_contour)
    graphics_window.show()

Usage in a JupyterLab environment

PyFluent-Visualization uses PyVista, which has the ability to display fully featured plots within a JupyterLab environment using ipyvtklink. Find out about using ipyvtklink with PyVista here <https://docs.pyvista.org/user-guide/jupyter/ipyvtk_plotting.html>

License and acknowledgments

PyFluent-Visualization is licensed under the MIT license.

PyFluent-Visualization makes no commercial claim over Ansys whatsoever. This tool extends the functionality of Ansys Fluent by adding a Python interface to Fluent without changing the core behavior or license of the original software. The use of the interactive Fluent control of PyFluent-Visualization requires a legally licensed local copy of Fluent.

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

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_visualization-0.29.dev0.tar.gz (50.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file ansys_fluent_visualization-0.29.dev0.tar.gz.

File metadata

File hashes

Hashes for ansys_fluent_visualization-0.29.dev0.tar.gz
Algorithm Hash digest
SHA256 f666b2c40baa1283d8bcf43fc0fb85d7e30b21c3ca4442a3177bc4aa3a053a21
MD5 8ce33e33fcc2244b0499f768419dbd6e
BLAKE2b-256 d0aad115511759a7ecd8af7a531f75d30e4c76e0cdbd58e041ef36f281f9ea8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_fluent_visualization-0.29.dev0.tar.gz:

Publisher: ci_cd.yml on ansys/pyfluent-visualization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ansys_fluent_visualization-0.29.dev0-py3-none-any.whl.

File metadata

File hashes

Hashes for ansys_fluent_visualization-0.29.dev0-py3-none-any.whl
Algorithm Hash digest
SHA256 fdb5235a4003c6fa2b5c039940ae190e5f57c78081189c2df1e1a8ca0b964894
MD5 f3b2c800653258bfca0ad2b63b4f6bc8
BLAKE2b-256 f288238422eead13ed8e73c5d5e5493f05c29b6434fd5dfd44a3382f883ea35c

See more details on using hashes here.

Provenance

The following attestation bundles were made for ansys_fluent_visualization-0.29.dev0-py3-none-any.whl:

Publisher: ci_cd.yml on ansys/pyfluent-visualization

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.29.dev0 This release

2 files

0.28.0

2 files

0.27.0

2 files

0.26.1

2 files

0.26.0

2 files

0.25.1

2 files

0.25.0

2 files

0.24.0

2 files

0.23.0

2 files

0.22.1

2 files

0.22.0

2 files

0.21.1

2 files

0.21.0

2 files

0.20.0

2 files

0.19.2

2 files

0.19.1

2 files

0.19.0

2 files

0.18.0

2 files

0.17.0

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.0

2 files

0.12.0

2 files

0.11.0

2 files

0.10.1

2 files

0.10.0

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

0.7.0

2 files

0.6.1

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.1

2 files

0.4.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page