.. 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/7f/51/512155a76179b1b8394b583600192fa41735d6ab9b5f91c998b1aa732e98/dwave_system-1.27.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.27.0",
"project_urls": {
"Homepage": "https://github.com/dwavesystems/dwave-system"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "030c742abd7aec8eab3488a9799c7304e75d3fe928d4b26664538dabe7bb1ab8",
"md5": "f5213398c8b60b44d751624237ddaf4c",
"sha256": "74bf5552ae56f52067e93b5dabb8ab10a0f86efccb3634e777234553c53b7fd7"
},
"downloads": -1,
"filename": "dwave_system-1.27.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f5213398c8b60b44d751624237ddaf4c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 107021,
"upload_time": "2024-10-07T20:15:10",
"upload_time_iso_8601": "2024-10-07T20:15:10.099353Z",
"url": "https://files.pythonhosted.org/packages/03/0c/742abd7aec8eab3488a9799c7304e75d3fe928d4b26664538dabe7bb1ab8/dwave_system-1.27.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7f51512155a76179b1b8394b583600192fa41735d6ab9b5f91c998b1aa732e98",
"md5": "81227741bb37aa22cc7b70cd590acd0d",
"sha256": "34e85833a709004d4298bd300fd6b830dce14c788fbb14e6db72d9ab82a16225"
},
"downloads": -1,
"filename": "dwave_system-1.27.0.tar.gz",
"has_sig": false,
"md5_digest": "81227741bb37aa22cc7b70cd590acd0d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 111737,
"upload_time": "2024-10-07T20:15:11",
"upload_time_iso_8601": "2024-10-07T20:15:11.854316Z",
"url": "https://files.pythonhosted.org/packages/7f/51/512155a76179b1b8394b583600192fa41735d6ab9b5f91c998b1aa732e98/dwave_system-1.27.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 20:15: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": [],
"lcname": "dwave-system"
}
JSON
