API Reference Guide

Learn how to access the HyperStudy Python API including online help, examples.

Launch the Python Console in HyperStudy

  1. Click View > Python Window or press F4.
    Figure 1.

Running Python Scripts

A Python script can be executed by any of the following three methods:
  1. Running HyperStudy executables with -pyfile.
    hst.exe or hstbatch.exe -pyfile myscript.py.
  2. Use the standard Python function in the console.
    sys.path.insert ("C:/Users/myscript_repository")
import myscript
  3. HyperStudy as a Python module.
    #myscript.py
import alt.hst.api.hstapp as hstapp
app = hstapp.HstBatchApp()
app.start()
…
app.close()
#end of file
hstpy.bat myscript.py

HyperStudy API Online Help

The basics of how to use the HyperStudy Python API and examples are covered in the HyperStudy API online help.