tergite-autocalibration

Operation

The package ships with a CLI called acli (autocalibration command line interface) to solve some common tasks that appear quite often. In the following there are a number of useful commands, but if you want to find out information about commands in your shell use acli --help.

Since some of the commands below are using autocompleting in most cases you would have to enable that feature in your shell by running:

acli --install-completion

Usually the shell would just suggest you file paths when pressing the tabulator, but with autocompletion enabled, you would be even get suggestions for node names or other inputs depending on your configuration.

CLI

This section provides an overview of the Command Line Interface (CLI) options and their functionalities.

Main Commands

The autocalibration CLI is organized into several main command groups:

• cluster: Handle operations related to the cluster
• node: Handle operations related to the node
• graph: Handle operations related to the calibration graph
• config: Load and save the configuration files
• calibration: Handle operations related to the calibration supervisor
• browser: Will open the dataset browser, which makes you view the datasets from measurements
• joke: Handle operations related to the well-being of the user

Cluster Commands

cluster reboot

Reboots the cluster.

Usage:

acli cluster reboot

This command will prompt for confirmation before rebooting the cluster, as it can interrupt ongoing measurements.

Node Commands

node reset

Resets all parameters in Redis for the specified node(s).

Usage:

acli node reset [OPTIONS]

Options:

• -n, --name TEXT: Name of the node to be reset in Redis (e.g., resonator_spectroscopy)
• -a, --all: Reset all nodes
• -f, --from_node TEXT: Reset all nodes from the specified node in the chain

Graph Commands

graph plot

Plots the calibration graph to the user-specified target node in topological order.

Usage:

acli graph plot

This command visualizes the calibration graph using an arrow chart.

Configuration Commands

config load

Load the configuration.

Usage:

acli config load [OPTIONS]

Options:

• -f/--filepath: Path to the configuration package to load. It can be either to the configuration.meta.toml file or to a zip file containing the whole configuration.
• -t/--template: Path to the template package to load. The templates are located in tergite_autocalibration.config.templates. If the autocompletion is installed for acli, then the templates should be shown as suggestions automatically.

Notes:

To run this command, please navigate to the root directory of the repository. The configuration package will be placed into the root directory, which is the default location for the application to detect the configuration package.

config save

Usage:

acli config save [OPTIONS]

Save the configuration.

Options:

• -f/--filepath: Path to the configuration package to save. If the path name is ending with .zip, it will automatically create a zip file and treat it as if you are running with -z.
• -z/--as-zip: Will make the configuration file be a zip archive.

quickstart

Usage:

acli quickstart [OPTIONS]

Loads the default configuration package. This configuration package is not supposed to run on any setup, but it will just copy configuration files into the application, so, that the application does not crash because configuration files are missing.

Options:

• -q, --qubits TEXT: Indicates which qubits should be in the template e.g. "q00,q01" or "q03-q05", "q01-q03, q07" or an integer e.g. 3 to generate "q01, q02, q03".

Calibration Commands

start

Starts the calibration supervisor.

Usage:

acli start [OPTIONS]

Options:

• -c TEXT: Cluster IP address (if not set, it will use CLUSTER_IP from the .env file)
• -r TEXT: Rerun an analysis (specify the path to the dataset folder)
• -n, --name TEXT: Specify the node type to rerun (works only with -r option)
• --push: Push a backend to an MSS specified in MSS_MACHINE_ROOT_URL in the .env file
• --browser: Will open the dataset browser in the background and plot the measurement results live

Dataset browser

browser

Starts the dataset browser.

Usage:

acli browser --datadir [OPTIONS]

Options:

• --datadir PATH: Folder to take the plot data from
• --liveplotting: Whether plots should be updated in real time (default: False)
• --log-level INT: Log-level as in the Python logging package to be used in the logs (default: 30)

Joke Command

joke

Prints a random joke to lighten the mood.

Usage:

acli joke

This command fetches and displays a random joke, excluding potentially offensive content.

Notes

• The CLI uses the Python library typer for command-line interface creation.
• Some commands may require additional configuration or environment variables to be set.
• When using the -r option for rerunning analysis, make sure to also specify the node name using -n.

For more detailed information about each command, use the --help option with any command or subcommand.

This site is open source. Improve this page.