https://github.com/dwavesystems/dwave-ocean-sdk

Installer for D-Wave's Ocean tools
https://github.com/dwavesystems/dwave-ocean-sdk

quantum-computing

Last synced: 3 days ago
JSON representation

Installer for D-Wave's Ocean tools

• Host: GitHub
• URL: https://github.com/dwavesystems/dwave-ocean-sdk
• Owner: dwavesystems
• License: apache-2.0
• Created: 2017-11-21T19:24:37.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-14T18:33:38.000Z (over 1 year ago)
• Last Synced: 2024-05-15T15:02:30.407Z (over 1 year ago)
• Topics: quantum-computing
• Language: Python
• Homepage: https://docs.ocean.dwavesys.com
• Size: 20.2 MB
• Stars: 381
• Watchers: 39
• Forks: 146
• Open Issues: 28
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• quantum-awesome - https://github.com/dwavesystems/dwave-ocean-sdk
• awesome-quantum-software - Ocean - [D-Wave System](https://www.dwavesys.com/home)'s suite of tools for solving hard problems with quantum computers. (Quantum full-stack libraries)

README

          
.. image:: docs/_static/Ocean_SDK_Banner.png

.. image:: https://img.shields.io/pypi/v/dwave-ocean-sdk.svg

    :target: https://pypi.python.org/pypi/dwave-ocean-sdk

.. image:: https://img.shields.io/pypi/pyversions/dwave-ocean-sdk.svg

    :target: https://pypi.python.org/pypi/dwave-ocean-sdk

.. image:: https://readthedocs.com/projects/d-wave-systems-dwave-ocean-sdk/badge

    :target: https://docs.ocean.dwavesys.com

.. image:: https://circleci.com/gh/dwavesystems/dwave-ocean-sdk.svg?style=svg

    :target: https://circleci.com/gh/dwavesystems/dwave-ocean-sdk

.. index-start-marker

`Ocean SDK `_ is

`D-Wave's `_ suite of tools for solving hard

problems with quantum computers.

.. index-end-marker

Installation

============

.. installation-start-marker

Installation from `PyPI `_:

.. code-block:: bash

    pip install dwave-ocean-sdk

For more information, see the Ocean documentation's

`installation `_

page.

.. installation-end-marker

Getting Started

===============

Sign up for the Leap quantum cloud service here:

`Leap signup `_. 

Start learning with the following D-Wave resources:

*   `D-Wave Documentation `_

    to learn about quantum computers and how to use them.

*   `Get Started with Ocean Software `_

    to install and start coding with Ocean software.

*   `dwave-examples `_ for code examples

    and Jupyter Notebooks.

*   `Resource Library `_ on

    D-Wave website for whitepapers and additional resources.

Example Quantum Program

-----------------------

The following lines of code solve and visualize a

`random `_

`problem `_

on a quantum computer.

.. code-block:: python

    import dimod

    import dwave.inspector

    import dwave.system

    bqm = dimod.generators.ran_r(1, 20)

    sampler = dwave.system.EmbeddingComposite(dwave.system.DWaveSampler())

    sampleset = sampler.sample(bqm, num_reads=100)

    dwave.inspector.show(sampleset)

The left side of the

`visualized `_

solution represents the problem's variables as circles, with white dots for

variables assigned values of -1 and blue dots for values of +1; the colors of the

connecting lines represent values of the quadratic coefficients for each pair of

variables. The right side shows the qubits representing these variables on a

quantum processing unit.

.. image:: docs/_static/inspector_bqm_ran_r_20.png

You can find introductory examples in the

`documentation `_

and `dwave-examples `_ GitHub repository, and

many customer prototype applications on the

`D-Wave website `_.

Support

=======

Find support here:

*   `Leap user community `_

    to converse with a large community of D-Wave users.

*   `Leap help center `_

    to search the Leap knowledge base.

*   `SDK GitHub repo `_

    to open issues or request features on the Ocean SDK or on any one of its

    `packages `_.

Contributing

============

Your contributions are welcome!

Ocean's

`contributing guide `_

has guidelines for contributing to Ocean packages.

License

=======

Released under the Apache License 2.0. See LICENSE file.