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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed321c8bfe42b7833b9b30916fbb5d0b817476281c24fd93ad9d515262231de4 |
|
MD5 | b90353a6af26398f90022a30bff02dda |
|
BLAKE2b-256 | bdd7b4c95603baca8bc4647385afbd4863a9e4a5c97269fbf66c4a857eb8cbe8 |
Hashes for dwave_cloud_client-0.10.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86265c8fa525b7474b6e25322b709fbdd7149f2f236a433871324705a5ac951f |
|
MD5 | 60ca51a28d9233f104dc9acb585a2e53 |
|
BLAKE2b-256 | 939a7885b7ba90353406cd64d35cdc84b9461dfb29763236f9a0b2e3e7031cda |