Overview of HQStage CLI

The HQStage Python package provides a command line interface (CLI) for managing HQS Software Modules.

The motivation of this package is to have an easy-to-use entry point to get started with software developed by HQS on most systems without the need to perform a lot of manual installation steps.

Please start using HQStage by reading the installation instructions and the basic usage guide. If required, the HQStage CLI commands API can be used by an experienced user as described in the API reference section.

Features

The HQStage CLI tool comes with the following features:

• Automatic dependency management inside virtual environments
• Easily install HQStage Modules alongside other Python packages inside virtual environments
• Update HQStage Modules
• Automatic license management and download for HQStage Modules - no struggling with license files or other inconveniences

Basic commands

The HQStage CLI comes with a set of (sub-)commands described in the following subsections.

After installing HQStage you can run HQStage with the

hqstage

command in your terminal.

Within HQStage our software tools are called Modules. You can install modules into your current environment using the

hqstage install <module>

command. The same command can be used to install other Python packages from pypi.org. To get an overview of your licensed HQStage Modules run

hqstage modules

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-examples.
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 use

hqstage --help

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

hqstage <command> --help

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

hqstage --info

Open-source software components