QCDrivers 🔧

This repository collects and shares QCoDeS drivers that are not available through qcodes or the contrib drivers repository. It may also contain proprietary drivers written by lab members of SQUAD Lab, including drivers developed in collaboration with partner companies.

Installation

QCDrivers requires Python 3.13 and can be installed with either uv or pip:

uv add qcdrivers

pip install qcdrivers

Layout

The drivers are grouped by manufacturer. Hardware-triggered (buffered) sweep nodes can be found under buffered/, where they follow the same grouping.

src/qcdrivers
├── basel/          amplifiers, dacs
├── bluefors/       fridges
├── entropy/        adr, heater
├── harvard/        dacs
├── keysight/       dmms, vna
├── qdevil/         qdac2
├── rwth/           mux
├── squad/          curry, helpers, mux
├── stanford/       vccs
└── buffered/
    ├── basel
    ├── keysight
    ├── qdevil
    ├── squad
    └── zurich

Please follow this structure when adding a new driver, using the existing drivers as a reference. Each package re-exports its public classes and declares __all__ to keep imports short and convenient.

Usage

from qcdrivers.basel.dacs import BaselDac2
from qcdrivers.buffered.keysight import NodeKeysightDMM
from qcdrivers.buffered.qdevil import NodeQDAC2
from qcdrivers.keysight.dmms import Keysight34461A

The drivers can be imported directly from their category package, as shown above. There is no need to import them from their individual module files.

The complete list of parameters for an instrument can be displayed through QCoDeS:

dac = BaselDac2("dac", address="...")
print(dac.parameters)

Buffered nodes

A buffered node wraps a QCoDeS instrument and provides the interface used by a Qanary buffered sweep: register_sweep, register_dependent, run_sweep, fetch, abort, and toplevel.

Import buffered nodes from their manufacturer package, for example qcdrivers.buffered.qdevil or qcdrivers.buffered.keysight.

Development

To set up a local development environment, clone the repository and install the development dependencies with uv:

git clone https://gitlab.com/squad-lab/qcdrivers
cd qcdrivers
uv sync --extra dev
uv run pre-commit install

Contributing

To contribute to the repository, please follow the directory structure above and open a merge request. Drivers should be well documented and, where possible, tested without hardware before submission. Please see the contributing guide for the complete development and submission process. Everyone is welcome to report bugs or request features by opening an issue.