Metadata-Version: 2.4
Name: laboneq_applications
Version: 2.11.0
Summary: Library of LabOne Q experiments, analysis functions, and more.
Author-email: Zurich Instruments Development Team <info@zhinst.com>
License: Apache 2.0
Project-URL: Changelog, https://docs.zhinst.com/labone_q_user_manual/release_notes/
Project-URL: Documentation, https://docs.zhinst.com/labone_q_user_manual/applications_library/
Project-URL: GitHub, https://github.com/zhinst/laboneq-applications
Keywords: quantum,sdk,zhinst
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typing_extensions
Requires-Dist: uncertainties==3.2.2
Requires-Dist: laboneq~=2.57.0
Requires-Dist: numpy>=1.26
Requires-Dist: scipy
Requires-Dist: matplotlib
Requires-Dist: lmfit
Requires-Dist: scikit-learn~=1.5.2
Requires-Dist: qiskit
Requires-Dist: qiskit_experiments
Dynamic: license-file

# LabOne Q Applications Library (laboneq-applications)

The LabOne Q Applications Library is a library of experiments and analyses for various quantum computing applications, implemented using the 
Zurich Instruments [LabOne Q](https://github.com/zhinst/laboneq) software framework.

---
**Documentation**: [Documentation](https://docs.zhinst.com/labone_q_user_manual/index.html)

---

## Contents of the Applications Library

The Applications Library currently contains the following:

### Quantum Elements

- Tunable Transmon qubits 
- Travelling-Wave Parametric Amplifiers (TWPAs)

### Quantum Operations

- common operations for Tunable Transmon Qubits, such as `measure`, `acquire`, `rx`, `ry`, `rz`, etc.
- common operations for TWPAs: `twpa_measure`, `twpa_acquire`, `set_pump_power`, `set_pump_cancellation`, etc. 

### Pre-Built Experiments and Analyses 

Single-qubit gate calibration for transmons:

- Resonator Spectroscopy
- Qubit Spectroscopy
- Amplitude Rabi
- Ramsey Interferometry 
- DRAG Quadrature-Scaling calibration
- Lifetime measurement
- Hahn echo
- Amplitude Fine

Read-out calibration for transmons:

- Dispersive Shift
- Single-Short Read-Out Characterization (IQ Blobs)
- Raw Time Traces for Optimal Readout Weights

Basic TWPA calibration using the Zurich Instruments SHF-PPC:

- TWPA-Pump Cancellation Tone Calibration
- Gain Curve Measurement
- TWPA Spectroscopy Measurement

## How to Install and Use

The LabOne Q Applications Library depends on the Zurich Instruments' [LabOne Q](https://github.com/zhinst/laboneq) software framework.

You can install it using:

```
pip install laboneq-applications
```

## How to contribute

You can either clone or fork the `laboneq-applications` repository and use it as the working directory for your quantum experiments.

```
git clone https://github.com/zhinst/laboneq-applications.git
cd laboneq-applications
pip install -e .
```

See the [contributions guidelines](CONTRIBUTING.md) for more information. 
