.. image:: https://badge.fury.io/py/dwave-inspector.svg
:target: https://badge.fury.io/py/dwave-inspector
:alt: Latest version on PyPI
.. image:: https://circleci.com/gh/dwavesystems/dwave-inspector.svg?style=shield
:target: https://circleci.com/gh/dwavesystems/dwave-inspector
:alt: Linux/MacOS build status
.. image:: https://codecov.io/gh/dwavesystems/dwave-inspector/branch/master/graph/badge.svg
:target: https://codecov.io/gh/dwavesystems/dwave-inspector
:alt: Coverage report
================
D-Wave Inspector
================
.. index-start-marker
A tool for visualizing problems submitted to, and answers received from, a
D-Wave structured solver such as an Advantage\ |TM| quantum computer.
.. |TM| replace:: :sup:`TM`
.. index-end-marker
Example
=======
.. example-start-marker
This example shows a typical usage: a binary quadratic model minor-embedded
onto a quantum processing unit (QPU).
.. code-block:: python
from dwave.system import DWaveSampler, EmbeddingComposite
import dimod
import dwave.inspector
# Get sampler
sampler = EmbeddingComposite(DWaveSampler())
# Define a problem
x, y, z = dimod.Binaries(['x', 'y', 'z'])
bqm = x*y - x*z + 2*y
# Sample
sampleset = sampler.sample(bqm, num_reads=100)
# Inspect
dwave.inspector.show(sampleset)
.. example-end-marker
Installation or Building
========================
.. installation-start-marker
If `D-Wave Ocean SDK 2.0+ <https://docs.ocean.dwavesys.com/>`_ is installed:
.. code-block:: bash
dwave install inspector
Otherwise, install the package from PyPI:
.. code-block:: bash
pip install dwave-inspector
and then install the closed-source dependency with:
.. code-block:: bash
pip install dwave-inspectorapp --extra-index=https://pypi.dwavesys.com/simple
Please note this closed-source dependency is released under the `D-Wave EULA`_ license.
Alternatively, clone and build from source:
.. code-block:: bash
git clone https://github.com/dwavesystems/dwave-inspector.git
cd dwave-inspector
pip install -r requirements.txt
python setup.py install
When building from source, the closed-source component still needs to be
installed as above.
.. installation-end-marker
License
=======
Released under the Apache License 2.0. See `<LICENSE>`_ file.
Visualization component released under the `D-Wave EULA`_.
.. _D-Wave EULA: https://docs.ocean.dwavesys.com/en/stable/licenses/inspector.html
Contributing
============
Ocean's `contributing guide <https://docs.ocean.dwavesys.com/en/stable/contributing.html>`_
has guidelines for contributing to Ocean packages.
Release Notes
-------------
D-Wave Inspector uses `reno <https://docs.openstack.org/reno/>`_ to manage
its release notes.
When making a contribution to D-Wave Inspector that will affect users, create
a new release note file by running:
.. code-block:: bash
reno new your-short-descriptor-here
You can then edit the file created under ``releasenotes/notes/``.
Remove any sections not relevant to your changes.
Commit the file along with your changes.
See reno's `user guide <https://docs.openstack.org/reno/latest/user/usage.html>`_
for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/dwavesystems/dwave-inspector",
"name": "dwave-inspector",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "D-Wave Systems Inc.",
"author_email": "radomir@dwavesys.com",
"download_url": "https://files.pythonhosted.org/packages/5f/4d/aba144f02cc5d0e9a69cf737b66fc2d6c14cac48b98fa451e4d3e4f91bf3/dwave-inspector-0.4.4.tar.gz",
"platform": null,
"description": ".. image:: https://badge.fury.io/py/dwave-inspector.svg\n :target: https://badge.fury.io/py/dwave-inspector\n :alt: Latest version on PyPI\n\n.. image:: https://circleci.com/gh/dwavesystems/dwave-inspector.svg?style=shield\n :target: https://circleci.com/gh/dwavesystems/dwave-inspector\n :alt: Linux/MacOS build status\n\n.. image:: https://codecov.io/gh/dwavesystems/dwave-inspector/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/dwavesystems/dwave-inspector\n :alt: Coverage report\n\n\n================\nD-Wave Inspector\n================\n\n.. index-start-marker\n\nA tool for visualizing problems submitted to, and answers received from, a\nD-Wave structured solver such as an Advantage\\ |TM| quantum computer.\n\n.. |TM| replace:: :sup:`TM`\n\n.. index-end-marker\n\n\nExample\n=======\n\n.. example-start-marker\n\nThis example shows a typical usage: a binary quadratic model minor-embedded \nonto a quantum processing unit (QPU).\n\n.. code-block:: python\n\n from dwave.system import DWaveSampler, EmbeddingComposite\n import dimod\n import dwave.inspector\n\n # Get sampler\n sampler = EmbeddingComposite(DWaveSampler())\n\n # Define a problem\n x, y, z = dimod.Binaries(['x', 'y', 'z'])\n bqm = x*y - x*z + 2*y\n\n # Sample\n sampleset = sampler.sample(bqm, num_reads=100)\n\n # Inspect\n dwave.inspector.show(sampleset)\n\n.. example-end-marker\n\n\nInstallation or Building\n========================\n\n.. installation-start-marker\n\nIf `D-Wave Ocean SDK 2.0+ <https://docs.ocean.dwavesys.com/>`_ is installed:\n\n.. code-block:: bash\n\n dwave install inspector\n\nOtherwise, install the package from PyPI:\n\n.. code-block:: bash\n\n pip install dwave-inspector\n\nand then install the closed-source dependency with:\n\n.. code-block:: bash\n\n pip install dwave-inspectorapp --extra-index=https://pypi.dwavesys.com/simple\n\nPlease note this closed-source dependency is released under the `D-Wave EULA`_ license.\n\nAlternatively, clone and build from source:\n\n.. code-block:: bash\n\n git clone https://github.com/dwavesystems/dwave-inspector.git\n cd dwave-inspector\n pip install -r requirements.txt\n python setup.py install\n\nWhen building from source, the closed-source component still needs to be\ninstalled as above.\n\n.. installation-end-marker\n\n\nLicense\n=======\n\nReleased under the Apache License 2.0. See `<LICENSE>`_ file.\n\nVisualization component released under the `D-Wave EULA`_.\n\n.. _D-Wave EULA: https://docs.ocean.dwavesys.com/en/stable/licenses/inspector.html\n\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\nRelease Notes\n-------------\n\nD-Wave Inspector uses `reno <https://docs.openstack.org/reno/>`_ to manage\nits release notes.\n\nWhen making a contribution to D-Wave Inspector that will affect users, create\na new release note file by running:\n\n.. code-block:: bash\n\n reno new your-short-descriptor-here\n\nYou can then edit the file created under ``releasenotes/notes/``.\nRemove any sections not relevant to your changes.\nCommit the file along with your changes.\n\nSee reno's `user guide <https://docs.openstack.org/reno/latest/user/usage.html>`_\nfor details.\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "D-Wave Problem Inspector tool",
"version": "0.4.4",
"project_urls": {
"Homepage": "https://github.com/dwavesystems/dwave-inspector"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a7e53f15b98c8858e56725f070f603d66d8fc13b0a6d39e0d14c643b488dc8d0",
"md5": "853e66efb4c8d9534875eb45bd5058c0",
"sha256": "10b95597606557b1ccd3c5efa988749137b24ddc6a866adfd420391a99cdb291"
},
"downloads": -1,
"filename": "dwave_inspector-0.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "853e66efb4c8d9534875eb45bd5058c0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31309,
"upload_time": "2023-12-05T14:17:38",
"upload_time_iso_8601": "2023-12-05T14:17:38.880125Z",
"url": "https://files.pythonhosted.org/packages/a7/e5/3f15b98c8858e56725f070f603d66d8fc13b0a6d39e0d14c643b488dc8d0/dwave_inspector-0.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5f4daba144f02cc5d0e9a69cf737b66fc2d6c14cac48b98fa451e4d3e4f91bf3",
"md5": "73000719d072af83b0c66483b537c993",
"sha256": "ccdf2707971042c1bc7be452312287caefc7f4f21db41524c10fc5ad87703202"
},
"downloads": -1,
"filename": "dwave-inspector-0.4.4.tar.gz",
"has_sig": false,
"md5_digest": "73000719d072af83b0c66483b537c993",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26617,
"upload_time": "2023-12-05T14:17:40",
"upload_time_iso_8601": "2023-12-05T14:17:40.848911Z",
"url": "https://files.pythonhosted.org/packages/5f/4d/aba144f02cc5d0e9a69cf737b66fc2d6c14cac48b98fa451e4d3e4f91bf3/dwave-inspector-0.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 14:17:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dwavesystems",
"github_project": "dwave-inspector",
"travis_ci": false,
"coveralls": true,
"github_actions": false,
"circle": true,
"requirements": [],
"lcname": "dwave-inspector"
}
JSON
