ansys-tools-visualization-interface 0.1.0__tar.gz

ansys_tools_visualization_interface-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Ansys Internal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ansys_tools_visualization_interface-0.1.0/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.1
+Name: ansys-tools-visualization-interface
+Version: 0.1.0
+Summary: A Python visualization interface for PyAnsys libraries
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.9,<4
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: pyvista >= 0.42.0,<1
+Requires-Dist: beartype >= 0.17.0,<1
+Requires-Dist: websockets >= 12.0,<13
+Requires-Dist: trame >= 3.6.0,<4
+Requires-Dist: trame-vtk >= 2.8.7,<3
+Requires-Dist: trame-vuetify >= 2.4.3,<3
+Requires-Dist: ansys-sphinx-theme==0.15.2 ; extra == "doc"
+Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "doc"
+Requires-Dist: jupytext==1.16.2 ; extra == "doc"
+Requires-Dist: nbsphinx==0.9.3 ; extra == "doc"
+Requires-Dist: numpydoc==1.7.0 ; extra == "doc"
+Requires-Dist: sphinx==7.3.7 ; extra == "doc"
+Requires-Dist: sphinx-autoapi==3.1.0b0 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: sphinx_design==0.5.0 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.16.0 ; extra == "doc"
+Requires-Dist: sphinx-jinja==2.0.2 ; extra == "doc"
+Requires-Dist: pytest==8.2.0 ; extra == "tests"
+Requires-Dist: pytest-pyvista==0.1.9 ; extra == "tests"
+Requires-Dist: pytest-cov==5.0.0 ; extra == "tests"
+Provides-Extra: doc
+Provides-Extra: tests
+
+Visualization Interface Tool
+============================
+|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::
+
+Overview
+--------
+
+Visualization Interface tool is a Python API that provides an interface between PyAnsys libraries and
+different plotting backends.
+
+Visualization Interface tool offers these main features:
+
+* Serves as an interface between PyAnsys and other plotting libraries (although only
+  `PyVista <https://docs.pyvista.org/version/stable/>`_ is supported currently).
+* Provides out-of-the box picking, viewing, and measuring functionalities.
+* Supplies an extensible class for adding custom functionalities.
+
+Documentation and issues
+------------------------
+
+Documentation for the latest stable release of Visualization Interface tool is hosted
+at `Visualization Interface tool documentation <https://visualization-interface.tools.docs.pyansys.com/version/dev/>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://visualization-interface.tools.docs.pyansys.com/version/dev/getting_started/index.html>`_: Learn
+  how to install Visualization Interface tool in user mode and quickly begin using it.
+- `User guide <https://visualization-interface.tools.docs.pyansys.com/version/dev/user_guide/index.html>`_: Understand key
+  concepts for implementing Visualization Interface tool in your workflow.
+- `API reference <https://visualization-interface.tools.docs.pyansys.com/version/dev/api/index.html>`_: Understand how to
+  use Python to interact programmatically with Visualization Interface tool.
+- `Examples <visualization-interface.tools.docs.pyansys.com/version/dev/examples/index.html>`_: Explore examples that
+  show how to use Visualization Interface tool to perform many different types of operations.
+- `Contribute <https://visualization-interface.tools.docs.pyansys.com/version/dev/contributing/index.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 Visualization Interface tool, ask your
+question in an issue as described in the previous paragraph.
+
+License
+-------
+
+Visualization Interface tool is licensed under the `MIT License <https://github.com/ansys/ansys-tools-visualization-interface/blob/main/LICENSE>`_.
+
+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.
+

ansys_tools_visualization_interface-0.1.0/README.rst

@@ -0,0 +1,85 @@
+Visualization Interface Tool
+============================
+|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::
+
+Overview
+--------
+
+Visualization Interface tool is a Python API that provides an interface between PyAnsys libraries and
+different plotting backends.
+
+Visualization Interface tool offers these main features:
+
+* Serves as an interface between PyAnsys and other plotting libraries (although only
+  `PyVista <https://docs.pyvista.org/version/stable/>`_ is supported currently).
+* Provides out-of-the box picking, viewing, and measuring functionalities.
+* Supplies an extensible class for adding custom functionalities.
+
+Documentation and issues
+------------------------
+
+Documentation for the latest stable release of Visualization Interface tool is hosted
+at `Visualization Interface tool documentation <https://visualization-interface.tools.docs.pyansys.com/version/dev/>`_.
+
+The documentation has these sections:
+
+- `Getting started <https://visualization-interface.tools.docs.pyansys.com/version/dev/getting_started/index.html>`_: Learn
+  how to install Visualization Interface tool in user mode and quickly begin using it.
+- `User guide <https://visualization-interface.tools.docs.pyansys.com/version/dev/user_guide/index.html>`_: Understand key
+  concepts for implementing Visualization Interface tool in your workflow.
+- `API reference <https://visualization-interface.tools.docs.pyansys.com/version/dev/api/index.html>`_: Understand how to
+  use Python to interact programmatically with Visualization Interface tool.
+- `Examples <visualization-interface.tools.docs.pyansys.com/version/dev/examples/index.html>`_: Explore examples that
+  show how to use Visualization Interface tool to perform many different types of operations.
+- `Contribute <https://visualization-interface.tools.docs.pyansys.com/version/dev/contributing/index.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 Visualization Interface tool, ask your
+question in an issue as described in the previous paragraph.
+
+License
+-------
+
+Visualization Interface tool is licensed under the `MIT License <https://github.com/ansys/ansys-tools-visualization-interface/blob/main/LICENSE>`_.
+
+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.

