Skip to content

iqm-finland/cirq-on-iqm

Repository files navigation

CI badge Release badge Black badge

Cirq on IQM

Google Cirq adapter for IQM's quantum architectures.

What is it good for?

Currently Cirq on IQM can

  • take an arbitrary quantum circuit created using Cirq or imported from an OpenQASM 2.0 file
  • map the circuit into an equivalent one compatible with the chosen IQM quantum architecture
  • optimize the circuit by commuting and merging gates
  • simulate the circuit using one of Cirq's simulators
  • run the circuit on an IQM quantum computer

Installation

The recommended way is to install the distribution package cirq-iqm directly from the Python Package Index (PyPI):

$ pip install cirq-iqm

Documentation

The documentation of the latest Cirq on IQM release is available here.

Jump to our User guide for a quick introduction on how to use Cirq on IQM.

Take a look at the Jupyter notebook with examples: examples/usage.ipynb.

You can build documentation for any older version locally by cloning the Git repository, checking out the corresponding tag, and running the docs builder. For example, to build the documentation for version 12.2:

$ git clone git@github.com:iqm-finland/cirq-on-iqm.git
$ cd cirq-on-iqm
$ git checkout 12.2
$ tox run -e docs

tox run -e docs will build the documentation at ./build/sphinx/html. This command requires the tox,, sphinx and sphinx-book-theme Python packages (see the docs optional dependency in pyproject.toml); you can install the necessary packages with pip install -e ".[dev,docs]"

Cirq on IQM is free software, released under the Apache License, version 2.0.

Copyright 2020–2024 Cirq on IQM developers.