The Xanadu Cloud Client (XCC) is a Python API and CLI for the Xanadu Cloud.
Features
Simple. Easy to setup, explore, and use.
Efficient. Lazy fetching and caching by default.
Structured. Parse Xanadu Cloud responses into JSON or Python objects.
Installation
The XCC requires Python version 3.7 or above. Installation of the XCC, as well as all dependencies, can be done using pip:
pip install xanadu-cloud-client
Setup
To use the XCC, a Xanadu Cloud API key (or equivalent JWT refresh token) is required. There are several ways to register your API key with the XCC:
Save your API key to the XCC configuration file using the CLI:
xcc config set REFRESH_TOKEN "Xanadu Cloud API key goes here"Set the XANADU_CLOUD_REFRESH_TOKEN environment variable:
export XANADU_CLOUD_REFRESH_TOKEN="Xanadu Cloud API key goes here"Save your API key to the XCC configuration file using the Python API:
import xcc settings = xcc.Settings(REFRESH_TOKEN="Xanadu Cloud API key goes here") settings.save()
Afterwards, you can verify that your API key was set correctly using either:
The CLI:
$ xcc ping Successfully connected to the Xanadu Cloud.The Python API:
import xcc connection = xcc.Connection.load() assert connection.ping().ok
Tutorial
The following tutorial illustrates a workflow for submitting a job to the Xanadu Cloud using the CLI. For more detailed usage instructions, use --help or refer to the Python API documentation.
Before submitting a job, it is a good idea to check which devices are currently accepting jobs on the Xanadu Cloud:
$ xcc device list --status online[ { "target": "simulon_gaussian", "status": "online" }, { "target": "X8_01", "status": "online" } ]Suppose that the simulon_gaussian device is of interest. The capabilities, operating conditions, and other properties of a device can be queried by supplying the appropriate flag to the xcc device get command:
$ xcc device get simulon_gaussian --availability{ "monday": [ "00:00:00+00:00", "23:59:59+00:00" ], "tuesday": [ "00:00:00+00:00", "23:59:59+00:00" ], "wednesday": [ "00:00:00+00:00", "23:59:59+00:00" ], "thursday": [ "00:00:00+00:00", "23:59:59+00:00" ], "friday": [ "00:00:00+00:00", "23:59:59+00:00" ], "saturday": [ "00:00:00+00:00", "23:59:59+00:00" ], "sunday": [ "00:00:00+00:00", "23:59:59+00:00" ] }Note: Given that simulon_gaussian is a simulator, it does not have any scheduled downtime for maintenance.
Now, consider a Blackbird script stored in a local file named circuit.xbb:
$ cat circuit.xbb name example version 1.0 target simulon_gaussian (shots=4) MeasureFock() | [0, 1, 2]This circuit can be submitted to the simulon_gaussian device using the xcc job submit command:
$ xcc job submit --name example \ --target simulon_gaussian \ --language "blackbird:1.0" \ --circuit "$(cat circuit.xbb)"{ "id": "4c043f6d-54c7-4915-bbb8-eb1b99c4d88e", "name": "example", "status": "open", "target": "simulon_gaussian", "created_at": "2021-09-24 17:52:00.532938+00:00", "finished_at": null, "running_time": null }Note: Replace cat foo.xbb with Get-Content foo.xbb -Raw on Windows PowerShell.
The ID of a job can be used to retrieve additional information about that job, including its status and running time. Specifically, the ID can be supplied to the xcc job get command along with an optional flag:
$ xcc job get 4c043f6d-54c7-4915-bbb8-eb1b99c4d88e --status completeThe result of a job can be accessed in a similar way:
$ xcc job get 4c043f6d-54c7-4915-bbb8-eb1b99c4d88e --result{ "output": [ "[[0 0 0]\n[0 0 0]\n[0 0 0]\n[0 0 0]]" ] }
Contributions
We welcome contributions - simply fork the XCC repository and make a pull request containing your contribution. All contributors to the XCC will be listed as authors on the releases. See our changelog for more details.
We also encourage bug reports, suggestions for new features and enhancements, and even links to cool projects or applications built on top of the XCC. Visit the contributions page to learn more about sharing your ideas with the XCC team.
Support
Source Code: https://github.com/XanaduAI/xanadu-cloud-client
Issue Tracker: https://github.com/XanaduAI/xanadu-cloud-client/issues
If you are having issues, please let us know by posting the issue on our GitHub issue tracker.
License
The XCC is free and open source, released under the Apache License, Version 2.0.
Metadata
Release files for xanadu-cloud-client 0.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| xanadu-cloud-client-0.3.2.tar.gz | 33.9 kB | Without provenance | Details for xanadu-cloud-client-0.3.2.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| xanadu_cloud_client-0.3.2-py3-none-any.whl | Python 3 | none | any | Details for xanadu_cloud_client-0.3.2-py3-none-any.whl |
Total release size: 59.4 kB
Release files / xanadu-cloud-client-0.3.2.tar.gz
| Download URL | xanadu-cloud-client-0.3.2.tar.gz |
|---|---|
| Size | 33.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
563750ed72d2e9bbe428073bcb4ee02d751872d026207e90e88e928fab495ffb
|
|
BLAKE2b-256 checksum How to use checksums |
c405723d1341bc28de9acbb422d03a94269f3c06ec4e635769a99ea4aa3b3930
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Release files / xanadu_cloud_client-0.3.2-py3-none-any.whl
| Download URL | xanadu_cloud_client-0.3.2-py3-none-any.whl |
|---|---|
| Size | 25.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
120d8567329c249afe00ff29b1be842cce6eed74caaf0d7aecc554043a0810f1
|
|
BLAKE2b-256 checksum How to use checksums |
76a4f56b02aae6223ed789ae121ea2b10cde6ac947c0c24a739e187026231cf6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.18
|
Security for xanadu-cloud-client 0.3.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.