Metadata-Version: 2.5
Name: resonator-tools
Version: 2.2.0
Summary: A Python package for analyzing and fitting complex resonator scattering data.
Project-URL: Homepage, https://github.com/sebastianprobst/resonator_tools
Project-URL: Repository, https://github.com/sebastianprobst/resonator_tools
Project-URL: Issues, https://github.com/sebastianprobst/resonator_tools/issues
Author: Sebastian Probst
License-Expression: LGPL-3.0-only
License-File: LICENSE
Keywords: analysis,cQED,circle fit,circuit,fitting,measurement,microwave,quantum,qubit,resonator,superconducting
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Python: >=3.10
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.24
Requires-Dist: scipy>=1.10
Description-Content-Type: text/markdown

# resonator_tools

A small python library to fit complex resonator scattering data.
It supports transmission, reflection and notch-type measurements.

> **Scientific correction (v2.2.0):** notch (hanger) photon-number estimates from
> `notch_port.get_photons_in_resonator()`/`get_single_photon_limit()` were too high by a factor
> of 2. Reflection-mode photon numbers and all fitted resonance parameters (`fr`, `Qi`, `Qc`,
> `Ql`) are unaffected. See [docs/photon_number_derivation.md](docs/photon_number_derivation.md)
> and the [changelog](CHANGELOG.md) for the derivation and details.

## Installation

To install the module from PyPI, run:

	pip install resonator-tools

To install from a local clone of this repository, run the following command inside the project directory:

	pip install .

This will install the package from your local source instead of downloading it from PyPI.

Description of the algorithm:
http://scitation.aip.org/content/aip/journal/rsi/86/2/10.1063/1.4907935 \
(Preprint: https://arxiv.org/abs/1410.3365)

Where is it used?
The "resonator_tools" have contributed to the following publications:
https://scholar.google.de/scholar?oi=bibs&hl=de&cites=690000812747125148&as_sdt=5

Institute where research was originally conducted:
https://www.phi.kit.edu/ustinov_downloads.php

Questions? Contact the author:
https://www.linkedin.com/in/dr-sebastian-probst-9685969a/
