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. A valid license is required to install the True-Q™ software package. For sales inquiries, please visit https://www.keysight.com/us/en/contact.html.

Installation

Note

In the steps below, please replace USERNAME and PASSWORD with your credentials that were given to you along with your license.

True-Q™ can be installed using the following command.

pip install trueq --extra-index-url https://USERNAME:PASSWORD@artifactoryext01.keysight.com/artifactory/api/pypi/pypi-remote-qes-cos/simple

Floating Licenses

If you received a floating license and you did not set up a floating license server yet, you must do so before proceeding onto the next step. The instructions can be found on this page. Otherwise, follow the instructions in one of the two sections below, depending on whether you want to manage your license using a CLI or a GUI.

Licensing via CLI

To manage your license using a CLI, you need to install Python License Manager using the following command. Note that you will need to execute plm-cli commands with admin/root privileges.

pip install keysight-plm --extra-index-url https://USERNAME:PASSWORD@artifactoryext01.keysight.com/artifactory/api/pypi/pypi-remote-qes-cos/simple

If you received a floating license, install the product configuration file and specify a remote license server. Here, PORT is the port and HOSTNAME is the address of your floating license server.

plm-cli config install quantum
plm-cli remote append quantum PORT@HOSTNAME

If you received a node-locked license, you can install it using the following command, where LICENSE is the path to your license file.

plm-cli local install LICENSE

Licensing via GUI

To manage your license using a GUI, you need to install PathWave License Manager by following these steps.

If you received a floating license, install the product configuration file using the following command. Note that you will need to execute it with admin/root privileges.

trueq-install-plm-config

Finally, open PathWave License Manager and specify a Remote License Server for the “QCS” or “QUANTUM” product if you received a floating license, or add your node-locked license otherwise. You should now be able to import True-Q™ successfully.

Note

After the installation, when you import True-Q™ for the first time, you will be asked to agree to Keysight’s Software End User License Agreement (EULA), which requires you to type agree when prompted. Then, the Privacy Notice will also be displayed for you once.

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: Big Sur (11.0) or newer

  • Windows: Microsoft Visual C++ 2015-2019 Redistributable (x64) >= 14.29.30139 (download 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 using the following command.

pip install 'trueq[interface]' --extra-index-url https://USERNAME:PASSWORD@artifactoryext01.keysight.com/artifactory/api/pypi/pypi-remote-qes-cos/simple

Updates

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

pip install -U trueq --extra-index-url https://USERNAME:PASSWORD@artifactoryext01.keysight.com/artifactory/api/pypi/pypi-remote-qes-cos/simple

Versions

You can install older versions of True-Q™ using the following command, replacing x.y.z with your desired version. Please ensure that you’ve uninstalled any existing True-Q™ packages before proceeding.

pip install trueq==x.y.z --extra-index-url https://USERNAME:PASSWORD@artifactoryext01.keysight.com/artifactory/api/pypi/pypi-remote-qes-cos/simple

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 command.

trueq-docs

Support

If you require assistance with True-Q™, please visit https://support.keysight.com.