Metadata-Version: 2.1
Name: bfqcircuits
Version: 0.2.1
Summary: Superconducting circuit quantization
Author-email: Martin Spiecker <47812395+MartinSpiecker@users.noreply.github.com>
Maintainer-email: Martin Spiecker <47812395+MartinSpiecker@users.noreply.github.com>
License: Copyright (c) 2024. Martin Spiecker. All rights reserved.
Project-URL: Homepage, https://github.com/MartinSpiecker/bfqcircuits
Project-URL: Bug Reports, https://github.com/MartinSpiecker/bfqcircuits/issues
Project-URL: Source Code, https://github.com/MartinSpiecker/bfqcircuits
Project-URL: Documentation, https://black-forest-quantum-circuits.readthedocs.io/en/latest/index.html
Keywords: bfqcircuits
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.10
Description-Content-Type: text/markdown; charset=UTF-8
License-File: LICENSE.md
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: schemdraw
Provides-Extra: develop
Requires-Dist: ruff; extra == "develop"
Provides-Extra: tests
Requires-Dist: coverage[toml]; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"

# Black Forest Quantum Circuits

[![Python](https://img.shields.io/pypi/pyversions/bfqcircuits.svg)](https://badge.fury.io/py/bfqcircuits)
[![PyPI](https://badge.fury.io/py/bfqcircuits.svg)](https://badge.fury.io/py/bfqcircuits)
[![DOI](https://zenodo.org/badge/835614971.svg)](https://zenodo.org/doi/10.5281/zenodo.13695981)
[![Documentation](https://img.shields.io/badge/api-reference-blue.svg)](https://black-forest-quantum-circuits.readthedocs.io/en/latest/index.html)

This package allows the numerical exploration of the most commonly used superconducting artificial atoms,
the transmon and the fluxonium. Even though these circuit names are typically associated with certain parameter regimes,
all regimes of these circuits can efficiently be analysed.

The package can be used to design the spectrum of the atoms, their dispersive readout, as well as to extract various
properties. A fluxonium fit routine is included, to extract the circuit parameters from a measured spectrum.
The transmon Hamiltonian can be set up with an arbitrary number of Josephson junction harmonics.

The package includes the celebrated quantum Rabi model to showcase the complex behavior of the dispersive shift
with increasing readout power.

The managable source code may serve as a starting point to implement more complex artificial atoms and their readout.

Created at the foot of the Black Forest in Karlsruhe, Germany.

## Quick start

To install bfqcircuits, run the following command in your terminal:

        $ pip install bfqcircuits

or download the package and execute in the main directory:

        $ pip install .

In case you wish to edit the package, install it via

        $ pip install --editable .

Use it in your project:

        $ from bfqcircuits.core import fluxonium

To get started, you may have a look at the example notebooks under docs/examples.

## Documentation

The documentation for bfqcircuits is available at: https://black-forest-quantum-circuits.readthedocs.io
