:target: https://pypi.org/project/dwave-graphs
.. image:: https://codecov.io/gh/dwavesystems/dwave-graphs/branch/main/graph/badge.svg :target: https://codecov.io/gh/dwavesystems/dwave-graphs
.. image:: https://circleci.com/gh/dwavesystems/dwave-graphs.svg?style=svg :target: https://circleci.com/gh/dwavesystems/dwave-graphs
============ dwave-graphs
.. start_graphs_about
dwave-graphs provides tools for
working with quantum processing unit (QPU) topology graphs, such as the Pegasus
used on the Advantage\ :sup:TM quantum computer, and implementations of
graph-theory algorithms on D-Wave quantum computers and other binary quadratic
model (BQM) samplers.
This example generates a Pegasus graph of the size used by Advantage QPUs.
import dwave.graphs graph = dwave.graphs.pegasus_graph(16)
.. end_graphs_about
Installation
Installation from PyPI:
.. code-block:: bash
pip install dwave-graphs
Installation from source:
.. code-block:: bash
pip install .
Development setup
Install development requirements and the package in editable mode:
.. code-block:: bash
pip install --group dev
pip install --editable .
Tests require the test dependency group:
.. code-block:: bash
pip install --group test
python -m unittest
License
Released under the Apache License 2.0. See LICENSE file.
Contributing
Ocean's contributing guide <https://docs.dwavequantum.com/en/latest/ocean/contribute.html>_
has guidelines for contributing to Ocean packages.
Release Notes
We use reno <https://docs.openstack.org/reno/>_ to manage release notes.
See reno's user guide <https://docs.openstack.org/reno/latest/user/usage.html>_
for details.