ansys-turbogrid-core 0.3.dev0__tar.gz

ansys_turbogrid_core-0.3.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 ANSYS, Inc. All rights reserved.
+
+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_turbogrid_core-0.3.dev0/PKG-INFO

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: ansys-turbogrid-core
+Version: 0.3.dev0
+Summary: A python wrapper for Ansys TurboGrid
+Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
+Requires-Python: >=3.8,<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
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: ansys-turbogrid-api>=0.3.dev0
+Requires-Dist: matplotlib>=3.5.1
+Requires-Dist: importlib-metadata>=4.0
+Requires-Dist: ansys-sphinx-theme==0.9.9 ; extra == "doc"
+Requires-Dist: autodocsumm==0.2.11 ; extra == "doc"
+Requires-Dist: ipyvtklink==0.2.3 ; extra == "doc"
+Requires-Dist: jupyter_sphinx==0.4.0 ; extra == "doc"
+Requires-Dist: jupytext==1.14.6 ; extra == "doc"
+Requires-Dist: nbconvert==7.6.0 ; extra == "doc"
+Requires-Dist: nbsphinx==0.9.2 ; extra == "doc"
+Requires-Dist: notebook==6.5.4 ; extra == "doc"
+Requires-Dist: numpydoc==1.5.0 ; extra == "doc"
+Requires-Dist: panel==1.1.1 ; extra == "doc"
+Requires-Dist: Sphinx==7.0.1 ; extra == "doc"
+Requires-Dist: sphinx-autoapi==2.1.1 ; extra == "doc"
+Requires-Dist: sphinx-autodoc-typehints==1.23.2 ; extra == "doc"
+Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
+Requires-Dist: sphinx-gallery==0.13.0 ; extra == "doc"
+Requires-Dist: matplotlib>=3.5.1 ; extra == "tests"
+Requires-Dist: pytest==7.2.2 ; extra == "tests"
+Requires-Dist: pytest-cov==4.1.0 ; extra == "tests"
+Project-URL: Documentation, https://turbogrid.docs.pyansys.com/version/stable/
+Project-URL: Homepage, https://turbogrid.docs.pyansys.com
+Project-URL: Source, https://github.com/ansys/pyturbogrid
+Project-URL: Tracker, https://github.com/ansys/pyturbogrid/issues
+Provides-Extra: doc
+Provides-Extra: tests
+
+PyTurboGrid
+================
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |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/pyturbogrid?logo=pypi
+   :target: https://pypi.org/project/pyturbogrid/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/pyturbogrid.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/pyturbogrid
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/pyturbogrid/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pyturbogrid
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml
+   :alt: GH-CI
+
+.. |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
+
+.. |intro| image:: https://github.com/ansys/pyturbogrid/raw/main/doc/source/_static/turbine_blade_squealer_tip_conformal_white_rounded.png
+   :alt: TurboGrid
+   :width: 600 
+
+PyTurboGrid is a Python wrapper for `Ansys TurboGrid`_, a high-quality turbomachinery
+meshing software app. To run PyTurboGrid, you must have access to a licensed local copy
+of TurboGrid. PyTurboGrid supports Ansys TurboGrid 2023 R2 and later.
+
+
+|intro| 
+
+.. inclusion-marker-do-not-remove
+
+Installation
+------------
+The ``ansys-turbogrid-core`` package supports Python 3.10 on Windows and Linux. Two modes
+of installation are available:
+
+- User installation
+- Developer installation
+
+User installation
+~~~~~~~~~~~~~~~~~
+To use PyTurboGrid, you must install the ``ansys-turbogrid-core`` package from `PyPI`_. 
+
+#. To ensure that you have the latest version of `pip`_, run this command:
+
+   .. code:: bash
+
+       python -m pip install -U pip
+
+#. To install PyTurboGrid, run this command:
+
+   .. code:: bash
+
+       python -m pip install ansys-turbogrid-core
+
+
+Developer installation
+~~~~~~~~~~~~~~~~~~~~~~
+A developer installation consists of cloning the ``pyturbogrid`` repository
+and installing the project in editable mode. When you install PyTurboGrid from
+source code, you can modify and enhance the code.
+
+Overall guidance on contributing to a PyAnsys library appears in the
+`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
+in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
+with this `guide <https://dev.docs.pyansys.com/>_` before attempting to
+contribute to PyTurboGrid.
+
+#. Clone the ``pyturbogrid`` repository:
+
+   .. code:: bash
+
+       git clone https://github.com/ansys/pyturbogrid.git
+      
+
+#. To avoid incompatibilites in requirements when working in multiple
+   Python projects, create and activate a virtual environment. For
+   more information, see `Virtual environments`_ in the *PyAnsys
+   Developer's Guide*.
+
+#. To ensure that you have the latest version of `pip`_, run this command:
+
+   .. code:: bash
+
+       python -m pip install -U pip
+
+#. Assuming that your current working directory is the top-level directory
+   of your locally cloned ``pyturbogrid`` repository, install PyTurboGrid
+   from this local repository in editable mode by running this command:
+      
+   .. code:: bash
+   
+       python -m pip install -e . 
+
+Requirements
+------------
+You must have a licensed local installation of Ansys TurboGrid 2023 R2 or later.
+
+The ``AWP_ROOTxxx`` environment variable, where ``xxx`` is the three-digit
+Ansys version, allows PyTurboGrid to find your local TurboGrid installation.
+
+A Windows installation automatically sets this root environment variable.
+For example, if you install Ansys 2023 R2 in the default directory,
+the installer sets the ``AWP_ROOT232`` environment variable to
+``C:\Program Files\ANSYS Inc\v232``.
+
+A Linux installation does not automatically set this root environment
+variable. For example, if you install Ansys 2023 R2 in the default
+directory, you must manually set the ``AWP_ROOT232`` environment
+variable to ``/usr/ansys_inc/v232``.
+
+License and acknowledgments
+---------------------------
+
+PyTurboGrid is licensed under the MIT license.
+
+PyTurboGrid makes no commercial claim over Ansys whatsoever. This library extends the
+functionality of Ansys TurboGrid by adding a Python interface to TurboGrid without
+changing the core behavior or license of the original software. The use of the
+interactive control of PyTurboGrid requires a legally licensed local copy of TurboGrid.
+
+For more information on TurboGrid, see the `Ansys TurboGrid`_ page on the Ansys website.
+
+.. LINKS AND REFERENCES
+.. _Ansys TurboGrid: https://www.ansys.com/products/fluids/ansys-turbogrid
+.. _black: https://github.com/psf/black
+.. _flake8: https://flake8.pycqa.org/en/latest/
+.. _isort: https://github.com/PyCQA/isort
+.. _pip: https://pypi.org/project/pip/
+.. _pre-commit: https://pre-commit.com/
+.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
+.. _pytest: https://docs.pytest.org/en/stable/
+.. _PyPI: https://pypi.org/
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
+.. _tox: https://tox.wiki/
+.. _Virtual environments: https://dev.docs.pyansys.com/how-to/setting-up.html#virtual-environments
+

