README.md

Welcome to Qiskit Metriq

This repository contains a collection of scripts designed to execute Qiskit compilation experiments on quantum circuits and upload benchmark results to metriq.info, a community-driven platform for hosting quantum benchmarks.

At its core, Qiskit Metriq tracks essential metrics such as circuit depth and gate count for these experiments, automatically running jobs for every version of Qiskit, streamlining the process of evaluating the performance of quantum circuits compiled with Qiskit.

Archictecture

This project creates a tox environment for each Qiskit version, starting from qiskit-terra v0.13.0 to latest. The Qiskit circuit compilation is batch processed, and the results are automatically submitted to metriq.info.

Benchmark tasks for quantum computer compilers:

• ex1_226.qasm quantum circuit:
  • Metriq Task 25 - Parent task
  • Metriq Task 26 - Child task: specific to Aspen architecture
  • Metriq Task 27 - Child task: specific to IBMQ Rochester architecture

Qiskit compilation results

Circuit depth distribution

Compiled for the Rigetti 16Q Aspen architecture

Compiled for the IBMQ Rochester architecture

Gate count distribution

Compiled for the Rigetti 16Q Aspen architecture

Compiled for the IBMQ Rochester architecture

Requirements

• tox
• Python 3.11+

Run locally

To run a benchmark experiment using the latest version of Qiskit(RCs excluded):

tox -e py311

Note: To run a specific version of Qiskit, you can manually update the tox.ini file with the required version. Versions >=0.13,<=0.15 require numpy<1.20 and python<=3.8. You can run the tox environments terra13, terra14 or terra15 as:

tox -e py38-terra13

Contributing

To contribute to Qiskit Metriq, please refer to our contribution guidelines. By contributing, you are expected to agree and follow Qiskit's code of conduct.

For requests and bug reports, please open an issue with a detailed description.