dwave-system


Namedwave-system JSON
Version 1.24.0 PyPI version JSON
download
home_pagehttps://github.com/dwavesystems/dwave-system
SummaryAll things D-Wave System.
upload_time2024-04-17 17:19:11
maintainerNone
docs_urlNone
authorD-Wave Systems Inc.
requires_python>=3.8
licenseApache 2.0
keywords
VCS
bugtrack_url
requirements dimod dwave-preprocessing dwave-cloud-client dwave-networkx dwave-drivers dwave-samplers homebase minorminer networkx numpy oldest-supported-numpy scipy scipy
Travis-CI No Travis.
coveralls test coverage
            .. image:: https://img.shields.io/pypi/v/dwave-system.svg
   :target: https://pypi.org/project/dwave-system

.. image:: https://img.shields.io/pypi/pyversions/dwave-system.svg?style=flat
    :target: https://pypi.org/project/dwave-system
    :alt: PyPI - Python Version

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

.. image:: https://circleci.com/gh/dwavesystems/dwave-system.svg?style=shield
   :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 software stack <https://docs.ocean.dwavesys.com/en/stable/overview/stack.html>`_,
directly or through `Leap <https://cloud.dwavesys.com/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.

.. 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 install

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.

Contributing
============

Ocean's `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_
has guidelines for contributing to Ocean packages.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dwavesystems/dwave-system",
    "name": "dwave-system",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": null,
    "author": "D-Wave Systems Inc.",
    "author_email": "tools@dwavesys.com",
    "download_url": "https://files.pythonhosted.org/packages/76/e4/794e75d607b5f691e1c262ef145f57da33a52bd11bad87ffca6486c1596c/dwave-system-1.24.0.tar.gz",
    "platform": null,
    "description": ".. image:: https://img.shields.io/pypi/v/dwave-system.svg\n   :target: https://pypi.org/project/dwave-system\n\n.. image:: https://img.shields.io/pypi/pyversions/dwave-system.svg?style=flat\n    :target: https://pypi.org/project/dwave-system\n    :alt: PyPI - Python Version\n\n.. image:: https://codecov.io/gh/dwavesystems/dwave-system/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/dwavesystems/dwave-system\n\n.. image:: https://circleci.com/gh/dwavesystems/dwave-system.svg?style=shield\n   :target: https://circleci.com/gh/dwavesystems/dwave-system\n\n.. index-start-marker\n\ndwave-system\n============\n\n`dwave-system` is a basic API for easily incorporating the D-Wave system as a\nsampler in the\n`D-Wave Ocean software stack <https://docs.ocean.dwavesys.com/en/stable/overview/stack.html>`_,\ndirectly or through `Leap <https://cloud.dwavesys.com/leap/>`_\\ 's cloud-based\nhybrid solvers. It includes ``DWaveSampler``, a dimod sampler that accepts and\npasses system parameters such as system identification and authentication down\nthe stack, ``LeapHybridSampler``, for Leap's hybrid solvers, and other. It also\nincludes several useful composites---layers of pre- and post-processing---that\ncan be used with ``DWaveSampler`` to handle minor-embedding,\noptimize chain strength, etc.\n\n.. index-end-marker\n\nInstallation\n------------\n\n.. installation-start-marker\n\n**Installation from PyPI:**\n\n.. code-block:: bash\n\n    pip install dwave-system\n\n**Installation from PyPI with drivers:**\n\n.. note::\n    Prior to v0.3.0, running ``pip install dwave-system`` installed a driver dependency called ``dwave-drivers``\n    (previously also called ``dwave-system-tuning``). This dependency has a restricted license and has been made optional\n    as of v0.3.0, but is highly recommended. To view the license details:\n\n    .. code-block:: python\n\n        from dwave.drivers import __license__\n        print(__license__)\n\nTo install with optional dependencies:\n\n.. code-block:: bash\n\n    pip install dwave-system[drivers] --extra-index-url https://pypi.dwavesys.com/simple\n\n**Installation from source:**\n\n.. code-block:: bash\n\n    pip install -r requirements.txt\n    python setup.py install\n\nNote that installing from source installs ``dwave-drivers``. To uninstall the proprietary components:\n\n.. code-block:: bash\n\n    pip uninstall dwave-drivers\n\n.. installation-end-marker\n\n\nLicense\n-------\n\nReleased under the Apache License 2.0. See LICENSE file.\n\nContributing\n============\n\nOcean's `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_\nhas guidelines for contributing to Ocean packages.\n",
    "bugtrack_url": null,
    "license": "Apache 2.0",
    "summary": "All things D-Wave System.",
    "version": "1.24.0",
    "project_urls": {
        "Homepage": "https://github.com/dwavesystems/dwave-system"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bdb71014f8e82d6eeb2d070aab3bd96814874e3efb218b0da6366c39760ab9f0",
                "md5": "aaf8d22febbf614ef6d48e0d4021623f",
                "sha256": "6d526150071d7ff1ec67a0e028afc5412478e67196cc48fcdbff6c477e552b5f"
            },
            "downloads": -1,
            "filename": "dwave_system-1.24.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aaf8d22febbf614ef6d48e0d4021623f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 105296,
            "upload_time": "2024-04-17T17:19:10",
            "upload_time_iso_8601": "2024-04-17T17:19:10.073757Z",
            "url": "https://files.pythonhosted.org/packages/bd/b7/1014f8e82d6eeb2d070aab3bd96814874e3efb218b0da6366c39760ab9f0/dwave_system-1.24.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "76e4794e75d607b5f691e1c262ef145f57da33a52bd11bad87ffca6486c1596c",
                "md5": "88d45fb9d74cab0e679dbeab2e50d2f9",
                "sha256": "705e71773e0535570fc29499341e881090bd7630e0d2cf8e75f18ba8f5154d4a"
            },
            "downloads": -1,
            "filename": "dwave-system-1.24.0.tar.gz",
            "has_sig": false,
            "md5_digest": "88d45fb9d74cab0e679dbeab2e50d2f9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 108808,
            "upload_time": "2024-04-17T17:19:11",
            "upload_time_iso_8601": "2024-04-17T17:19:11.618986Z",
            "url": "https://files.pythonhosted.org/packages/76/e4/794e75d607b5f691e1c262ef145f57da33a52bd11bad87ffca6486c1596c/dwave-system-1.24.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-17 17:19:11",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dwavesystems",
    "github_project": "dwave-system",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": false,
    "circle": true,
    "requirements": [
        {
            "name": "dimod",
            "specs": [
                [
                    "==",
                    "0.12.13"
                ]
            ]
        },
        {
            "name": "dwave-preprocessing",
            "specs": [
                [
                    "==",
                    "0.6.4"
                ]
            ]
        },
        {
            "name": "dwave-cloud-client",
            "specs": [
                [
                    "==",
                    "0.11.4"
                ]
            ]
        },
        {
            "name": "dwave-networkx",
            "specs": [
                [
                    "==",
                    "0.8.10"
                ]
            ]
        },
        {
            "name": "dwave-drivers",
            "specs": [
                [
                    "==",
                    "0.4.4"
                ]
            ]
        },
        {
            "name": "dwave-samplers",
            "specs": [
                [
                    "==",
                    "1.2.0"
                ]
            ]
        },
        {
            "name": "homebase",
            "specs": [
                [
                    "==",
                    "1.0.1"
                ]
            ]
        },
        {
            "name": "minorminer",
            "specs": [
                [
                    "==",
                    "0.2.13"
                ]
            ]
        },
        {
            "name": "networkx",
            "specs": [
                [
                    "==",
                    "2.8.8"
                ]
            ]
        },
        {
            "name": "numpy",
            "specs": [
                [
                    "==",
                    "1.21.6"
                ]
            ]
        },
        {
            "name": "oldest-supported-numpy",
            "specs": []
        },
        {
            "name": "scipy",
            "specs": [
                [
                    "==",
                    "1.7.3"
                ]
            ]
        },
        {
            "name": "scipy",
            "specs": [
                [
                    "==",
                    "1.11.2"
                ]
            ]
        }
    ],
    "lcname": "dwave-system"
}
        
Elapsed time: 0.23022s