A minimal client for interacting with D-Wave cloud resources.
Project description
dwave-cloud-client
D-Wave Cloud Client is a minimal implementation of the REST interface used to communicate with D-Wave Sampler API (SAPI) servers.
SAPI is an application layer built to provide resource discovery, permissions, and scheduling for quantum annealing resources at D-Wave Systems. This package provides a minimal Python interface to that layer without compromising the quality of interactions and workflow.
The example below instantiates a D-Wave Cloud Client and solver based on the local system’s auto-detected default configuration file and samples a random Ising problem tailored to fit the solver’s graph.
import random
from dwave.cloud import Client
# Connect using the default or environment connection information
with Client.from_config() as client:
# Load the default solver
solver = client.get_solver()
# Build a random Ising model to exactly fit the graph the solver supports
linear = {index: random.choice([-1, 1]) for index in solver.nodes}
quad = {key: random.choice([-1, 1]) for key in solver.undirected_edges}
# Send the problem for sampling, include solver-specific parameter 'num_reads'
computation = solver.sample_ising(linear, quad, num_reads=100)
# Print the first sample out of a hundred
print(computation.samples[0])
Installation
Requires Python 3.8+:
pip install dwave-cloud-client
To install from source (available on GitHub in dwavesystems/dwave-cloud-client repo):
pip install -r requirements.txt
python setup.py install
License
Released under the Apache License 2.0. See LICENSE file.
Contributing
Ocean’s contributing guide has guidelines for contributing to Ocean packages.
Release Notes
D-Wave Cloud Client uses reno to manage its release notes.
When making a contribution to D-Wave Cloud Client 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dwave-cloud-client-0.11.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3698b0f861bab2b9979bf58db4f6a7bd864a9b2ec946d7f4ccd3baca49642e4 |
|
MD5 | bbe5a559dc7291d1461b78160aa5d6b9 |
|
BLAKE2b-256 | ef2f53746c6a0f2d97399ec2336666d8f4f7f6b25b066bea5be060052a94fda1 |
Hashes for dwave_cloud_client-0.11.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fe02e47178d520d613844447be34fc16f477a0d50f347f403216471918482cb5 |
|
MD5 | db913eca4f5562ea8480d44e7eba0d90 |
|
BLAKE2b-256 | 7e0fe1d46ffc930b63f4f2d25bd36ca9182e18920144af72ba54b998502cb32e |