| Name | ansys-fluent-visualization JSON |
| Version |
0.22.1
JSON |
| download |
| home_page | None |
| Summary | A python wrapper for ansys Fluent visualization |
| upload_time | 2025-09-19 10:15:17 |
| maintainer | PyAnsys developers |
| docs_url | None |
| author | ANSYS, Inc. |
| requires_python | <3.14,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
PyFluent-Visualization
======================
|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit|
.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
:target: https://docs.pyansys.com/
:alt: PyAnsys
.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-fluent-core?logo=pypi
:target: https://pypi.org/project/ansys-fluent-visualizaion/
:alt: Python
.. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-visualization.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-fluent-visualization
:alt: PyPI
.. |GH-CI| image:: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml
:alt: GH-CI
.. |codecov| image:: https://codecov.io/gh/ansys/pyfluent-visualization/branch/main/graph/badge.svg
:target: https://codecov.io/gh/ansys/pyfluent-visualization
.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
:target: https://github.com/psf/black
:alt: Black
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent-visualization/main.svg
:target: https://results.pre-commit.ci/latest/github/ansys/pyfluent-visualization/main
:alt: pre-commit.ci status
Overview
--------
PyFluent-Visualization provides postprocessing and visualization
capabilities for `PyFluent <https://github.com/ansys/pyfluent>`_
using `PyVista <https://docs.pyvista.org/>`_ and
`Matplotlib <https://matplotlib.org/>`_.
Documentation and issues
------------------------
For comprehensive information on PyFluent-Visualization, see the latest release
`documentation <https://visualization.fluent.docs.pyansys.com>`_.
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
<https://github.com/ansys/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 <pyansys.core@ansys.com>`_.
Installation
------------
The ``ansys-fluent-visualization`` package supports Python 3.10 through Python
3.13 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 <https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-win_amd64.whl>`_
or from `here for Linux <https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl>`_.
Install the latest release from `PyPI
<https://pypi.org/project/ansys-fluent-visualization/>`_ with:
.. code:: console
pip install ansys-fluent-visualization
There are optional dependencies depending on the desired usage mode.
To run the plotter in interactive mode, install with:
.. code:: console
pip install ansys-fluent-visualization[interactive]
For interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:
.. code:: console
pip install ansys-fluent-visualization[single-window]
Alternatively, install the latest release from `GitHub
<https://github.com/ansys/pyfluent-visualization>`_ with:
.. code:: console
pip install git+https://github.com/ansys/pyfluent-visualization.git
If you plan on doing local *development* of PyFluent-Visualization with Git,
install with:
.. code:: console
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
<https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html>`_ in
the PyFluent-Visualization documentation.
.. code:: python
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 <https://www.ansys.com/products/fluids/ansys-fluent>`_
page on the Ansys website.
Raw data
{
"_id": null,
"home_page": null,
"name": "ansys-fluent-visualization",
"maintainer": "PyAnsys developers",
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "pyansys.maintainers@ansys.com",
"keywords": null,
"author": "ANSYS, Inc.",
"author_email": "ansys.support@ansys.com",
"download_url": "https://files.pythonhosted.org/packages/49/25/cd3a625395756d70f0e8b233a655f1f8982703c11ef2b37d28b9a38d22eb/ansys_fluent_visualization-0.22.1.tar.gz",
"platform": null,
"description": "PyFluent-Visualization\n======================\n|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black| |pre-commit|\n\n.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC\n :target: https://docs.pyansys.com/\n :alt: PyAnsys\n\n.. |python| image:: https://img.shields.io/pypi/pyversions/ansys-fluent-core?logo=pypi\n :target: https://pypi.org/project/ansys-fluent-visualizaion/\n :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-visualization.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/ansys-fluent-visualization\n :alt: PyPI\n\n.. |GH-CI| image:: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml/badge.svg\n :target: https://github.com/ansys/pyfluent-visualization/actions/workflows/ci_cd.yml\n :alt: GH-CI\n\n.. |codecov| image:: https://codecov.io/gh/ansys/pyfluent-visualization/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/ansys/pyfluent-visualization\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n :target: https://github.com/psf/black\n :alt: Black\n\n.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent-visualization/main.svg\n :target: https://results.pre-commit.ci/latest/github/ansys/pyfluent-visualization/main\n :alt: pre-commit.ci status\n\nOverview\n--------\nPyFluent-Visualization provides postprocessing and visualization\ncapabilities for `PyFluent <https://github.com/ansys/pyfluent>`_\nusing `PyVista <https://docs.pyvista.org/>`_ and\n`Matplotlib <https://matplotlib.org/>`_.\n\nDocumentation and issues\n------------------------\nFor comprehensive information on PyFluent-Visualization, see the latest release\n`documentation <https://visualization.fluent.docs.pyansys.com>`_.\n\nIn the upper right corner of the documentation's title bar, there is an option\nfor switching from viewing the documentation for the latest stable release\nto viewing the documentation for the development version or previously\nreleased versions.\n\nOn the `PyFluent Visualization Issues\n<https://github.com/ansys/pyfluent-visualization/issues>`_ page, you can create\nissues to submit questions, reports burgs, and request new features. To reach\nthe project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.\n\nInstallation\n------------\nThe ``ansys-fluent-visualization`` package supports Python 3.10 through Python\n3.13 on Windows and Linux.\n\nIf you are using Python 3.10, download and install the wheel file for the ``vtk`` package from\n`here for Windows <https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-win_amd64.whl>`_\nor from `here for Linux <https://github.com/pyvista/pyvista-wheels/raw/main/vtk-9.1.0.dev0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl>`_.\n\nInstall the latest release from `PyPI\n<https://pypi.org/project/ansys-fluent-visualization/>`_ with:\n\n.. code:: console\n\n pip install ansys-fluent-visualization\n\nThere are optional dependencies depending on the desired usage mode.\nTo run the plotter in interactive mode, install with:\n\n.. code:: console\n\n pip install ansys-fluent-visualization[interactive]\n\nFor interactive mode with graphics displayed in a single Qt window using multiple tabs, install with:\n\n.. code:: console\n\n pip install ansys-fluent-visualization[single-window]\n\nAlternatively, install the latest release from `GitHub\n<https://github.com/ansys/pyfluent-visualization>`_ with:\n\n.. code:: console\n\n pip install git+https://github.com/ansys/pyfluent-visualization.git\n\n\nIf you plan on doing local *development* of PyFluent-Visualization with Git,\ninstall with:\n\n.. code:: console\n\n git clone https://github.com/ansys/pyfluent-visualization.git\n cd pyfluent-visualization\n pip install pip -U\n pip install -e .\n\nDependencies\n------------\nYou must have a licensed copy of Ansys Fluent installed locally.\nPyFluent-Visualization supports Ansys Fluent 2022 R2 and\nlater.\n\nGetting started\n---------------\n\nBasic usage\n~~~~~~~~~~~\nThe following code assumes that a PyFluent session has already been created\nand a Fluent case with input parameters has been set up. For a complete\nexample, see `Analyzing your results\n<https://visualization.fluent.docs.pyansys.com/version/stable/users_guide/index.html>`_ in\nthe PyFluent-Visualization documentation.\n\n.. code:: python\n\n from ansys.fluent.visualization import Contour, GraphicsWindow\n from ansys.fluent.core.solver import VelocityInlets, PressureOutlets, using\n from ansys.units import VariableCatalog\n\n graphics_window = GraphicsWindow()\n\n # Use an existing PyFluent solver session for the duration of this block\n with using(solver_session):\n # Define a contour plot of static pressure across all velocity inlets and pressure outlets\n pressure_contour = Contour(field=VariableCatalog.STATIC_PRESSURE, surfaces=VelocityInlets() + PressureOutlets())\n graphics_window.add_graphics(pressure_contour)\n graphics_window.show()\n\nUsage in a JupyterLab environment\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\nPyFluent-Visualization uses PyVista, which has the ability to display fully\nfeatured plots within a JupyterLab environment using ipyvtklink. Find out\nabout using ipyvtklink with PyVista `here <https://docs.pyvista.org/user-guide/jupyter/ipyvtk_plotting.html>`\n\nLicense and acknowledgments\n---------------------------\nPyFluent-Visualization is licensed under the MIT license.\n\nPyFluent-Visualization makes no commercial claim over Ansys\nwhatsoever. This tool extends the functionality of Ansys Fluent\nby adding a Python interface to Fluent without changing the\ncore behavior or license of the original software. The use of the\ninteractive Fluent control of PyFluent-Visualization requires\na legally licensed local copy of Fluent.\n\nFor more information on Fluent, visit the `Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`_\npage on the Ansys website.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python wrapper for ansys Fluent visualization",
"version": "0.22.1",
"project_urls": {
"Documentation": "https://visualization.fluent.docs.pyansys.com/",
"Repository": "https://github.com/ansys/pyfluent-visualization",
"Source": "https://github.com/ansys/pyfluent-visualization",
"Tracker": "https://github.com/ansys/pyfluent-visualization/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b9338e12334a1c4fccbe6ddef9f1900795cad6f7b4cfefc67fcd61b463c6f1f2",
"md5": "59e786bfd13260e85e602995f76b445e",
"sha256": "8fb9562d3ac0c2b901d6436f487179d3e1116cf11e3d29a4182994a0a8f7b0c0"
},
"downloads": -1,
"filename": "ansys_fluent_visualization-0.22.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "59e786bfd13260e85e602995f76b445e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 80754,
"upload_time": "2025-09-19T10:15:15",
"upload_time_iso_8601": "2025-09-19T10:15:15.136822Z",
"url": "https://files.pythonhosted.org/packages/b9/33/8e12334a1c4fccbe6ddef9f1900795cad6f7b4cfefc67fcd61b463c6f1f2/ansys_fluent_visualization-0.22.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4925cd3a625395756d70f0e8b233a655f1f8982703c11ef2b37d28b9a38d22eb",
"md5": "818e4ccaa606983c063874b82d50de6f",
"sha256": "fb1c36707910611ead67be03e0ac4a515b80515f1e92e11db673e85ac1e78b06"
},
"downloads": -1,
"filename": "ansys_fluent_visualization-0.22.1.tar.gz",
"has_sig": false,
"md5_digest": "818e4ccaa606983c063874b82d50de6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 46898,
"upload_time": "2025-09-19T10:15:17",
"upload_time_iso_8601": "2025-09-19T10:15:17.136859Z",
"url": "https://files.pythonhosted.org/packages/49/25/cd3a625395756d70f0e8b233a655f1f8982703c11ef2b37d28b9a38d22eb/ansys_fluent_visualization-0.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-19 10:15:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pyfluent-visualization",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansys-fluent-visualization"
}
