ansys-turbogrid-core 0.4.1

Description:

ansysturbogridcore 0.4.1

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.


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:
python -m pip install -U pip

To install PyTurboGrid, run this command:
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 topic
in the PyAnsys Developer’s Guide. Ensure that you are thoroughly familiar
with this guide before attempting to
contribute to PyTurboGrid.

Clone the pyturbogrid repository:
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:
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:
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.