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
File details
Details for the file dwave-cloud-client-0.13.1.tar.gz
.
File metadata
- Download URL: dwave-cloud-client-0.13.1.tar.gz
- Upload date:
- Size: 129.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f1541ceae1100ad80214b583a5c5c0323ec24b7bc31c7917fe8f57e287cc1776 |
|
MD5 | f444c72c15b89e37e485984190dc3783 |
|
BLAKE2b-256 | 7a7a8f7e15bbd8f58d9b8ddafdd232bfd45a89d2ae0cb93dec5ba2d90fed2f7c |
File details
Details for the file dwave_cloud_client-0.13.1-py3-none-any.whl
.
File metadata
- Download URL: dwave_cloud_client-0.13.1-py3-none-any.whl
- Upload date:
- Size: 158.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.10
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | fec0fcf402d67508fe571321b4be26c541a6c1a503f51832bab5df1a120de70e |
|
MD5 | 5cbffb09a92b9cf3a3d249c7fe0993dd |
|
BLAKE2b-256 | 06a12ddcdd5576f905656ff979956773b599bcbf4a13cd6ada9e22494f8233c0 |