Getting started#

PyTurboGrid provides access to Ansys TurboGrid from a Python environment.

To run PyTurboGrid, you must have a licensed local installation of Ansys TurboGrid from Release 2023 R2.

How to install#

To use PyTurboGrid, the ansys-turbogrid-core package must be installed from PyPI. This package is supported with Python 3.10 on Windows and Linux.

1. In order to install PyTurboGrid, ensure you have the latest version of pip. To update pip, run:

python -m pip install -U pip

  1. Then, you can simply execute:

python -m pip install ansys-turbogrid-core

Installing PyTurboGrid from source code allows you to modify the source and enhance it. Before contributing to the project, please refer to the PyAnsys Developer’s guide. You will need to follow these additional steps:

  1. Clone the pyturbogrid repository:

git clone https://github.com/ansys/pyturbogrid.git

It is recommended to use a Python virtual environment for the steps below, and whenever you run PyTurbogrid from the source code. Please refer to the PyAnsys documentation on virtual environment for the steps to create and activate a virtual environment.

Assuming that a suitable Python environment is active, pip has been updated, and the current working directory is the top-level directory of the pyturbogrid repository cloned locally, the following steps will install the package from the local repository.

  1. Install the project in editable mode:

python -m pip install -e .

Requirements#

You must have a licensed local installaton of Ansys TurboGrid. PyTurboGrid supports Ansys TurboGrid Release 2023 R2. The Windows installation of Ansys automatically sets the required environment variable for PyTurboGrid to find the local TurboGrid installation. For example, if Ansys Release 2023 R2 is installed in the default directory, the installer automatically sets an environment variable AWP_ROOT232 to point to C:\Program Files\ANSYS Inc\v232.

On Linux, the required environment variable is not set automatically and you must set this manually. For example, if Ansys Release 2023 R2 is installed in the default directory, the AWP_ROOT232 environment variable must be set to /usr/ansys_inc/v232.