ansys_turbogrid_core-0.3.dev0/README.rst

@@ -0,0 +1,150 @@
+PyTurboGrid
+================
+|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|
+
+.. |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/pyturbogrid?logo=pypi
+   :target: https://pypi.org/project/pyturbogrid/
+   :alt: Python
+
+.. |pypi| image:: https://img.shields.io/pypi/v/pyturbogrid.svg?logo=python&logoColor=white
+   :target: https://pypi.org/project/pyturbogrid
+   :alt: PyPI
+
+.. |codecov| image:: https://codecov.io/gh/ansys/pyturbogrid/branch/main/graph/badge.svg
+   :target: https://codecov.io/gh/ansys/pyturbogrid
+   :alt: Codecov
+
+.. |GH-CI| image:: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml/badge.svg
+   :target: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml
+   :alt: GH-CI
+
+.. |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
+
+.. |intro| image:: https://github.com/ansys/pyturbogrid/raw/main/doc/source/_static/turbine_blade_squealer_tip_conformal_white_rounded.png
+   :alt: TurboGrid
+   :width: 600 
+
+PyTurboGrid is a Python wrapper for `Ansys TurboGrid`_, a high-quality turbomachinery
+meshing software app. To run PyTurboGrid, you must have access to a licensed local copy
+of TurboGrid. PyTurboGrid supports Ansys TurboGrid 2023 R2 and later.
+
+
+|intro| 
+
+.. inclusion-marker-do-not-remove
+
+Installation
+------------
+The ``ansys-turbogrid-core`` package supports Python 3.10 on Windows and Linux. Two modes
+of installation are available:
+
+- User installation
+- Developer installation
+
+User installation
+~~~~~~~~~~~~~~~~~
+To use PyTurboGrid, you must install the ``ansys-turbogrid-core`` package from `PyPI`_. 
+
+#. To ensure that you have the latest version of `pip`_, run this command:
+
+   .. code:: bash
+
+       python -m pip install -U pip
+
+#. To install PyTurboGrid, run this command:
+
+   .. code:: bash
+
+       python -m pip install ansys-turbogrid-core
+
+
+Developer installation
+~~~~~~~~~~~~~~~~~~~~~~
+A developer installation consists of cloning the ``pyturbogrid`` repository
+and installing the project in editable mode. When you install PyTurboGrid from
+source code, you can modify and enhance the code.
+
+Overall guidance on contributing to a PyAnsys library appears in the
+`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
+in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar
+with this `guide <https://dev.docs.pyansys.com/>_` before attempting to
+contribute to PyTurboGrid.
+
+#. Clone the ``pyturbogrid`` repository:
+
+   .. code:: bash
+
+       git clone https://github.com/ansys/pyturbogrid.git
+      
+
+#. To avoid incompatibilites in requirements when working in multiple
+   Python projects, create and activate a virtual environment. For
+   more information, see `Virtual environments`_ in the *PyAnsys
+   Developer's Guide*.
+
+#. To ensure that you have the latest version of `pip`_, run this command:
+
+   .. code:: bash
+
+       python -m pip install -U pip
+
+#. Assuming that your current working directory is the top-level directory
+   of your locally cloned ``pyturbogrid`` repository, install PyTurboGrid
+   from this local repository in editable mode by running this command:
+      
+   .. code:: bash
+   
+       python -m pip install -e . 
+
+Requirements
+------------
+You must have a licensed local installation of Ansys TurboGrid 2023 R2 or later.
+
+The ``AWP_ROOTxxx`` environment variable, where ``xxx`` is the three-digit
+Ansys version, allows PyTurboGrid to find your local TurboGrid installation.
+
+A Windows installation automatically sets this root environment variable.
+For example, if you install Ansys 2023 R2 in the default directory,
+the installer sets the ``AWP_ROOT232`` environment variable to
+``C:\Program Files\ANSYS Inc\v232``.
+
+A Linux installation does not automatically set this root environment
+variable. For example, if you install Ansys 2023 R2 in the default
+directory, you must manually set the ``AWP_ROOT232`` environment
+variable to ``/usr/ansys_inc/v232``.
+
+License and acknowledgments
+---------------------------
+
+PyTurboGrid is licensed under the MIT license.
+
+PyTurboGrid makes no commercial claim over Ansys whatsoever. This library extends the
+functionality of Ansys TurboGrid by adding a Python interface to TurboGrid without
+changing the core behavior or license of the original software. The use of the
+interactive control of PyTurboGrid requires a legally licensed local copy of TurboGrid.
+
+For more information on TurboGrid, see the `Ansys TurboGrid`_ page on the Ansys website.
+
+.. LINKS AND REFERENCES
+.. _Ansys TurboGrid: https://www.ansys.com/products/fluids/ansys-turbogrid
+.. _black: https://github.com/psf/black
+.. _flake8: https://flake8.pycqa.org/en/latest/
+.. _isort: https://github.com/PyCQA/isort
+.. _pip: https://pypi.org/project/pip/
+.. _pre-commit: https://pre-commit.com/
+.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/
+.. _pytest: https://docs.pytest.org/en/stable/
+.. _PyPI: https://pypi.org/
+.. _Sphinx: https://www.sphinx-doc.org/en/master/
+.. _tox: https://tox.wiki/
+.. _Virtual environments: https://dev.docs.pyansys.com/how-to/setting-up.html#virtual-environments

