HyperStudy

In this page you can find information regarding the HyperStudy Python API.

• alt.hst.api.session Module: The main entry point into the API

• alt.hst.api.api_objects Module: Contains all the classes and methods that are used to create and manage HyperStudy studies.

• alt.hst.api.hstapp Module: Contains the class used to create a new HyperStudy instance.

• alt.hst.api.dataset Module: Contains classes and methods to access datasets in HyperStudy.

• alt.hst.api.evaluation_config Module: Contains classes and methods to setup custom evaluation configurations.

• alt.hst.api.import_utilities Module: Contains utility functions for importing Python modules while using HyperStudy.

• alt.hst.gui.custom_plot Module: Contains classes and methods to create custom post-processing plots in HyperStudy.

• Verifying HyperStudy Scripts: Contains information about how to verify scripts written using the HyperStudy API.

In the Examples section, you will find examples about the API usage.