Data

Tools

Indexes

Applications

Experiments

Open Source Science

qupulse

Quantum Computing Toolkit for Qubit Control

https://github.com/qutech/qupulse

Science Score: 54.0%

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

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    13 of 29 committers (44.8%) from academic institutions
  • ✓
    Institutional organization owner
    Organization qutech has institutional domain (www.quantuminfo.physik.rwth-aachen.de)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.8%) to scientific vocabulary

Keywords from Contributors

quantum-computing quantum-information qutip
Last synced: 6 months ago · JSON representation

Repository

Quantum Computing Toolkit for Qubit Control

Basic Info
  • Host: GitHub
  • Owner: qutech
  • Language: Python
  • Default Branch: master
  • Homepage:
  • Size: 12.4 MB
Statistics
  • Stars: 59
  • Watchers: 9
  • Forks: 30
  • Open Issues: 76
  • Releases: 11
Created about 11 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Zenodo

README.md

qupulse: A Quantum compUting PULse parametrization and SEquencing framework

Coverage Status Build Status Documentation Status DOI

The qupulse project aims to produce a software toolkit facilitating experiments involving pulse driven state manipulation of physical qubits.

It provides a high-level hardware-independent representation of pulses as well as means to translate this representation to hardware-specific device instructions and waveforms, execute these instructions and perform corresponding measurements.

Pulses can be assembled from previously defined subpulses, allowing easy construction of high-level from low-level pulses and re-use of previous work. Additionally, all pulses are parameterizable allowing users to fine-tune and adapt pulse templates to specific hardware or functionality without redefining an entire pulse sequence. To ensure meaningful parameter values, constraints can be put on parameters on a per-pulse basis.

Status and stability

The qupulse library is used productively by the Quantum Technology Group at the 2nd Institute of Physics at the RWTH Aachen University. As such, some features - such as pulse definition - are mostly complete and tested and interfaces are expected to remain largely stable (or changes to be backward compatible). A key goal is that experiments should be repeatable with new versions of qupulse. However, it is still possible for existing portions of the code base to be redesigned if this will increase the usability long-term.

The current feature list is as follows:

  • Definition of complex (arbitrarily deep nested and looped pulses) parameterized pulses in Python (including measurement windows)
  • Mathematical expression evaluation (based on sympy) for parameter values and parameter constraints
  • Serialization of pulses (to allow storing into permanent storage)
  • Hardware model representation
  • High-level pulse to hardware configuration and waveform translation routines
  • Hardware drivers for Tabor Electronics, Tektronix and Zurich Instruments AWGs and AlazarTech Digitizers

Pending changes are tracked in the changes.d subdirectory and published in RELEASE_NOTES.rst on release using the tool towncrier.

Removed features

The previous name of this package was qctoolkit. It was renamed in 2017 to highlight the pulse focus. The backward compatible alias was removed after the 0.9 release. Furthermore, this repository had a MATLAB interface for a longer time which was removed at the same time.

Installation

qupulse is available on PyPi and the latest release can be installed by executing: sh python -m pip install qupulse[default] which will install all required and optional dependencies except for hardware support. qupulse version numbers follow the Semantic Versioning conventions.

Alternatively, the current development version of qupulse can be installed by executing sh python -m pip install -e git+https://github.com/qutech/qupulse.git#egg=qupulse[default] which will clone the github repository to ./src/qupulse and do an editable/development install.

Requirements and dependencies

qupulse requires at least Python 3.10 and is tested on 3.10, 3.11 and 3.12. It relies on some external Python packages as dependencies. We intentionally did not restrict versions of dependencies in the install scripts to not unnecessarily prevent usage of newer releases of dependencies that might be compatible. However, if qupulse does encounter problems with a particular dependency version please file an issue.

The backend for TaborAWGs requires packages that can be found here.

The data acquisition backend for AlazarTech cards needs a package that unfortunately is not open source (yet). If you need it or have questions contact simon.humpohl@rwth-aachen.de.

Documentation

You can find documentation on how to use this library on readthedocs and IPython notebooks with examples in this repo. You can build it locally with hatch run docs:html if you have pandoc installed.

Folder Structure

The repository primarily consists of the folders qupulse (source code), tests and doc.

qupulse contains the entire Python source code of the project and is further partitioned the following packages of related packages

  • pulses which contains all modules related to pulse representation.
  • hardware containing classes for hardware representation as well as hardware drivers
  • utils containing miscellaneous utility modules or wrapping code for external libraries
  • program contains general and hardware specific representations of instantiated (parameter free) pulses.
  • expression contains the expression interface used by qupulse.

Contents of tests mirror the structure of qupulse. For every <module> somewhere in qupulse there should exist a <module>Tests.py in the corresponding subdirectory of tests.

Development

qupulse uses hatch as development tool which provides a convenient interface for most development tasks. The following should work.

  • hatch build: Build wheel and source tarball
  • hatch version X.X.X: Set version
  • hatch run docs:html: Build documentation (requires pandoc)
  • hatch run docs:clean-notebooks to execute all example notebooks that start with 00-03 and clean all metadata.
  • hatch run changelog:draft and hatch run changelog:release to preview or update the changelog.

License

The current version of qupulse is available under the LGPL-3.0-or-later license. Versions up to and including 0.10 were licensed under the MIT license. If you require different licensing terms, please contact us to discuss your needs.