ansys_turbogrid_core-0.3.dev0/pyproject.toml

@@ -0,0 +1,105 @@
+[build-system]
+requires = ["flit_core >=3.2,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+# Check https://flit.readthedocs.io/en/latest/pyproject_toml.html for all available sections
+name = "ansys-turbogrid-core"
+version = "0.3.dev0"
+description = "A python wrapper for Ansys TurboGrid"
+readme = "README.rst"
+requires-python = ">=3.8,<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",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+]
+
+dependencies = [
+    "ansys-turbogrid-api>=0.3.dev0",
+    "matplotlib>=3.5.1",
+    "importlib-metadata>=4.0",
+]
+
+[project.optional-dependencies]
+tests = [
+    "matplotlib>=3.5.1",
+    "pytest==7.2.2",
+    "pytest-cov==4.1.0",
+]
+doc = [
+    "ansys-sphinx-theme==0.9.9",
+    "autodocsumm==0.2.11",
+    "ipyvtklink==0.2.3",
+    "jupyter_sphinx==0.4.0",
+    "jupytext==1.14.6",
+    "nbconvert==7.6.0",
+    "nbsphinx==0.9.2",
+    "notebook==6.5.4",
+    "numpydoc==1.5.0",
+    "panel==1.1.1",
+    "Sphinx==7.0.1",
+    "sphinx-autoapi==2.1.1",
+    "sphinx-autodoc-typehints==1.23.2",
+    "sphinx-copybutton==0.5.2",
+    "sphinx-gallery==0.13.0",
+]
+
+[project.urls]
+Source = "https://github.com/ansys/pyturbogrid"
+Homepage = "https://turbogrid.docs.pyansys.com"
+Documentation = "https://turbogrid.docs.pyansys.com/version/stable/"
+Tracker = "https://github.com/ansys/pyturbogrid/issues"
+
+[tool.flit.module]
+name = "ansys.turbogrid.core"
+
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = "black"
+force_sort_within_sections = true
+line_length = 120
+default_section = "THIRDPARTY"
+src_paths = ["doc", "src", "tests"]
+
+[[tool.poetry.source]]
+name = "privatepypi"
+url = "https://pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/"
+default = false
+secondary = true
+
+[tool.poetry.dependencies]
+python = ">=3.7,<4.0"
+ansys-turbogrid-api = {source = "privatepypi"}
+
+
+[tool.coverage.run]
+source = ["ansys.turbogrid.core"]
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.pytest.ini_options]
+minversion = "7.1"
+addopts = "-ra --cov=ansys.turbogrid.core --cov-report html:.cov/html --cov-report xml:.cov/xml --cov-report term -vv"
+testpaths = [
+    "tests",
+]

