laboneq_applications 2.6.0__tar.gz

laboneq_applications-2.6.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

laboneq_applications-2.6.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: laboneq_applications
+Version: 2.6.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.9
+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.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing_extensions
+Requires-Dist: uncertainties==3.2.2
+Requires-Dist: laboneq~=2.52.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. 

laboneq_applications-2.6.0/README.md

@@ -0,0 +1,70 @@
+# 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. 

laboneq_applications-2.6.0/pyproject.toml

@@ -0,0 +1,233 @@
+[build-system]
+requires = ["setuptools>=65.0.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "laboneq_applications"
+description = "Library of LabOne Q experiments, analysis functions, and more."
+version = "2.6.0"
+license = { text = "Apache 2.0" }
+requires-python = ">=3.9"
+readme = "README.md"
+authors = [
+  { name = "Zurich Instruments Development Team", email = "info@zhinst.com" },
+]
+keywords = ["quantum", "sdk", "zhinst"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Science/Research",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: MacOS",
+  "Operating System :: Microsoft :: Windows",
+  "Operating System :: POSIX :: Linux",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Scientific/Engineering",
+]
+dependencies = [
+  "typing_extensions",
+  "uncertainties==3.2.2",
+  "laboneq~=2.52.0",
+  "numpy>=1.26",
+  "scipy",
+  "matplotlib",
+  "lmfit",
+  "scikit-learn~=1.5.2",
+  "qiskit",
+  "qiskit_experiments",
+]
+
+[project.urls]
+Changelog = "https://docs.zhinst.com/labone_q_user_manual/release_notes/"
+Documentation = "https://docs.zhinst.com/labone_q_user_manual/applications_library/"
+GitHub = "https://github.com/zhinst/laboneq-applications"
+
+
+[dependency-groups]
+# Libraries used during development.
+dev = [
+  "filelock",
+  "freezegun",
+  "ipython",
+  "nbmake",
+  "pytest",
+  "pytest-cov",
+  "pytest-xdist",
+  "tbump",
+]
+# Packages providing executables used during development.
+tools = [
+  "nbqa",
+  "jupytext",
+  "ruff==0.7.1", # must match the version used in .pre-commit-config.yaml
+]
+
+# Dependencies of example notebooks
+notebooks = [
+  "qcodes>=0.46.0",
+  "qiskit>=2.0.0",
+  "qiskit-experiments>=0.10.0",
+  "scikit-optimize>=0.10.2",
+]
+
+[tool.uv]
+default-groups = ["dev", "tools", "notebooks"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["laboneq_applications*"]
+namespaces = false
+
+[tool.setuptools]
+zip-safe = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.ruff]
+include = ["pyproject.toml", "src/**/*.py", "tests/**/*.py", "ci/**/*.py"]
+target-version = "py39"
+
+lint.select = ["ALL"]
+lint.ignore = [
+  # Type annotation for self
+  "ANN101",
+  # Missing trailing comma (interferes with ruff format)
+  "COM812",
+  # Implicitly concatenate strings on same line (interferes with ruff format)
+  "ISC001",
+  # Missing docstring in `__init__`
+  "D107",
+  # Missing type annotation for `cls` in classmethod
+  "ANN102",
+  # Missing docstring in magic method
+  "D105",
+  # Missing type annotation for `*args`
+  "ANN002",
+  # Missing type annotation for `**kwargs`
+  "ANN003",
+  # Too many return statements
+  "PLR0911",
+  # Missing return type annotation for special method
+  "ANN204",
+  # Boolean positional parameters in call
+  "FBT003",
+  # Line contains TODO, consider resolving the issue
+  "FIX",
+  # TODO comments
+  "TD",
+  # Unused function arguments (function signatures are sometimes a fixed API)
+  "ARG001",
+  # Multiple with statements (in the LabOne Q DSL, with statements specify
+  # program structure)
+  "SIM117",
+  # Static join to f-string (f-strings don't provide a nice way to write
+  # multiline strings)
+  "FLY002",
+  # Strings in exception class instantiation
+  "EM101",
+  "EM102",
+  "TRY003",
+  # Private class member access (rule raises false positives)
+  "SLF001",
+  # Pandas .values (rule raises false positivies even when pandas is not used)
+  "PD011",
+  # Use of built-in open (pathlib is not more readable in this case)
+  "PTH123",
+  # Use of return inside try (there is no consistent rule that fits all uses here)
+  "TRY300",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Testing checks
+"tests/*" = [
+  # Magic values
+  "PLR2004",
+  # Assertions
+  "S101",
+  # Annotations
+  "ANN",
+  # Docstrings
+  "D",
+  # Pytest raises Exception
+  "PT011",
+  # part of an implicit namespace package
+  "INP001",
+]
+# CI tool checks
+"ci/*" = [
+  # part of an implicit namespace package
+  "INP001",
+]
+# Documentation notebooks conftest
+"docs/conftest.py" = [
+  # Missing __init__.py (notebooks don't have packages)
+  "INP001",
+]
+# Documentation notebooks (nbqa converts notebooks to .py)
+"docs/sources/**/*.py" = [
+  # Annotations
+  "ANN",
+  # Missing __init__.py (notebooks don't have packages)
+  "INP001",
+  # Allow undocumented modules
+  "D100",
+  # Allow undocumented classes
+  "D101",
+  # Allow undocumented functions
+  "D103",
+  # Allow module-level imports that aren't at the top of the file
+  "E402",
+  # Allow commented out code which is often useful for explaining
+  "ERA001",
+  # Allow star imports
+  "F403",
+  # Allow undefined names because star imports are allowed
+  "F405",
+  # Allow redefining values
+  "F811",
+  # Pointless comparisons can display values in notebooks
+  "B015",
+  # Useless attribute access can display values in notebooks
+  "B018",
+  # Allow boolean positional parameters with defaults.
+  "FBT002",
+  # Magic values are sometimes fine in examples
+  "PLR2004",
+  # Print statements can be useful in notebooks
+  "T201",
+  # Ignore line length
+  "E501",
+  # Ignore forced list comprehension
+  "PERF401",
+  # Ignore CamelCase acronym import error
+  "N817",
+  # Ignore legacy randint
+  "NPY002",
+  # Ignore logging f-string error
+  "G004",
+  # Allow unnecessary assignment before return
+  "RET504",
+  # Allow unnecessary else after return
+  "RET505",
+  # Allow more than 10 arguments in function definition
+  "PLR0913",
+  # Allow unnecessary list comprehension
+  "C416",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["laboneq_applications"]
+forced-separate = ["tests"]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.pylint]
+max-args = 10

laboneq_applications-2.6.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

laboneq_applications-2.6.0/src/laboneq_applications/__init__.py

@@ -0,0 +1,6 @@
+# Copyright 2024 Zurich Instruments AG
+# SPDX-License-Identifier: Apache-2.0
+
+"""LabOne Q Applications Library."""
+
+__version__ = "2.6.0"

laboneq_applications-2.6.0/src/laboneq_applications/analysis/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2024 Zurich Instruments AG
+# SPDX-License-Identifier: Apache-2.0
+
+"""A collection of analyses for transmon-qubit experiments."""