Getting started#

This section describes how to install PyHPS in user mode. If you are interested in contributing to PyHPS, see Contribute for information on installing in developer mode.

Prerequisites#

You must have pip and Python 3.9, 3.10, 3.11, or 3.12 installed.

To see if a Python 3.x version is installed and available from your command line, run this command:
```
python --version
```
If you do not have a Python 3.x version installed, install the latest 3.x version from the Python organization’s Downloads page.
To see if you have pip installed, run this command:
```
pip --version
```
If you do not have pip installed, see Installing Packages in the Python Packaging User Guide.
To ensure that you have the latest version of pip, run this command:
```
python -m pip install -U pip
```

Installation#

To install PyHPS in user mode, run this command:

python -m pip install ansys-hps-client

Dependencies#

PyHPS requires these packages as dependencies:

requests
marshmallow
marshmallow_oneofschema
pydantic
PyJWT