ansys_turbogrid_core-0.3.dev0/src/ansys/turbogrid/core/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2023 ANSYS, Inc. All rights reserved
+"""PyTurboGrid is a Python wrapper for Ansys TurboGrid."""
+
+from ansys.turbogrid.core.launcher.launcher import launch_turbogrid
+
+try:
+    import importlib.metadata as importlib_metadata
+except ModuleNotFoundError:  # pragma: no cover
+    import importlib_metadata
+
+# Read from the pyproject.toml
+# major, minor, patch
+__version__ = importlib_metadata.version("ansys-turbogrid-core")

ansys_turbogrid_core-0.3.dev0/src/ansys/turbogrid/core/launcher/launcher.py

@@ -0,0 +1,168 @@
+# Copyright (c) 2023 ANSYS, Inc. All rights reserved
+"""Module for launching a local instance of Ansys TurboGrid."""
+
+from enum import Enum
+import os
+from pathlib import Path
+import platform
+from typing import Optional
+
+from ansys.turbogrid.api import pyturbogrid_core
+
+
+def _is_windows():
+    """Check if Windows is the current operating system."""
+    return platform.system() == "Windows"
+
+
+class TurboGridVersion(Enum):
+    """Provide an enumeration over supported TurboGrid versions."""
+
+    # Versions must be listed here with the most recent first
+    version_23R2 = "23.2.0"
+
+    @classmethod
+    def _missing_(cls, version):
+        if isinstance(version, (float, str)):
+            version = str(version) + ".0"
+            for v in TurboGridVersion:
+                if version == v.value:
+                    return TurboGridVersion(version)
+            else:
+                raise RuntimeError(
+                    f"The passed version '{version[:-2]}' does not exist. "
+                    f"Available version strings are: "
+                    f"{[ver.value for ver in TurboGridVersion]} "
+                )
+
+    def __str__(self):
+        return str(self.value)
+
+
+def get_latest_ansys_version() -> str:
+    """Get the latest installed Ansys version from ``AWP_ROOTxxx`` environment variables.
+
+    .. note::
+       The ``xxx`` is the three-digit Ansys version. For example, the ``AWP_ROOT232``
+       environment variable specifies the path to the directory where Ansys 2023 R2
+       is installed. If Ansys 2023 R2 is installed in the default directory on Windows,
+       the value for this environment variable is ``C:\\Program Files\\ANSYS Inc\\v232``.
+
+    Returns
+    -------
+    str
+        Latest installed Ansys version in this format: ``"23.2.0"``.
+    """
+
+    for v in TurboGridVersion:
+        if "AWP_ROOT" + "".join(str(v).split("."))[:-1] in os.environ:
+            return str(v)
+
+    raise RuntimeError("No Ansys version can be found.")
+
+
+def get_turbogrid_exe_path(**launch_argvals) -> Path:
+    """Get the path to a local installation of TurboGrid.
+
+    The path is obtained by searching in this order:
+
+    1. The path specified by the ``turbogrid_path`` parameter from ``launch_argvals``.
+    2. The path specified by the ``PYTURBOGRID_TURBOGRID_ROOT`` environment variable.
+    3. The path of the TurboGrid installation specified by the ``product_version`` parameter
+       from ``launch_argvals``, using the corresponding ``AWP_ROOTxxx`` environment variable.
+    4. The path of the TurboGrid installation from the ``AWP_ROOTxxx`` environment variable for
+       the latest installed Ansys version.
+
+
+    Returns
+    -------
+    Path
+        Path of a local TurboGrid installation.
+    """
+
+    def get_turbogrid_root(version: TurboGridVersion) -> Path:
+        awp_root = os.environ["AWP_ROOT" + "".join(str(version).split("."))[:-1]]
+        return Path(awp_root) / "TurboGrid"
+
+    def get_exe_path(turbogrid_root: Path) -> Path:
+        if _is_windows():
+            return (
+                turbogrid_root / "bin" / "cfxtg.exe"
+            )  # pragma no cover (operating system dependent)
+        else:
+            return turbogrid_root / "bin" / "cfxtg"  # pragma no cover (operating system dependent)
+
+    # Look for TurboGrid exe path in the following order:
+    # 1. turbogrid_path parameter passed with launch_turbogrid
+    turbogrid_path = launch_argvals.get("turbogrid_path")
+    if turbogrid_path:
+        return Path(turbogrid_path)
+
+    # 2. "PYTURBOGRID_TURBOGRID_ROOT" environment variable
+    turbogrid_root = os.getenv("PYTURBOGRID_TURBOGRID_ROOT")
+    if turbogrid_root:
+        return get_exe_path(Path(turbogrid_root))
+
+    # 3. product_version parameter passed with launch_turbogrid
+    product_version = launch_argvals.get("product_version")
+    if product_version:
+        return get_exe_path(get_turbogrid_root(TurboGridVersion(product_version)))
+
+    # 4. the latest Ansys version from AWP_ROOT environment variables
+    ansys_version = get_latest_ansys_version()
+    return get_exe_path(get_turbogrid_root(TurboGridVersion(ansys_version)))
+
+
+def launch_turbogrid(
+    product_version: str = None,
+    turbogrid_path: str = None,
+    log_level: pyturbogrid_core.PyTurboGrid.TurboGridLogLevel = pyturbogrid_core.PyTurboGrid.TurboGridLogLevel.INFO,
+    additional_args_str: str = None,
+    additional_kw_args: dict = None,
+    port: Optional[int] = None,
+    **kwargs,
+) -> pyturbogrid_core.PyTurboGrid:
+    """Launch TurboGrid locally in server mode.
+
+    Parameters
+    ----------
+    product_version : str, default: ``None``
+        Version of TurboGrid to use in the numeric format. For example, ``"23.2.0"``
+        for 2023 R2. The default is ``None``, in which case the latest installed
+        version is used.
+    turbogrid_path : str, default: ``None``
+        Path to the ``cfxtg`` command for starting TurboGrid. The default is ``None``,
+        in which case the value for the ``product_version`` parameter is used.
+    log_level : pyturbogrid_core.PyTurboGrid.TurboGridLogLevel, default: ``INFO``
+        Level of logging information written to the terminal. The default is ``INFO``.
+        Options are ``INFO``, ``WARNING``, ``ERROR``, ``CRITICAL``, and ``DEBUG``.
+        This setting does not affect the level of output that is written to the log files.
+    additional_args_str : str, default: ``None``
+        Additional arguments to send to TurboGrid.
+    additional_kw_args : dict, default: ``None``
+        Additional arguments to send to TurboGrid.
+    port : int, default: ``None``
+        Port for TurboGrid communications. The default is ``None``, in which case
+        an available port is automatically selected.
+
+    Returns
+    -------
+    pyturbogrid_core.PyTurboGrid
+        TurboGrid session.
+    """
+    if kwargs:
+        raise TypeError(
+            f"launch_turbogrid() got an unexpected keyword argument {next(iter(kwargs))}"
+        )
+
+    argVals = locals()
+    pathToCFXTG = get_turbogrid_exe_path(**argVals)
+
+    return pyturbogrid_core.PyTurboGrid(
+        socket_port=port,
+        turbogrid_location_type=pyturbogrid_core.PyTurboGrid.TurboGridLocationType.TURBOGRID_INSTALL,
+        cfxtg_location=pathToCFXTG,
+        log_level=log_level,
+        additional_args_str=additional_args_str,
+        additional_kw_args=additional_kw_args,
+    )

