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.7+:
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.10.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3288f395eaa34bb0873ad08cbe1653acba960791487ae58d5f7ef3830e7f131b |
|
MD5 | 9b4c7cd1d7c5fb9729723b3ff97d44b8 |
|
BLAKE2b-256 | ad2ae8a2e2b2a6b267944fa9f98634b2dac67a0778e8305f45c2041aa6e50cf7 |
Hashes for dwave_cloud_client-0.10.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e261d6d5226977f7b0b1bd146e2e1b79ceaccdb495d7c7cdfcf503c3c37d5445 |
|
MD5 | e689fa6160f0266b0c728784b098dc93 |
|
BLAKE2b-256 | 03f5941acc034b8243b14bb9aab31a1912ebf98d46e31e10683e8bb5c491d714 |