z-quantum-qaoa

What is it?

z-quantum-qaoa is a module with basic implementation of Quantum Approximate Optimization Algorithm (QAOA) to be used with Orquestra – platform for performing computations on quantum computers developed by Zapata Computing.

Currently it includes the following features:

• Creating ansatz from the Farhi's 2014 paper.
• Creating Hamiltonian for solving MaxCut problem given a graph.
• Solving MaxCut problem using exhaustive search.

Usage

Workflow

In order to use z-quantum-qaoa in your workflow, you need to add it as an import in your Orquestra workflow:

imports:
- name: z-quantum-qaoa
  type: git
  parameters:
    repository: "[email protected]:zapatacomputing/z-quantum-qaoa.git"
    branch: "main"

and then add it in the imports argument of your step:

- name: my-step
  config:
    runtime:
      language: python3
      imports: [z-quantum-qaoa]

Once that is done you can:

• use any z-quantum-qaoa function by specifying its name and path as follows:

- name: get-maxcut-hamiltonian
  config:
    runtime:
      language: python3
      imports: [z-quantum-qaoa]
      parameters:
        file: z-quantum-qaoa/steps/qaoa.py
        function: get_maxcut_hamiltonian

• use tasks which import zquantum.qaoa in the python code (see below).

Python

Here's an example how to do use methods from z-quantum-qaoa in a python task:

from zquantum.qaoa.ansatz import build_farhi_qaoa_circuit_template
from zquantum.core.openfermion import load_qubit_operator
hamiltonian = load_qubit_operator('hamiltonian.json')
ansatz = build_farhi_qaoa_circuit_template(hamiltonian)

Even though it's intended to be used with Orquestra, you can also use it as a standalone python module. In order to install it run pip install . from the src directory.

Development and contribution

You can find the development guidelines in the z-quantum-core repository.

Running tests

In order to run tests please run pytest . from the main directory.