Owner

  • Name: Quantum Technology Group
  • Login: qutech
  • Kind: organization
  • Location: Aachen, Germany

GitHub Events

Total
  • Issues event: 43
  • Watch event: 3
  • Delete event: 4
  • Issue comment event: 87
  • Push event: 123
  • Pull request review event: 36
  • Pull request review comment event: 30
  • Pull request event: 50
  • Create event: 25
Last Year
  • Issues event: 43
  • Watch event: 3
  • Delete event: 4
  • Issue comment event: 87
  • Push event: 123
  • Pull request review event: 36
  • Pull request review comment event: 30
  • Pull request event: 50
  • Create event: 25

Committers

Last synced: almost 3 years ago

All Time
  • Total Commits: 1,961
  • Total Committers: 29
  • Avg Commits per committer: 67.621
  • Development Distribution Score (DDS): 0.46
Top Committers
Name Email Commits
Simon Humpohl s****l@r****e 1,059
Lukas Prediger l****r@r****e 442
Pieter Eendebak p****k@g****m 67
Pascal Cerfontaine c****e@p****e 58
Patrick Bethke b****e@p****e 47
hylta a****s@g****m 43
Marcel Meyer m****1@r****e 36
j340m3 j****3@h****m 34
Simon Humpohl t****h@u****m 33
Pascal Cerfontaine p****e@r****e 30
Tobias Hangleiter (Triton 200) t****r@r****e 27
Eugen Kammerloher e****r@g****m 25
inst2c i****c@g****m 15
Lukas.Lankes l****s@f****e 6
ag-bluhm-69 a****9@o****m 6
TomStruck t****2@g****m 5
Kreutz m****z@g****m 5
Pieter Eendebak p****k@t****l 4
terryFitch h****m@t****e 4
Lukas Prediger l****p@g****t 3
Marcel Meyer m****r@r****e 3
Luc Blom l****m@t****t 2
Tim Leonhardt (SiGe Triton 200) t****t@r****e 1
Unknown u****n@e****m 1
Alexander Willmes W****s@i****e 1
antonio p****z@s****e 1
Benjamin Papajewski b****i@f****e 1
terrorfisch t****h@m****g 1
Jerome Bergmann j****3@u****m 1
Committer Domains (Top 20 + Academic)
rwth-aachen.de: 7 fz-juelich.de: 2 physik.rwth-aachen.de: 2 mailbox.org: 1 se.rwth-aachen.de: 1 institut2b.physik.rwth-aachen.de: 1 tudelft.net: 1 gmx.net: 1 t-online.de: 1 tno.nl: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 114
  • Total pull requests: 202
  • Average time to close issues: over 3 years
  • Average time to close pull requests: 2 months
  • Total issue authors: 16
  • Total pull request authors: 9
  • Average comments per issue: 1.39
  • Average comments per pull request: 1.39
  • Merged pull requests: 144
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 10
  • Pull requests: 48
  • Average time to close issues: 3 days
  • Average time to close pull requests: 1 day
  • Issue authors: 3
  • Pull request authors: 4
  • Average comments per issue: 0.3
  • Average comments per pull request: 0.96
  • Merged pull requests: 31
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • terrorfisch (49)
  • lumip (18)
  • shumpohl (13)
  • Nomos11 (8)
  • maxbeer99 (7)
  • hbluhm (6)
  • qutech-lab (3)
  • pbethke (2)
  • SchmidtMarc (1)
  • LRSchreiber (1)
  • mloberlaender (1)
  • CarlosMenke (1)
  • j340m3 (1)
  • paniash (1)
  • lankes-fzj (1)
Pull Request Authors
  • terrorfisch (121)
  • Nomos11 (34)
  • shumpohl (31)
  • eendebakpt (6)
  • maxbeer99 (5)
  • lumip (2)
  • daniel204 (1)
  • BrllsRX (1)
  • paulsurrey (1)
Top Labels
Issue Labels
Task (15) Feature (14) Documentation (9) Priority: Desired (7) Bug (7) Discussion (7) Priority: Essential (5) Priority: Optional (4) Implementation (2) Framework integration (2) Design (2) Performance (2) Design Flaw (1)
Pull Request Labels
Documentation (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 615 last-month
  • Total dependent packages: 3
  • Total dependent repositories: 1
  • Total versions: 12
  • Total maintainers: 2
pypi.org: qupulse

A Quantum compUting PULse parametrization and SEquencing framework

  • Versions: 12
  • Dependent Packages: 3
  • Dependent Repositories: 1
  • Downloads: 615 Last month
Rankings
Forks count: 7.1%
Stargazers count: 9.5%
Dependent packages count: 10.1%
Average: 12.8%
Downloads: 15.7%
Dependent repos count: 21.6%
Maintainers (2)
QuTech simon.humpohl
Last synced: 6 months ago

Dependencies

doc/requirements.txt pypi
  • ipykernel ==6.9.1
  • nbsphinx ==0.8.8
  • sphinx ==4.4.0
.github/workflows/pythonpublish.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite
.github/workflows/pythontest.yaml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • actions/upload-artifact v2 composite
.github/workflows/unittest_publish.yaml actions
  • EnricoMi/publish-unit-test-result-action v2 composite