Usage

After installing HQStage you can run HQStage with the hqstage command in your terminal. The CLI comes with a set of (sub-)commands described in the following sections of this user guide.

HQStage Modules Within HQStage our software tools are called Modules. You can install modules into your current environment using the hqstage install command. hqstage modules provides an overview of your licensed HQStage Modules.

Other Python Packages With hqstage install you can also install Python packages from pypi.org.

Intel’s Math Kernel Library Some HQStage Modules use Intel’s MKL library to accelerate mathematical calculations. You can install MKL using hqstage install mkl. The command ensures that runtime libraries of mkl are present in the correct format in your environments lib folder.

Typical workflow using HQStage

A typical workflow to setup and run Python interpreters with access to HQStage Modules is to

  1. create a virtual environment using venv or mamba and install hqstage.
  2. install required HQStage Modules and Python packages, e.g., hqstage install hqs_noise_app_py matplotlib mkl
  3. Download HQStage examples using hqstage donwload-exampels.
  4. Start a Jupyter server using python -m jupyter notebook and start creating a notebook that realizes your next simulation using HQStage Modules or write a python script using our modules and execute with python script.py.

Getting help in the terminal

To see all available commands of HQStage type

hqstage --help

To see the available sub-commands and options of any HQStage command type

hqstage <command> --help

To get an overview of your current license and hqstage setup run

hqstage --info