Metadata-Version: 2.4
Name: dwave-system
Version: 1.33.0rc1
Summary: All things D-Wave System.
Home-page: https://github.com/dwavesystems/dwave-system
Author: D-Wave Systems Inc.
Author-email: tools@dwavesys.com
License: Apache 2.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 3 - Alpha
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.9
License-File: LICENSE
Requires-Dist: dimod<0.14.0,>=0.12.20
Requires-Dist: dwave-optimization<0.8,>=0.1.0
Requires-Dist: dwave-cloud-client<0.15.0,>=0.12.0
Requires-Dist: dwave-networkx>=0.8.10
Requires-Dist: dwave-preprocessing>=0.5.0
Requires-Dist: homebase<2.0.0,>=1.0.0
Requires-Dist: minorminer<0.3.0,>=0.2.19
Requires-Dist: numpy>=1.21.6
Requires-Dist: dwave-samplers>=1.0.0
Requires-Dist: scipy>=1.7.3
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

.. 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


============
dwave-system
============

.. start_system_about

``dwave-system`` is a basic API for easily incorporating the D-Wave system as a
sampler in the
`Ocean software stack <https://docs.dwavequantum.com/en/latest/ocean/stack.html>`_,
directly or through `Leap <https://cloud.dwavesys.com/leap/>`_ service'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 others. 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.

.. end_system_about

Installation
============

**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

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
-------------

``dwave-system`` makes use of `reno <https://docs.openstack.org/reno/>`_ to manage
its release notes.

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

.. code-block:: bash

    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 <https://docs.openstack.org/reno/latest/user/usage.html>`_
for details.
