dwave-gate 0.1.0

Gate model library.

dwave-gate is a software package for constructing, modifying and running quantum circuits. It provides a set of tools that enables you to:

• Construct quantum circuits using an intuitive context-manager interface.

• Utilize a comprehensive library of quantum gates with simple access to matrix representations, various decompositions, and more.

• Simulate circuits on a performant (C++) state-vector simulator.

• Easily create your own quantum gates and templates. Any circuit can be either directly applied in another circuit or converted into a quantum operation.

Example usage

This example uses the dwave.gate.Circuit object’s context manager to append operations to a two-qubit circuit.

import dwave.gate.operations as ops
from dwave.gate import Circuit

circuit = Circuit(2)

with circuit.context as q:
    ops.Hadamard(q[1])
    ops.CZ(q[0], q[1])
    ops.Hadamard(q[1])

You can run the dwave.gate.simulator simulator on such circuits.

>>> from dwave.gate.simulator import simulate
>>> simulate(circuit)
array([0.+0.j, 0.+0.j, 0.+0.j, 1.+0.j])

Installation

The simplest way to install dwave-gate is from PyPI:

pip install dwave-gate

It can also be installed from source by cloning this GitHub repository and running (on Unix systems):

make install

The makefile will also simplify running tests (make test), coverage (make coverage) and formatting (make format) the code using the Black formatter (set to a line-length of 100) and isort.

Alternatively, the package can be built and installed using Python (on any supported system):

python setup.py build_ext --inplace

and tests and coverage can be run using Pytest:

pytest tests/ --cov=dwave.gate

License

Released under the Apache License 2.0. See LICENSE file.

Contributing

Ocean’s contributing guide has guidelines for contributing to Ocean packages.

Release Notes

dwave-gate uses reno to manage its release notes.

When making a contribution to dwave-gate that will affect users, create a new release note file by running

reno new your-short-descriptor-here

You can then edit the file created under releasenotes/notes/. Remove any sections not relevant to your changes. Commit the file along with your changes.

See reno’s user guide for details.