Data

Tools

Indexes

Applications

Experiments

Open Source Science

qick

QICK: Quantum Instrumentation Control Kit

https://github.com/openquantumhardware/qick

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation ·

Repository

QICK: Quantum Instrumentation Control Kit

Basic Info
  • Host: GitHub
  • Owner: openquantumhardware
  • License: mit
  • Language: Jupyter Notebook
  • Default Branch: main
  • Homepage:
  • Size: 132 MB
Statistics
  • Stars: 249
  • Watchers: 22
  • Forks: 101
  • Open Issues: 9
  • Releases: 2
Created almost 5 years ago · Last pushed 10 months ago
Metadata Files
Readme License Citation Support

README.md

QICK logo

QICK: Quantum Instrumentation Control Kit

QICK is an open-source qubit controller, consisting of firmware, software, and an optional frontend for use with Xilinx RFSoC development boards. The goal of the project is to provide a powerful, flexible, cost-effective, and easy-to-learn platform for control and readout of a diverse range of quantum systems.

QICK supports the ZCU111, ZCU216, and RFSoC4x2 development boards. We generally recommend using the newer generation of RFSoCs (ZCU216 and RFSoC4x2) for better overall performance.

It consists of: * Firmware for the supported RFSoC boards, both compiled bitstreams and source for the designs and modules * The qick Python package, which includes the interface to the firmware and an API for writing QICK programs * Jupyter notebooks demonstrating usage

See our Read the Docs site for: * Documentation of the firmware and software * A quick-start guide for setting up your board and running the example Jupyter notebooks * Ways to communicate with QICK developers and the community * Extensions to QICK for added functionailty

Updates

The QICK firmware and software is still very much a work in progress. We strive to be consistent with the APIs but cannot guarantee backwards compatibility.

Frequent updates to the QICK firmware and software are made as pull requests. Each pull request will be documented with a description of the notable changes, including any changes that will require you to change your code. We hope that this will help you decide whether or not to update your local code to the latest version. We strive for, but cannot guarantee, bug-free and fully functional pull requests. We also do not guarantee that the demo notebooks will keep pace with every pull request, though we make an effort to update the demos after major API changes.

Our version numbering follows the format major.minor.PR, where PR is the number of the most recently merged pull request. This will result in the PR number often skipping values, and occasionally decreasing. The tagged release of a new minor version will have the format major.minor.0.

Tagged releases can be expected periodically. We recommend that everyone should be using at least the most recent release. We guarantee the following for releases: * The demo notebooks will be compatible with the QICK library, and will follow our current best recommendations for writing QICK programs. * The firmware images for all supported boards will be fully compatible with the library and the demo notebooks. * Release notes will summarize the pull request notes and explain both breaking API changes (what you need to change in your code) and improvements (why you should move to the new release).

We recommend that you "watch" this repository on GitHub to get automatic notifications of pull requests and releases.

Contribute

You are welcome to contribute to QICK development by forking this repository and sending pull requests.

All contributions are expected to be consistent with PEP 8 -- Style Guide for Python Code.

We welcome bug reports and feature requests via GitHub Issues.

License

The QICK source code is licensed under the MIT license, which you can find in the LICENSE file. The QICK logo was designed by Dr. Christie Chiu.

You are free to use this software, with or without modification, provided that the conditions listed in the LICENSE file are satisfied.

Owner

  • Name: openquantumhardware
  • Login: openquantumhardware
  • Kind: organization

Citation (CITATION.cff) 

