.. image:: https://img.shields.io/pypi/v/dwave-system.svg :target: https://pypi.org/project/dwave-system
.. image:: https://img.shields.io/pypi/pyversions/dwave-system.svg?style=flat :target: https://pypi.org/project/dwave-system :alt: PyPI - Python Version
.. image:: https://codecov.io/gh/dwavesystems/dwave-system/branch/master/graph/badge.svg :target: https://codecov.io/gh/dwavesystems/dwave-system
.. image:: https://circleci.com/gh/dwavesystems/dwave-system.svg?style=shield :target: https://circleci.com/gh/dwavesystems/dwave-system
.. index-start-marker
dwave-system is a basic API for easily incorporating the D-Wave system as a
sampler in the
D-Wave Ocean software stack <https://docs.ocean.dwavesys.com/en/stable/overview/stack.html>,
directly or through Leap <https://cloud.dwavesys.com/leap/>\ 's cloud-based
hybrid solvers. It includes DWaveSampler, a dimod sampler that accepts and
passes system parameters such as system identification and authentication down
the stack, LeapHybridSampler, for Leap's hybrid solvers, and other. It also
includes several useful composites---layers of pre- and post-processing---that
can be used with DWaveSampler to handle minor-embedding,
optimize chain strength, etc.
.. index-end-marker
.. installation-start-marker
Installation from PyPI:
.. code-block:: bash
pip install dwave-system.. note::
As of dwave-system 1.28.0, support for dwave-drivers is removed (it
was used for calibration of qubits in chains via VirtualGraphComposite,
but it's no longer required due to improved calibration of newer QPUs).
Installation from source:
.. code-block:: bash
pip install -r requirements.txt
python setup.py install.. installation-end-marker
Released under the Apache License 2.0. See LICENSE file.
Ocean's contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>_
has guidelines for contributing to Ocean packages.