Skip to content

dwavesystems/dwave-inspector

master
Switch branches/tags
Code
Latest version on PyPI Linux/MacOS build status Coverage report Documentation Status

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 the canonical usage: samples representing physical qubits on a quantum processing unit (QPU).

import dwave.system
import dwave.inspector

# Get sampler
sampler = dwave.system.DWaveSampler()

# Define a problem (actual qubits depend on the selected QPU's working graph)
h = {}
J = {(0, 4): 1, (0, 5): 1, (1, 4): 1, (1, 5): -1}
assert all(edge in sampler.edgelist for edge in J)

# Sample
sampleset = sampler.sample_ising(h, J, 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.