.. 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 <https://docs.dwavequantum.com/en/latest/ocean/>`_ is
`D-Wave's <https://www.dwavequantum.com/>`_ suite of tools for solving hard
problems with quantum computers.
.. index-end-marker
Installation
============
.. installation-start-marker
Installation from `PyPI <https://pypi.org/project/dwave-ocean-sdk/>`_:
.. code-block:: bash
pip install dwave-ocean-sdk
For more information, see the Ocean documentation's
`installation <https://docs.dwavequantum.com/en/latest/ocean/install.html>`_
page.
.. installation-end-marker
Getting Started
===============
Sign up for the Leap quantum cloud service here:
`Leap signup <https://cloud.dwavesys.com/leap/signup>`_.
Start learning with the following D-Wave resources:
* `D-Wave Documentation <https://docs.dwavequantum.com/en/latest/index.html>`_
to learn about quantum computers and how to use them.
* `Get Started with Ocean Software <https://docs.dwavequantum.com/en/latest/ocean/index_get_started.html>`_
to install and start coding with Ocean software.
* `dwave-examples <https://github.com/dwave-examples>`_ for code examples
and Jupyter Notebooks.
* `Resource Library <https://www.dwavequantum.com/learn/resource-library>`_ on
D-Wave website for whitepapers and additional resources.
Example Quantum Program
-----------------------
The following lines of code solve and visualize a
`random <https://docs.dwavequantum.com/en/latest/ocean/api_ref_dimod/generators.html#random>`_
`problem <https://docs.dwavequantum.com/en/latest/concepts/models.html#binary-quadratic-models>`_
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 <https://docs.dwavequantum.com/en/latest/quantum_research/embedding_guidance.html>`_
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 <https://docs.dwavequantum.com/en/latest/quantum_research/index_examples_beginner.html>`_
and `dwave-examples <https://github.com/dwave-examples>`_ GitHub repository, and
many customer prototype applications on the
`D-Wave website <https://www.dwavequantum.com/learn/featured-applications/>`_.
Support
=======
Find support here:
* `Leap user community <https://support.dwavesys.com/hc/en-us/community/topics>`_
to converse with a large community of D-Wave users.
* `Leap help center <https://support.dwavesys.com/hc/en-us>`_
to search the Leap knowledge base.
* `SDK GitHub repo <https://github.com/dwavesystems/dwave-ocean-sdk/issues>`_
to open issues or request features on the Ocean SDK or on any one of its
`packages <https://github.com/dwavesystems>`_.
Contributing
============
Your contributions are welcome!
Ocean's
`contributing guide <https://docs.dwavequantum.com/en/latest/ocean/contribute.html>`_
has guidelines for contributing to Ocean packages.
License
=======
Released under the Apache License 2.0. See LICENSE file.
Raw data
{
"_id": null,
"home_page": "https://github.com/dwavesystems/dwave-ocean-sdk",
"name": "dwave-ocean-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "D-Wave",
"author_email": "tools@dwavesys.com",
"download_url": "https://files.pythonhosted.org/packages/74/70/e8f2ba21c67e01f0961f9505fe8cf5e968214abe1ea24703b80e329ade77/dwave_ocean_sdk-9.0.0.tar.gz",
"platform": null,
"description": ".. image:: docs/_static/Ocean_SDK_Banner.png\n\n.. image:: https://img.shields.io/pypi/v/dwave-ocean-sdk.svg\n :target: https://pypi.python.org/pypi/dwave-ocean-sdk\n\n.. image:: https://img.shields.io/pypi/pyversions/dwave-ocean-sdk.svg\n :target: https://pypi.python.org/pypi/dwave-ocean-sdk\n\n.. image:: https://readthedocs.com/projects/d-wave-systems-dwave-ocean-sdk/badge\n :target: https://docs.ocean.dwavesys.com\n\n.. image:: https://circleci.com/gh/dwavesystems/dwave-ocean-sdk.svg?style=svg\n :target: https://circleci.com/gh/dwavesystems/dwave-ocean-sdk\n\n.. index-start-marker\n\n`Ocean SDK <https://docs.dwavequantum.com/en/latest/ocean/>`_ is\n`D-Wave's <https://www.dwavequantum.com/>`_ suite of tools for solving hard\nproblems with quantum computers.\n\n.. index-end-marker\n\nInstallation\n============\n\n.. installation-start-marker\n\nInstallation from `PyPI <https://pypi.org/project/dwave-ocean-sdk/>`_:\n\n.. code-block:: bash\n\n pip install dwave-ocean-sdk\n\nFor more information, see the Ocean documentation's\n`installation <https://docs.dwavequantum.com/en/latest/ocean/install.html>`_\npage.\n\n.. installation-end-marker\n\nGetting Started\n===============\n\nSign up for the Leap quantum cloud service here:\n`Leap signup <https://cloud.dwavesys.com/leap/signup>`_. \n\nStart learning with the following D-Wave resources:\n\n* `D-Wave Documentation <https://docs.dwavequantum.com/en/latest/index.html>`_\n to learn about quantum computers and how to use them.\n\n* `Get Started with Ocean Software <https://docs.dwavequantum.com/en/latest/ocean/index_get_started.html>`_\n to install and start coding with Ocean software.\n\n* `dwave-examples <https://github.com/dwave-examples>`_ for code examples\n and Jupyter Notebooks.\n\n* `Resource Library <https://www.dwavequantum.com/learn/resource-library>`_ on\n D-Wave website for whitepapers and additional resources.\n\nExample Quantum Program\n-----------------------\n\nThe following lines of code solve and visualize a\n`random <https://docs.dwavequantum.com/en/latest/ocean/api_ref_dimod/generators.html#random>`_\n`problem <https://docs.dwavequantum.com/en/latest/concepts/models.html#binary-quadratic-models>`_\non a quantum computer.\n\n.. code-block:: python\n\n import dimod\n import dwave.inspector\n import dwave.system\n\n bqm = dimod.generators.ran_r(1, 20)\n sampler = dwave.system.EmbeddingComposite(dwave.system.DWaveSampler())\n sampleset = sampler.sample(bqm, num_reads=100)\n dwave.inspector.show(sampleset)\n\nThe left side of the\n`visualized <https://docs.dwavequantum.com/en/latest/quantum_research/embedding_guidance.html>`_\nsolution represents the problem's variables as circles, with white dots for\nvariables assigned values of -1 and blue dots for values of +1; the colors of the\nconnecting lines represent values of the quadratic coefficients for each pair of\nvariables. The right side shows the qubits representing these variables on a\nquantum processing unit.\n\n.. image:: docs/_static/inspector_bqm_ran_r_20.png\n\nYou can find introductory examples in the\n`documentation <https://docs.dwavequantum.com/en/latest/quantum_research/index_examples_beginner.html>`_\nand `dwave-examples <https://github.com/dwave-examples>`_ GitHub repository, and\nmany customer prototype applications on the\n`D-Wave website <https://www.dwavequantum.com/learn/featured-applications/>`_.\n\nSupport\n=======\n\nFind support here:\n\n* `Leap user community <https://support.dwavesys.com/hc/en-us/community/topics>`_\n to converse with a large community of D-Wave users.\n* `Leap help center <https://support.dwavesys.com/hc/en-us>`_\n to search the Leap knowledge base.\n* `SDK GitHub repo <https://github.com/dwavesystems/dwave-ocean-sdk/issues>`_\n to open issues or request features on the Ocean SDK or on any one of its\n `packages <https://github.com/dwavesystems>`_.\n\nContributing\n============\n\nYour contributions are welcome!\n\nOcean's\n`contributing guide <https://docs.dwavequantum.com/en/latest/ocean/contribute.html>`_\nhas guidelines for contributing to Ocean packages.\n\nLicense\n=======\n\nReleased under the Apache License 2.0. See LICENSE file.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "Software development kit for open source D-Wave tools",
"version": "9.0.0",
"project_urls": {
"Changes": "https://github.com/dwavesystems/dwave-ocean-sdk/releases",
"Documentation": "https://docs.dwavequantum.com/",
"Homepage": "https://github.com/dwavesystems/dwave-ocean-sdk",
"Source Code": "https://github.com/dwavesystems/dwave-ocean-sdk"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "05801ee55cc7d4b20760d3abe6418ec4d78e18f0dcfe41814e934c1470078517",
"md5": "d94ea14405f2908b60661aeded5b659c",
"sha256": "255e94ba518c7b6e66bfb2ec10495dca26c70b33919e9a55b45fe27e607965fb"
},
"downloads": -1,
"filename": "dwave_ocean_sdk-9.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d94ea14405f2908b60661aeded5b659c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8413,
"upload_time": "2025-09-10T21:18:13",
"upload_time_iso_8601": "2025-09-10T21:18:13.541400Z",
"url": "https://files.pythonhosted.org/packages/05/80/1ee55cc7d4b20760d3abe6418ec4d78e18f0dcfe41814e934c1470078517/dwave_ocean_sdk-9.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7470e8f2ba21c67e01f0961f9505fe8cf5e968214abe1ea24703b80e329ade77",
"md5": "50fcc25040e45cec4a8a02c9e4a8d339",
"sha256": "991e9da05dcb7ee83827ed685659ce79ce9d533425d0bcc8a77a1f47ce1e1532"
},
"downloads": -1,
"filename": "dwave_ocean_sdk-9.0.0.tar.gz",
"has_sig": false,
"md5_digest": "50fcc25040e45cec4a8a02c9e4a8d339",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 8585,
"upload_time": "2025-09-10T21:18:14",
"upload_time_iso_8601": "2025-09-10T21:18:14.821167Z",
"url": "https://files.pythonhosted.org/packages/74/70/e8f2ba21c67e01f0961f9505fe8cf5e968214abe1ea24703b80e329ade77/dwave_ocean_sdk-9.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-10 21:18:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dwavesystems",
"github_project": "dwave-ocean-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "dwave-ocean-sdk"
}
JSON
