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.