Modules
Overview
The HQStage Modules command enables users to handle the quantum simulation modules.
Usage
To see all available commands of hqstage modules
type.
hqstage modules --help
Commands:
- download-examples: Download HQStage examples for your modules.
- install: Install a list of HQS Modules
- list: List HQStage Modules.
Sub-Commands
To see the available sub-commands and options of any HQStage Modules command type
hqstage modules <command> --help
Download-examples
Download HQStage examples for your modules.
To see the available sub-commands and options of modules install type
hqstage modules download-examples --help
hqstage modules download-examples [OPTIONS]
Options:
- –download-dir: (optional, PATH) The path to the directory to download the examples to.
Install
Install the HQStage Modules specified in NAMES.
To see the available sub-commands and options of modules install type
hqstage modules install --help
hqstage modules install [OPTIONS] [NAMES]
Options:
- –all: Install all available modules.
- –upgrade: Upgrade all installed packages while installing.
- –venv: (optional) The name of a virtual environment. For an overview run
hqstage envs list
.Takes precedence over--venv_path
. If neither--venv
nor--venv_path
is used modules will be installed into the default environment. - –venv_path: (PATH) The path to the virtual environment to use. Alternative to
--venv
. If neither--venv
nor--venv_path
is used modules will be installed into the default environment.
List
List HQStage Modules.
To see the available sub-commands and options of modules list type
hqstage modules list --help
hqstage modules list [options]
Options:
- –all: Show all modules available with the current license.
- –installed: Show installed modules.
- –venv: (TEXT) The name of a virtual environment to search for installed pacakges. For an overview run
hqstage envs list
.Takes precedence over--venv_path
. If neither--venv
nor--venv_path
is used modules will be installed into the default environment. - –venv_path: (PATH) The path to the virtual environment to use. If neither
--venv
nor--venv_path
is used modules will be installed into the default environment.