Readme

True-Q™ provides methods to calibrate and optimize the performance of quantum devices. This includes diagnostic tools, which generate quantum circuits that measure noise properties of your device, and runtime solutions, which tailor and reduce noise profiles.

Installation

The simplest way to install True-Q™ is from the remote URL:

pip install --no-cache-dir "https://app.quantumbenchmark.com/download_trueq"

Note that pip usually caches remote packages. The --no-cache-dir flag is used to disable this behavior and force pip to download the latest version from the remote URL. When prompted for username and password, you can use the username and token found inside qb-token.json.

You can skip the username and password prompt by including them inside the pip command:

pip install --no-cache-dir "https://username:password@app.quantumbenchmark.com/download_trueq"

Replace username and password with your username and password. This command is useful if you wish to automate pip installation or when you encounter bugs that prevent you from entering the password during the prompt, such as when using Git Bash on Windows. You can use this trick for all pip install commands found below.

Note

During the installation, you will be asked to agree to Keysight’s Software End User License Agreement, which requires you to type agree when prompted.

Requirements

To use True-Q™, you must have a 64-bit version of Python 3.7 or above, and you need to meet the following OS-specific requirements:

Linux: libstdc++ >= 9.3.0
MacOS: Catalina (10.15) or newer
Windows: Microsoft Visual C++ 2015-2019 Redistributable (x64) >= 14.29.30037 (link)

Note

If you want to run True-Q™ on hardware with an Apple M1 SoC, please install a version of Python built for Intel CPUs and run it through the Rosetta translation layer.

Interfaces

True-Q™ is capable of interfacing with other Python quantum computing packages, such as Cirq, pyQuil, and Qiskit, out of the box. This functionality is optional and becomes available automatically whenever any of these packages are installed on your machine.

You can install True-Q™ along with all supported quantum computing packages via:

pip install --no-cache-dir "trueq[interface] @ https://app.quantumbenchmark.com/download_trueq"

Updates

You can update True-Q™ using the following command:

pip install -U --no-cache-dir "https://app.quantumbenchmark.com/download_trueq"

Versions

You can install older versions of True-Q™ using the following command, replacing x.y.z with your desired version:

pip install -U setuptools setuptools_scm wheel
pip install --no-cache-dir "https://app.quantumbenchmark.com/download_trueq?version=x.y.z"

Ensure that you’ve uninstalled any existing True-Q™ installations before using this command.

Citation

If you wish to cite True-Q™ in your publication, you can visit this page to download a citation in a format of your choice.

Documentation

You can view True-Q™ documentation and examples online at https://trueq.quantumbenchmark.com. You can also view them locally using the following Python command:

import trueq
trueq.docs()

Testing

If you want to run True-Q™ tests, you will first need to install it in editable mode, which requires downloading True-Q™ before calling pip with the required testing dependencies:

wget -O trueq.zip https://username:password@app.quantumbenchmark.com/download_trueq
unzip trueq.zip -d trueq && rm trueq.zip && cd trueq
pip install -e .[interface,tests]

Replace username and password with your username and password. To run the actual tests, you can use the following command:

pytest

Support

If you require assistance with True-Q™, please email qb-support@keysight.com and include as much relevant information as possible (e.g., code snippets, error messages, True-Q™ version, Python version, and operating system).