_images/new_logo.png

Welcome to CircuitQ’s documentation!

CircuitQ is an an open-source toolbox for the analysis of superconducting circuits implemented in Python. It features the automated construction of a symbolic Hamiltonian of the input circuit, as well as a dynamic numerical representation of this Hamiltonian with a variable basis choice. Additional features include the estimation of the T1 lifetimes of the circuit states under various noise mechanisms. The circuit quantization is both applicable to circuit inputs from a large design space and open-source.

To get started, have a look at the installation instructions and at our quick demo for a demonstration of the basic usage of the toolbox.

A more comprehensive description of CircuitQ’s functionalities can be found in the tutorial.

For further illustrations of the toolbox, please see the more examples section. The API reference provides an overview of the range of functions and is constructed based on the docstrings.

Table of contents

Note

Please refer to our publication for more details on physics and implementation and to cite our project.

The source code can be found on CircuitQ’s repository at GitHub.

CircuitQ was developed by Philipp Aumann and Tim Menke under the supervision of William Oliver and Wolfgang Lechner.

Index