quelware-client
The official Python client library for QuEL-3, an integrated control system for quantum computing developed by QuEL, inc.
It provides a high-level, asynchronous interface to connect, configure, and orchestrate QuEL systems via gRPC.
Note: Currently, this library supports QuEL-3. We plan to expand support to our earlier models, such as QuEL-1 and QuEL-1 SE, in future releases.
Installation
You can easily install the package via pip:
pip install quelware-client
Authentication
A Personal Access Token (PAT) is required. Set it up in one of the following ways:
- Place it in a config file:
mkdir -p ~/.config/quelware-client echo "your-pat-here" > ~/.config/quelware-client/pat
- Or pass it directly in code:
qc = create_quelware_client("localhost", 50051, pat="your-pat-here")
To obtain a PAT, ask your system administrator to run quelware-admin user add.
Quick Start
Here is a minimal example of connecting to the control server in QuEL system and managing a session:
import asyncio
from quelware_client import create_quelware_client
async def main():
qc = create_quelware_client(<hostname>, <port>)
async with qc:
async with qc.create_session(["your_unit:port_id"]) as session:
print(f"Session started with token: {session.token}")
# Deploy instruments, configure sequencer, and run timelines here...
if __name__ == "__main__":
asyncio.run(main())
For more advanced usage, including pulse generation and sequencer configuration, please check the examples directory.
Documentation
See the client documentation for guides and the API reference. The full site is at https://quel-inc.github.io/quelware-client/.
License
This project is licensed under the Apache License 2.0.
Metadata
Release files for quelware-client 0.7.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| quelware_client-0.7.3.tar.gz | 76.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| quelware_client-0.7.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 126.8 kB
Release files / quelware_client-0.7.3.tar.gz
| Download URL | quelware_client-0.7.3.tar.gz |
|---|---|
| Size | 76.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
378f194a9dc5b60af9d0620ab0179c806807d801838e46c1683baa337af93cef
|
|
BLAKE2b-256 checksum How to use checksums |
bf559859a66340acdf22b41910cf208c5fafbc520aa8cd599694e1cb7d0bd244
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
Release files / quelware_client-0.7.3-py3-none-any.whl
| Download URL | quelware_client-0.7.3-py3-none-any.whl |
|---|---|
| Size | 50.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b788b1282deb1cba450cc9af8a1d220729941ac25aa58ea68d4bc11aebbf43ad
|
|
BLAKE2b-256 checksum How to use checksums |
71dca889491a50040ad2e7b39baee29f2434d9329cfb9e9006840736ba97f1c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.12.3
|
