dwave-system 0.5.0

All things D-Wave System.

.. image:: https://img.shields.io/pypi/v/dwave-system.svg
:target: https://pypi.python.org/pypi/dwave-system

.. image:: https://ci.appveyor.com/api/projects/status/959r6vpyertcxkhd?svg=true
:target: https://ci.appveyor.com/project/dwave-adtt/dwave-system

.. image:: https://codecov.io/gh/dwavesystems/dwave-system/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dwavesystems/dwave-system

.. image:: https://readthedocs.org/projects/dwave-system/badge/?version=latest
:target: http://dwave-system.readthedocs.io/en/latest/?badge=latest

.. image:: https://circleci.com/gh/dwavesystems/dwave-system.svg?style=svg
:target: https://circleci.com/gh/dwavesystems/dwave-system

.. index-start-marker

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

`dwave-system` is a basic API for easily incorporating the D-Wave system as a sampler in
the `D-Wave Ocean <http://dw-docs.readthedocs.io/en/latest/overview/stack.html#stack>`_ software
stack. It includes DWaveSampler, a :class:`dimod.Sampler`
that accepts and passes system parameters such as system identification and authentication
down the stack. 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
------------

.. installation-start-marker

**Installation from PyPI:**

.. code-block:: bash

pip install dwave-system

**Installation from PyPI with drivers:**

.. note::
Prior to v0.3.0, running ``pip install dwave-system`` installed a driver dependency called ``dwave-drivers``
(previously also called ``dwave-system-tuning``). This dependency has a restricted license and has been made optional
as of v0.3.0, but is highly recommended. To view the license details:

.. code-block:: python

from dwave.drivers import __license__
print(__license__)

To install with optional dependencies:

.. code-block:: bash

pip install dwave-system[drivers] --extra-index-url https://pypi.dwavesys.com/simple

**Installation from source:**

.. code-block:: bash

pip install -r requirements.txt
python setup.py

Note that installing from source installs ``dwave-drivers``. To uninstall the proprietary components:

.. code-block:: bash

pip uninstall dwave-drivers

.. installation-end-marker


License
-------

Released under the Apache License 2.0. See LICENSE file.

Contribution
------------

See CONTRIBUTING.rst file.