README.rst

dwave-system

dwave-system is a basic API for easily incorporating the D-Wave system as a sampler in the D-Wave Ocean software stack, directly or through 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.

Installation

Installation from PyPI:

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:

from dwave.drivers import __license__
print(__license__)

To install with optional dependencies:

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

Installation from source:

pip install -r requirements.txt
python setup.py install

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

pip uninstall dwave-drivers

License

Released under the Apache License 2.0. See LICENSE file.

Contributing

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