dwave-ocean-sdk


Namedwave-ocean-sdk JSON
Version 6.9.0 PyPI version JSON
download
home_pagehttps://github.com/dwavesystems/dwave-ocean-sdk
SummarySoftware development kit for open source D-Wave tools
upload_time2024-03-01 18:05:53
maintainer
docs_urlNone
authorD-Wave Systems Inc.
requires_python>=3.8
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. 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://ci.appveyor.com/api/projects/status/c8ofdgyiy4w38lu3?svg=true
    :target: https://ci.appveyor.com/project/dwave-adtt/dwave-ocean-sdk

.. 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 <https://docs.ocean.dwavesys.com/en/stable>`_ is
`D-Wave's <https://www.dwavesys.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.ocean.dwavesys.com/en/stable/overview/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:

* `System Documentation <https://docs.dwavesys.com/docs/latest/index.html>`_ to
  learn about quantum computers and how to use them.

* `Getting Started with Ocean <https://docs.ocean.dwavesys.com/en/stable/getting_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.dwavesys.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.ocean.dwavesys.com/en/stable/docs_dimod/reference/generators.html>`_
`problem <https://docs.ocean.dwavesys.com/en/stable/concepts/bqm.html>`_
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.ocean.dwavesys.com/en/stable/docs_inspector/intro.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
`Ocean documentation <https://docs.ocean.dwavesys.com/en/stable/getting_started.html>`_
and `dwave-examples <https://github.com/dwave-examples>`_ GitHub repository, and
many customer prototype applications on the
`D-Wave website <https://www.dwavesys.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.ocean.dwavesys.com/en/stable/contributing.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": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "D-Wave Systems Inc.",
    "author_email": "tools@dwavesys.com",
    "download_url": "https://files.pythonhosted.org/packages/b4/b6/0ec399387f9a59a6fdbd234392e0f29b7f94bf46761e96f54b098843b89a/dwave-ocean-sdk-6.9.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://ci.appveyor.com/api/projects/status/c8ofdgyiy4w38lu3?svg=true\n    :target: https://ci.appveyor.com/project/dwave-adtt/dwave-ocean-sdk\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 <https://docs.ocean.dwavesys.com/en/stable>`_ is\n`D-Wave's <https://www.dwavesys.com>`_ suite of tools for solving hard problems\nwith 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.ocean.dwavesys.com/en/stable/overview/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* `System Documentation <https://docs.dwavesys.com/docs/latest/index.html>`_ to\n  learn about quantum computers and how to use them.\n\n* `Getting Started with Ocean <https://docs.ocean.dwavesys.com/en/stable/getting_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.dwavesys.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.ocean.dwavesys.com/en/stable/docs_dimod/reference/generators.html>`_\n`problem <https://docs.ocean.dwavesys.com/en/stable/concepts/bqm.html>`_\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.ocean.dwavesys.com/en/stable/docs_inspector/intro.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`Ocean documentation <https://docs.ocean.dwavesys.com/en/stable/getting_started.html>`_\nand `dwave-examples <https://github.com/dwave-examples>`_ GitHub repository, and\nmany customer prototype applications on the\n`D-Wave website <https://www.dwavesys.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>`_ to\n  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 `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.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": "6.9.0",
    "project_urls": {
        "Changes": "https://github.com/dwavesystems/dwave-ocean-sdk/releases",
        "Documentation": "https://docs.ocean.dwavesys.com",
        "Homepage": "https://github.com/dwavesystems/dwave-ocean-sdk",
        "Souce Code": "https://github.com/dwavesystems/dwave-ocean-sdk"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "776146baeb36876c0de54eeb1a586926449f38b89cbbd9cc29c816cf4adc6ea5",
                "md5": "a97eb1a24cdca2f66fa67ca604da39f3",
                "sha256": "ab82ef510ff2d72e346b7b6e6d566b576114d8a6178bd76bb894912f3eeac508"
            },
            "downloads": -1,
            "filename": "dwave_ocean_sdk-6.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a97eb1a24cdca2f66fa67ca604da39f3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8410,
            "upload_time": "2024-03-01T18:05:51",
            "upload_time_iso_8601": "2024-03-01T18:05:51.399245Z",
            "url": "https://files.pythonhosted.org/packages/77/61/46baeb36876c0de54eeb1a586926449f38b89cbbd9cc29c816cf4adc6ea5/dwave_ocean_sdk-6.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b4b60ec399387f9a59a6fdbd234392e0f29b7f94bf46761e96f54b098843b89a",
                "md5": "60d99f49c4af2587d42135276094584c",
                "sha256": "ccb82b5bf9bfbaaef655f9d554e21381530fef3290b3941ae87150eb97ab8017"
            },
            "downloads": -1,
            "filename": "dwave-ocean-sdk-6.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "60d99f49c4af2587d42135276094584c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8730,
            "upload_time": "2024-03-01T18:05:53",
            "upload_time_iso_8601": "2024-03-01T18:05:53.458242Z",
            "url": "https://files.pythonhosted.org/packages/b4/b6/0ec399387f9a59a6fdbd234392e0f29b7f94bf46761e96f54b098843b89a/dwave-ocean-sdk-6.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-01 18:05:53",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dwavesystems",
    "github_project": "dwave-ocean-sdk",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "appveyor": true,
    "circle": true,
    "lcname": "dwave-ocean-sdk"
}
        
Elapsed time: 0.20649s