ansys_tools_visualization_interface-0.1.0/pyproject.toml

@@ -0,0 +1,93 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "ansys-tools-visualization-interface"
+version = "0.1.0"
+description = "A Python visualization interface for PyAnsys libraries"
+readme = "README.rst"
+requires-python = ">=3.9,<4"
+license = { file = "LICENSE" }
+authors = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
+maintainers = [{ name = "ANSYS, Inc.", email = "pyansys.core@ansys.com" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Science/Research",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "pyvista >= 0.42.0,<1",
+    "beartype >= 0.17.0,<1",
+    "websockets >= 12.0,<13",
+    "trame >= 3.6.0,<4",
+    "trame-vtk >= 2.8.7,<3",
+    "trame-vuetify >= 2.4.3,<3",
+]
+
+[project.optional-dependencies]
+tests = ["pytest==8.2.0", "pytest-pyvista==0.1.9", "pytest-cov==5.0.0"]
+doc = [
+    "ansys-sphinx-theme==0.15.2",
+    "jupyter_sphinx==0.5.3",
+    "jupytext==1.16.2",
+    "nbsphinx==0.9.3",
+    "numpydoc==1.7.0",
+    "sphinx==7.3.7",
+    "sphinx-autoapi==3.1.0b0",
+    "sphinx-copybutton==0.5.2",
+    "sphinx_design==0.5.0",
+    "sphinx-gallery==0.16.0",
+    "sphinx-jinja==2.0.2",
+]
+
+[tool.flit.module]
+name = "ansys.tools.visualization_interface"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 100
+default_section = "THIRDPARTY"
+src_paths = ["doc", "src", "tests"]
+
+[tool.pytest.ini_options]
+addopts = "-ra --cov=ansys.tools.visualization_interface --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv --image_cache_dir tests/_image_cache --add_missing_images"
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["examples/**/*.py"]
+
+[tool.ruff.lint]
+select = [
+    "E",   # pycodestyle, see https://beta.ruff.rs/docs/rules/#pycodestyle-e-w
+    "D",   # pydocstyle, see https://beta.ruff.rs/docs/rules/#pydocstyle-d
+    "F",   # pyflakes, see https://beta.ruff.rs/docs/rules/#pyflakes-f
+    "I",   # isort, see https://beta.ruff.rs/docs/rules/#isort-i
+    "N",   # pep8-naming, see https://beta.ruff.rs/docs/rules/#pep8-naming-n
+    "PTH", # flake8-use-pathlib, https://beta.ruff.rs/docs/rules/#flake8-use-pathlib-pth
+]
+ignore = ["D416"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "tab"
+line-ending = "auto"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+force-sort-within-sections = true
+known-first-party = ["ansys"]
+
+[tool.ruff.lint.pydocstyle]
+# Settings: https://docs.astral.sh/ruff/settings/#lintpydocstyle
+convention = "google"

ansys_tools_visualization_interface-0.1.0/src/ansys/tools/visualization_interface/__init__.py

@@ -0,0 +1,39 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Visualization Interface tool is a Python client library for visualizing the results of Ansys simulations."""
+import os
+
+import pkg_resources
+
+__version__ = pkg_resources.get_distribution("ansys-tools-visualization-interface").version
+
+USE_TRAME: bool = False
+DOCUMENTATION_BUILD: bool = False
+TESTING_MODE: bool = os.environ.get("PYANSYS_VISUALIZER_TESTMODE", "false").lower() == "true"
+
+from ansys.tools.visualization_interface.plotter import Plotter  # noqa: F401, E402
+from ansys.tools.visualization_interface.types.edge_plot import EdgePlot  # noqa: F401, E402
+from ansys.tools.visualization_interface.types.mesh_object_plot import (  # noqa: F401, E402
+    MeshObjectPlot,
+)
+from ansys.tools.visualization_interface.utils.clip_plane import ClipPlane  # noqa: F401, E402
+from ansys.tools.visualization_interface.utils.color import Color  # noqa: F401, E402

ansys_tools_visualization_interface-0.1.0/src/ansys/tools/visualization_interface/backends/__init__.py

@@ -0,0 +1,22 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Provides interfaces."""

ansys_tools_visualization_interface-0.1.0/src/ansys/tools/visualization_interface/backends/_base.py

@@ -0,0 +1,45 @@
+# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Module for the backend base class."""
+from abc import ABC, abstractmethod
+
+from beartype.typing import Any, Iterable
+
+
+class BaseBackend(ABC):
+    """Base class for plotting backends."""
+
+    @abstractmethod
+    def plot(self, object: Any, **plotting_options):
+        """Plot the specified object."""
+        raise NotImplementedError("plot method must be implemented")
+
+    @abstractmethod
+    def plot_iter(self, object: Iterable):
+        """Plot the elements of an iterable."""
+        raise NotImplementedError("plot_iter method must be implemented")
+
+    @abstractmethod
+    def show(self):
+        """Show the plotted objects."""
+        raise NotImplementedError("show method must be implemented")

ansys_tools_visualization_interface-0.1.0/src/ansys/tools/visualization_interface/backends/pyvista/__init__.py

@@ -0,0 +1,26 @@
+# Copyright (C) 2023 - 2024 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+"""Provides interfaces."""
+from ansys.tools.visualization_interface.backends.pyvista.pyvista import (  # noqa: F401
+    PyVistaBackend,
+    PyVistaBackendInterface,
+)