Skip to content

Get Started

QuICK provides experiment routines and pulse protocols for QICK firmware.

Installation

Use Python 3.13+ on the PC and install this checkout from its repository root. An independently published release may not contain the native changes. Install the separate board_setup_next package on the board before connecting; see Board Setup.

Install this package with pip:

pip install clelandlab-quick

It is recommended to use a conda environment.

import quick

# connect to the native board server on TCP 9999
soccfg, soc = quick.connect(QICK_IP)

Document Convention

All and only class are capitalized.

The APIs fall into several accessibility:

  • 🟢 very useful
  • 🔵 sometimes useful
  • 🟡 mostly internal use
  • 🔴 broken or deprecated