Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

...

Please refer to the Software Compatibility page to know which version of Python is supported in each version. The HYPERSIM API requires a few python modules (notably around the gRPC technology used by the API). If some packages are missing, the previous import will return an error, and a message explaining the command to install the required packages.

Note: HYPERSIM packages its own python version which is compatible with the API. It can be found at C:\OPAL-RT\HYPERSIM\hypersim_version\Windows\PythonHS. 

Installing a Python IDE

The second way to use Python is to install Eclipse with the PyDev module to get an interactive python environment.

...

import os
import sys
sys.path.append(os.path.join(os.environ['HYPERSIM_DIR'], 'Windows', 'HyApi', 'python'))

In all cases, you can then import the HYPERSIM API via the following line.

...

If you used a previous version of HYPERSIM, you might have some python scripts that were written in Python 2.7. As of HYPERSIM 2023.1, you will need to migration migrate from python 2 to python 3 to be able to continue using these scripts.

...