D-Wave Inspector¶
A tool for visualizing problems submitted to, and answers received from, a D-Wave structured solver such as an AdvantageTM quantum computer.
Example¶
This example shows a typical usage: a binary quadratic model minor-embedded onto a quantum processing unit (QPU).
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)
Installation or Building¶
If D-Wave Ocean SDK 2.0+ is installed:
dwave install inspector
Otherwise, install the package from PyPI:
pip install dwave-inspector
and then install the closed-source dependency with:
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:
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.
License¶
Released under the Apache License 2.0. See LICENSE file.
Visualization component released under the D-Wave EULA.
Contributing¶
Ocean’s contributing guide has guidelines for contributing to Ocean packages.
Release Notes¶
D-Wave Inspector uses 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:
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 for details.