cff-version: 1.2.0
# CITATION.cff created with https://github.com/monperrus/bibtexbrowser/
preferred-citation:
  title: "The QICK (Quantum Instrumentation Control Kit): Readout and control for qubits and detectors"
  doi: "10.1063/5.0076249"
  year: "2022"
  type: article
  journal: "Review of Scientific Instruments"
  authors:
    - family-names: Stefanazzi
      given-names: Leandro
    - family-names: Treptow
      given-names: Kenneth
    - family-names: Wilcer
      given-names: Neal
    - family-names: Stoughton
      given-names: Chris
    - family-names: Bradford
      given-names: Collin
    - family-names: Uemura
      given-names: Sho
    - family-names: Zorzetti
      given-names: Silvia
    - family-names: Montella
      given-names: Salvatore
    - family-names: Cancelo
      given-names: Gustavo
    - family-names: Sussman
      given-names: Sara
    - family-names: Houck
      given-names: Andrew
    - family-names: Saxena
      given-names: Shefali
    - family-names: Arnaldi
      given-names: Horacio
    - family-names: Agrawal
      given-names: Ankur
    - family-names: Zhang
      given-names: Helin
    - family-names: Ding
      given-names: Chunyang
    - family-names: Schuster
      given-names: David I.

GitHub Events

Total
  • Create event: 23
  • Issues event: 29
  • Watch event: 52
  • Delete event: 16
  • Issue comment event: 74
  • Push event: 165
  • Pull request review event: 7
  • Pull request review comment event: 6
  • Pull request event: 85
  • Gollum event: 9
  • Fork event: 22
Last Year
  • Create event: 23
  • Issues event: 29
  • Watch event: 52
  • Delete event: 16
  • Issue comment event: 74
  • Push event: 165
  • Pull request review event: 7
  • Pull request review comment event: 6
  • Pull request event: 85
  • Gollum event: 9
  • Fork event: 22

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 102
  • Total pull requests: 272
  • Average time to close issues: 3 months
  • Average time to close pull requests: 1 day
  • Total issue authors: 41
  • Total pull request authors: 20
  • Average comments per issue: 3.25
  • Average comments per pull request: 0.3
  • Merged pull requests: 254
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 19
  • Pull requests: 85
  • Average time to close issues: 16 days
  • Average time to close pull requests: 2 days
  • Issue authors: 12
  • Pull request authors: 11
  • Average comments per issue: 2.05
  • Average comments per pull request: 0.51
  • Merged pull requests: 69
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • JavierSerranoGarcia (11)
  • rodolfocarobene (8)
  • meeg (8)
  • lucyfan7266 (7)
  • zhizhenzhong (6)
  • tristanlorriaux (6)
  • Cameron-Spence-Riverlane (5)
  • dmartin2-fnal (4)
  • jramsey123 (4)
  • EeshGupta (3)
  • mutasemodeh (3)
  • yyjun22 (2)
  • i-am-mounce (2)
  • lharnaldi (2)
  • sebastianhorvath (2)
Pull Request Authors
  • meeg (190)
  • sarafs1926 (25)
  • jcpunk (19)
  • yoshi74ls181 (12)
  • hatlabcz (6)
  • mmdiego (5)
  • jacobfeder (5)
  • dmartin2-fnal (4)
  • ammounce (4)
  • kevinkiener (3)
  • ghost (2)
  • benjic194 (2)
  • paniash (2)
  • probvar (2)
  • AleCandido (2)
Top Labels
Issue Labels
firmware (7) enhancement (5) software (4) bug (3) hardware (1) documentation (1)
Pull Request Labels
firmware (10) software (7) bug (7) enhancement (5)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 2,191 last-month
  • Total dependent packages: 1
  • Total dependent repositories: 1
  • Total versions: 145
  • Total maintainers: 1
pypi.org: qick

Quantum Instrumentation Controller Kit software library

  • Versions: 145
  • Dependent Packages: 1
  • Dependent Repositories: 1
  • Downloads: 2,191 Last month
Rankings
Downloads: 4.6%
Dependent packages count: 4.8%
Forks count: 5.7%
Stargazers count: 6.3%
Average: 8.6%
Dependent repos count: 21.6%
Maintainers (1)
meeg
Last synced: 10 months ago

Dependencies

docs/requirements.txt pypi
  • numpy >=1.14.2
  • tqdm *
setup.py pypi
  • numpy *
  • pynq >=2.6
  • tqdm *
.github/workflows/update_version.yml actions
  • actions/checkout v3 composite
.github/workflows/wheels.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/test_zcu111.yml actions
  • actions/checkout v3 composite
qick_lib/qick/ipq_pynq_utils/setup.py pypi