|pyansys| |python| |pypi| |MIT| |GH-CI| |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-tools-visualization-interface?logo=pypi :target: https://pypi.org/project/ansys-tools-visualization-interface/ :alt: Python
.. |pypi| image:: https://img.shields.io/pypi/v/ansys-tools-visualization-interface.svg?logo=python&logoColor=white :target: https://pypi.org/project/ansys-tools-visualization-interface :alt: PyPI
.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg :target: https://opensource.org/licenses/MIT :alt: MIT
.. |GH-CI| image:: https://github.com/ansys/ansys-tools-visualization-interface/actions/workflows/ci_cd.yml/badge.svg :target: https://github.com/ansys/ansys-tools-visualization-interface/actions/workflows/ci_cd.yml :alt: GH-CI
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/ansys-tools-visualization-interface/main.svg :target: https://results.pre-commit.ci/latest/github/ansys/ansys-tools-visualization-interface/main :alt: pre-commit.ci status
.. contents::
The Visualization Interface Tool is a Python API that provides an interface between PyAnsys libraries and different plotting backends.
The Visualization Interface Tool offers these main features:
PyVista <https://docs.pyvista.org/version/stable/>_ is supported currently).Documentation for the latest stable release of the Visualization Interface Tool is hosted
at Visualization Interface Tool documentation <https://visualization-interface.tools.docs.pyansys.com/version/stable/index.html>_.
The documentation has these sections:
Getting started <https://visualization-interface.tools.docs.pyansys.com/version/stable/getting_started/index.html>_: Learn
how to install the Visualization Interface Tool in user mode and quickly begin using it.User guide <https://visualization-interface.tools.docs.pyansys.com/version/stable/user_guide/index.html>_: Understand key
concepts for implementing the Visualization Interface Tool in your workflow.API reference <https://visualization-interface.tools.docs.pyansys.com/version/stable/api/index.html>_: Understand how to
use Python to interact programmatically with the Visualization Interface Tool.Examples <https://visualization-interface.tools.docs.pyansys.com/version/stable/examples/index.html>_: Explore examples that
show how to use the Visualization Interface Tool to perform many different types of operations.Contribute <https://visualization-interface.tools.docs.pyansys.com/version/stable/contributing.html>_: Learn how to
contribute to the Visualization Interface Tool codebase or 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 Visualization Interface Tool Issues <https://github.com/ansys/ansys-tools-visualization-interface/issues>
page, you can create issues to report bugs and request new features. On the
Discussions <https://discuss.ansys.com/> page on the Ansys Developer portal,
you can post questions, share ideas, and get community feedback.
If you have general questions about the PyAnsys ecosystem, email
pyansys.core@ansys.com <pyansys.core@ansys.com>_. If your
question is specific to the Visualization Interface Tool, ask your
question in an issue as described in the previous paragraph.
The Visualization Interface Tool is licensed under the MIT License <https://github.com/ansys/ansys-tools-visualization-interface/blob/main/LICENSE>_.
The Visualization Interface Tool makes no commercial claim over Ansys whatsoever. This library adds a Python interface for visualizing Ansys results without changing the core behavior or license of the original Ansys software.