Getting started

The Ansys Engineering Workflow API supports Python 3.9 through 3.12 on Windows, MacOS, and Linux.

Two installation modes of the ansys-engineeringworkflow-api package are provided: user and developer. This section describes how to install in user mode.

Note

If you are interested in contributing to this package, see Contribute for information on installing in developer mode.

Installation

Before installing the ansys-engineeringworkflow-api package, make sure that you have the latest version of pip with this command:

python -m pip install -U pip

Then, install the latest ansys-engineeringworkflow-api package with this command:

python -m pip install ansys-engineeringworkflow-api

Alternatively, you can install the latest version from the project’s GitHub repository with this command:

pip install git+https://github.com/ansys/ansys-engineeringworkflow-api