ansys_turbogrid_core-0.3.dev0/src/ansys/turbogrid/core/mesh_statistics/mesh_statistics.py

@@ -0,0 +1,280 @@
+# Copyright (c) 2023 ANSYS, Inc. All rights reserved
+"""Module for facilitating analysis of mesh statistics."""
+import ansys.turbogrid.api as pytg
+
+
+class MeshStatistics:
+    """
+    Facilitates analysis of mesh statistics for the current mesh in a running session of
+    TurboGrid.
+    """
+
+    #: Interface to a running session of TurboGrid.
+    interface: pytg.pyturbogrid_core.PyTurboGrid = 0
+
+    #: Cache of the basic mesh statistics obtained by the last call to the
+    #: :func:`update_mesh_statistics` method or from the initialization of
+    #: the object if this method has not been called. The name of the domain
+    #: these statistics relate to is stored as the :attr:`current_domain`
+    #: attribute.
+    mesh_vars: dict = dict()
+
+    #: Domain that was used for the last update of the mesh statistics. See the :attr:`mesh_vars`
+    #: attribute.
+    current_domain: str = ""
+
+    def __init__(self, turbogrid_instance: pytg.pyturbogrid_core.PyTurboGrid, domain: str = "ALL"):
+        """
+        Initialize the class using a connection to a running session of TurboGrid.
+
+        Parameters
+        ----------
+        turbogrid_instance : pytg.pyturbogrid_core.PyTurboGrid
+            Running session of TurboGrid.
+        domain : str, default: ``"ALL"``
+            Name of the domain to get the initial statistics from. The default is ``"ALL"``,
+            in which case statistics are read for all domains.
+        """
+        self.interface = turbogrid_instance
+        self.mesh_vars = dict()
+        self.current_domain = str()
+        self._read_mesh_statistics(domain)
+
+    def _read_mesh_statistics(self, domain: str = "ALL") -> None:
+        self.mesh_vars.clear()
+        if "query_mesh_statistics" not in dir(self.interface):
+            raise self.interface.InvalidQuery(
+                "query_mesh_statistics"
+            )  # pragma no cover (won't occur with current TurboGrid data)
+        self.mesh_vars = self.interface.query_mesh_statistics(domain)
+        self.current_domain = domain
+
+    def get_mesh_statistics(self, variable: str = "ALL") -> dict:
+        """Get the basic mesh statistics from the cached mesh statistics.
+
+        Parameters
+        ----------
+        variable : str, default: ``"ALL"``
+            Mesh statistics variable to get statistics for. The default is
+            ``"ALL"``, in which case a dictionary of all variables is returned.
+
+        Returns
+        -------
+        dict
+            If a single variable is specified for the ``variable`` parameter, a
+            dictionary of the current mesh statistics values for the selected variable
+            is returned. Otherwise, if the default value of ``"ALL"`` is used for the
+            ``variable`` parameter, a dictionary of dictionaries (one per variable) is
+            returned.
+        """
+        if variable == "ALL":
+            return self.mesh_vars
+        else:
+            return self.mesh_vars[variable]
+
+    def update_mesh_statistics(self, domain: str = "ALL") -> None:
+        """Re-read the mesh statistics from TurboGrid.
+
+        This method can be used either to update the cached mesh statistics after TurboGrid
+        has remeshed or update the cached mesh statistics to use a different domain or domains.
+
+        Parameters
+        ----------
+        domain : str, default: ``"ALL"``
+            Name of the domain to get the statistics from. The default is ``"ALL"``, in which
+            case statistics are read for all domains.
+        """
+        self._read_mesh_statistics(domain)
+
+    def get_domain_label(self, domain: str) -> str:
+        """Get suitable label text for a domain.
+
+        Parameters
+        ----------
+        domain : str
+            Name of the domain to generate the label from.
+
+        Returns
+        -------
+        str
+            ``"All Domains"`` is returned if ``"ALL"`` is the value
+            specified for the ``domain`` parameter or ``"Domain: <name>"``
+            is returned if the name of a single domain is specified.
+
+        """
+        if domain == "ALL":
+            domain_label = "All Domains"
+        else:
+            domain_label = "Domain: " + domain
+        return domain_label
+
+    def _draw_histogram(
+        self,
+        variable: str,
+        bin_limits: list,
+        bin_values: list,
+        xlabel: str,
+        ylabel: str,
+        domain_label: str,
+        image_file: str,
+        show: bool,
+    ) -> None:
+        import matplotlib.pyplot as plt
+
+        fig, axs = plt.subplots(1, 1, num="PyTurboGrid Mesh Statistics")
+        axs.stairs(bin_values, bin_limits, fill=True)
+        axs.set_title(variable + "\n" + domain_label)
+        axs.set_xlabel(xlabel)
+        axs.set_ylabel(ylabel)
+        plt.grid(linestyle="--")
+        if image_file:
+            plt.savefig(image_file)
+        if show:
+            plt.show()  # pragma no cover (can't open a separate window in unit_tests)
+        else:
+            plt.close(fig)
+
+    def create_histogram(
+        self,
+        variable: str,
+        domain: str = "ALL",
+        use_percentages: bool = True,
+        bin_units: str = "",
+        image_file: str = "",
+        show: bool = True,
+    ) -> None:
+        """Create a histogram of mesh statistics using `Matplotlib <https://matplotlib.org/>`_.
+
+        Parameters
+        ----------
+        variable : str
+            Mesh statistics variable to use for the histogram.
+        domain : str, default: ``"ALL"``
+            Domain name to get statistics for. The default is ``"ALL"``, in which
+            case statistics for all domains are read. If a specific domain name
+            is supplied, statistics are read for only this domain. Cached mesh
+            statistics are not used or affected.
+        use_percentages : bool, default: ``False``
+            Whether to display the percentage values of the bin counts for
+            the histogram. The default is ``False``, in which case the actual bin
+            counts are shown.
+        bin_units : str, default: ``""``
+            Units for the mesh statistics values (x-axis labels). The default is
+            ``""``, in which case the current TurboGrid units are used.
+        image_file : str, default: ``""``
+            Name and extension for the image file to write the histogram to. The
+            default is ``""``, in which case no image file is written. The format
+            is determined by the file extension (such as ``.png``) given in the
+            file name. Available formats are those supported by Matplotlib,
+            including ``".png"``, ``".pdf"``, and ``".svg"``.
+        show : bool, default: True
+            Whether to display the image on the screen. If ``False``, the image is not
+            displayed on the screen, which is only useful if the image is
+            being written to a file.
+        """
+        if "query_mesh_statistics_histogram_data" not in dir(self.interface):
+            raise self.interface.InvalidQuery(
+                "query_mesh_statistics_histogram_data"
+            )  # pragma no cover (won't occur with current TurboGrid data)
+
+        histogram_stats = self.interface.query_mesh_statistics_histogram_data(
+            domain=domain, variable=variable, bin_units=bin_units
+        )
+
+        if use_percentages:
+            bin_values = histogram_stats["Bin Percentages"]
+            ylabel = "Percentage"
+        else:
+            bin_values = histogram_stats["Bin Totals"]
+            ylabel = "Count"
+
+        if histogram_stats["Bin Limits Units"]:
+            xlabel = variable + r" [" + histogram_stats["Bin Limits Units"] + r"]"
+        else:
+            xlabel = variable  # pragma no cover (won't occur with current TurboGrid data)
+
+        self._draw_histogram(
+            variable=variable,
+            bin_limits=histogram_stats["Bin Limits"],
+            bin_values=bin_values,
+            xlabel=xlabel,
+            ylabel=ylabel,
+            domain_label=self.get_domain_label(domain),
+            image_file=image_file,
+            show=show,
+        )
+
+    def get_table_rows(self) -> list:
+        """
+        Get the mesh statistics table data from the cached mesh statistics.
+
+        Returns
+        -------
+        list
+            List of row data. Each list item represents one table row. The list
+            item contains a list of the cell contents for each cell in the row.
+        """
+        row_data = list()
+        row_data.append(["Mesh Measure", "Value", "% Bad", "% ok", "%OK"])
+        for var_name, var_data in self.mesh_vars.items():
+            # Exclude variables which only have 'Count' set (e.g. 'Elements')
+            if "Maximum" in var_data:
+                data = list()
+                data.append(var_name)
+                if var_data["Limits Type"] == "Maximum":
+                    value = str(var_data["Maximum"])
+                elif var_data["Limits Type"] == "Minimum":
+                    value = str(var_data["Minimum"])
+                else:
+                    value = ""  # pragma no cover (won't occur with current TurboGrid data)
+                if value and var_data["Units"]:
+                    value += " [" + var_data["Units"] + "]"
+                data.append(value)
+                data.append(str(var_data["Percent Bad"]))
+                data.append(str(var_data["Percent ok"]))
+                data.append(str(var_data["Percent OK"]))
+                row_data.append(data)
+        return row_data
+
+    def write_table_to_csv(self, file_name: str) -> None:
+        """
+        Write the mesh statistics table to a CSV file.
+
+        The values in the mesh statistics table are obtained from the cached
+        mesh statistics.
+
+        Parameters
+        ----------
+        file_name : str
+            Name of the file to write the mesh statistics table to.
+        """
+        import csv
+
+        with open(file_name, "w", newline="") as f:
+            writer = csv.writer(f)
+            row_data = self.get_table_rows()
+            writer.writerow([self.get_domain_label(self.current_domain)])
+            for row in row_data:
+                writer.writerow(row)
+
+    def get_table_as_text(self) -> str:
+        """Get a text version of the mesh statistics table from the cached mesh statistics.
+
+        Returns
+        -------
+        str
+           Mesh statistics table in a text version.
+        """
+        table = "\n" + self.get_domain_label(self.current_domain) + "\n\n"
+        row_data = self.get_table_rows()
+        row_lengths = [9] * 5
+        for row in row_data:
+            for index, value in enumerate(row):
+                row_lengths[index] = max(row_lengths[index], len(value))
+        for row in row_data:
+            row_string = ""
+            for index, value in enumerate(row):
+                row_string += str(value).ljust(row_lengths[index]) + " "
+            table += row_string
+            table += "\n"
+        return table