| Name | ansys-turbogrid-core JSON |
| Version |
0.5.1
JSON |
| download |
| home_page | None |
| Summary | A python wrapper for Ansys TurboGrid |
| upload_time | 2025-09-05 18:10:00 |
| maintainer | ANSYS, Inc. |
| docs_url | None |
| author | ANSYS, Inc. |
| requires_python | <4.0,>=3.10 |
| license | MIT |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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/ansys-turbogrid-core?logo=pypi
:target: https://pypi.org/project/ansys-turbogrid-core/
:alt: Python
.. |pypi| image:: https://img.shields.io/pypi/v/ansys-turbogrid-core.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-turbogrid-core
: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/blog/license/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.9, 3.10, 3.11 and 3.12 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 these commands
in the root directory:
.. code:: bash
python -m pip install poetry
python -m pip poetry lock
python -m pip poetry install --with doc,test
python -m pip poetry shell
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
Raw data
{
"_id": null,
"home_page": null,
"name": "ansys-turbogrid-core",
"maintainer": "ANSYS, Inc.",
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": "pyansys.core@ansys.com",
"keywords": null,
"author": "ANSYS, Inc.",
"author_email": "pyansys.core@ansys.com",
"download_url": "https://files.pythonhosted.org/packages/08/3c/26a9b5d3c0f892d79ecf51941fc8db12715da07fd4497418132e6b64df8f/ansys_turbogrid_core-0.5.1.tar.gz",
"platform": null,
"description": "PyTurboGrid\n================\n|pyansys| |python| |pypi| |GH-CI| |codecov| |MIT| |black|\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-turbogrid-core?logo=pypi\n :target: https://pypi.org/project/ansys-turbogrid-core/\n :alt: Python\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-turbogrid-core.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/ansys-turbogrid-core\n :alt: PyPI\n\n.. |codecov| image:: https://codecov.io/gh/ansys/pyturbogrid/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/ansys/pyturbogrid\n :alt: Codecov\n\n.. |GH-CI| image:: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/ansys/pyturbogrid/actions/workflows/ci.yml\n :alt: GH-CI\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/blog/license/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.. |intro| image:: https://github.com/ansys/pyturbogrid/raw/main/doc/source/_static/turbine_blade_squealer_tip_conformal_white_rounded.png\n :alt: TurboGrid\n :width: 600 \n\nPyTurboGrid is a Python wrapper for `Ansys TurboGrid`_, a high-quality turbomachinery\nmeshing software app. To run PyTurboGrid, you must have access to a licensed local copy\nof TurboGrid. PyTurboGrid supports Ansys TurboGrid 2023 R2 and later.\n\n\n|intro| \n\n.. inclusion-marker-do-not-remove\n\nInstallation\n------------\nThe ``ansys-turbogrid-core`` package supports Python 3.9, 3.10, 3.11 and 3.12 on Windows and Linux. Two modes\nof installation are available:\n\n- User installation\n- Developer installation\n\nUser installation\n~~~~~~~~~~~~~~~~~\nTo use PyTurboGrid, you must install the ``ansys-turbogrid-core`` package from `PyPI`_. \n\n#. To ensure that you have the latest version of `pip`_, run this command:\n\n .. code:: bash\n\n python -m pip install -U pip\n\n#. To install PyTurboGrid, run this command:\n\n .. code:: bash\n\n python -m pip install ansys-turbogrid-core\n\n\nDeveloper installation\n~~~~~~~~~~~~~~~~~~~~~~\nA developer installation consists of cloning the ``pyturbogrid`` repository\nand installing the project in editable mode. When you install PyTurboGrid from\nsource code, you can modify and enhance the code.\n\nOverall guidance on contributing to a PyAnsys library appears in the\n`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic\nin the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar\nwith this `guide <https://dev.docs.pyansys.com/>`_ before attempting to\ncontribute to PyTurboGrid.\n\n#. Clone the ``pyturbogrid`` repository:\n\n .. code:: bash\n\n git clone https://github.com/ansys/pyturbogrid.git\n \n\n#. To avoid incompatibilites in requirements when working in multiple\n Python projects, create and activate a virtual environment. For\n more information, see `Virtual environments`_ in the *PyAnsys\n Developer's Guide*.\n\n#. To ensure that you have the latest version of `pip`_, run this command:\n\n .. code:: bash\n\n python -m pip install -U pip\n\n#. Assuming that your current working directory is the top-level directory\n of your locally cloned ``pyturbogrid`` repository, install PyTurboGrid\n from this local repository in editable mode by running these commands \n in the root directory:\n \n .. code:: bash\n \n python -m pip install poetry\n python -m pip poetry lock\n python -m pip poetry install --with doc,test\n python -m pip poetry shell\n\nRequirements\n------------\nYou must have a licensed local installation of Ansys TurboGrid 2023 R2 or later.\n\nThe ``AWP_ROOTxxx`` environment variable, where ``xxx`` is the three-digit\nAnsys version, allows PyTurboGrid to find your local TurboGrid installation.\n\nA Windows installation automatically sets this root environment variable.\nFor example, if you install Ansys 2023 R2 in the default directory,\nthe installer sets the ``AWP_ROOT232`` environment variable to\n``C:\\Program Files\\ANSYS Inc\\v232``.\n\nA Linux installation does not automatically set this root environment\nvariable. For example, if you install Ansys 2023 R2 in the default\ndirectory, you must manually set the ``AWP_ROOT232`` environment\nvariable to ``/usr/ansys_inc/v232``.\n\nLicense and acknowledgments\n---------------------------\n\nPyTurboGrid is licensed under the MIT license.\n\nPyTurboGrid makes no commercial claim over Ansys whatsoever. This library extends the\nfunctionality of Ansys TurboGrid by adding a Python interface to TurboGrid without\nchanging the core behavior or license of the original software. The use of the\ninteractive control of PyTurboGrid requires a legally licensed local copy of TurboGrid.\n\nFor more information on TurboGrid, see the `Ansys TurboGrid`_ page on the Ansys website.\n\n.. LINKS AND REFERENCES\n.. _Ansys TurboGrid: https://www.ansys.com/products/fluids/ansys-turbogrid\n.. _black: https://github.com/psf/black\n.. _flake8: https://flake8.pycqa.org/en/latest/\n.. _isort: https://github.com/PyCQA/isort\n.. _pip: https://pypi.org/project/pip/\n.. _pre-commit: https://pre-commit.com/\n.. _PyAnsys Developer's Guide: https://dev.docs.pyansys.com/\n.. _pytest: https://docs.pytest.org/en/stable/\n.. _PyPI: https://pypi.org/\n.. _Sphinx: https://www.sphinx-doc.org/en/master/\n.. _tox: https://tox.wiki/\n.. _Virtual environments: https://dev.docs.pyansys.com/how-to/setting-up.html#virtual-environments\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python wrapper for Ansys TurboGrid",
"version": "0.5.1",
"project_urls": {
"Documentation": "https://turbogrid.docs.pyansys.com/version/stable/",
"Homepage": "https://turbogrid.docs.pyansys.com",
"Repository": "https://github.com/ansys/pyturbogrid",
"Source": "https://github.com/ansys/pyturbogrid",
"Tracker": "https://github.com/ansys/pyturbogrid/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6b6dc1494dc99b45868846767eaae37aee196edc1a67b47fd1ba872532b94d86",
"md5": "cc6f53d815da6045a770948cab4370e1",
"sha256": "48e753cfaed75bebcde426e9d047d0090b0c13ea1c8339fae389b9f464672423"
},
"downloads": -1,
"filename": "ansys_turbogrid_core-0.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cc6f53d815da6045a770948cab4370e1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 46136,
"upload_time": "2025-09-05T18:09:58",
"upload_time_iso_8601": "2025-09-05T18:09:58.971580Z",
"url": "https://files.pythonhosted.org/packages/6b/6d/c1494dc99b45868846767eaae37aee196edc1a67b47fd1ba872532b94d86/ansys_turbogrid_core-0.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "083c26a9b5d3c0f892d79ecf51941fc8db12715da07fd4497418132e6b64df8f",
"md5": "dcb95b7fb14d05f1773226b48b048fe1",
"sha256": "66f94f021558a76ee1d4b0dfeb22079be1220fdf2b4dd0abc262b97b9c1db795"
},
"downloads": -1,
"filename": "ansys_turbogrid_core-0.5.1.tar.gz",
"has_sig": false,
"md5_digest": "dcb95b7fb14d05f1773226b48b048fe1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 35309,
"upload_time": "2025-09-05T18:10:00",
"upload_time_iso_8601": "2025-09-05T18:10:00.626455Z",
"url": "https://files.pythonhosted.org/packages/08/3c/26a9b5d3c0f892d79ecf51941fc8db12715da07fd4497418132e6b64df8f/ansys_turbogrid_core-0.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-05 18:10:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pyturbogrid",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "ansys-turbogrid-core"
}
