quantify 0.0.0a0__tar.gz

quantify-0.0.0a0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2020-2023, The Quantify consortium.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

quantify-0.0.0a0/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.4
+Name: quantify
+Version: 0.0.0a0
+Summary: A framework for controlling quantum computing and solid-state physics experiments.
+Maintainer-email: Robert Sokolewicz <rsokolewicz@qblox.com>, Olga Lebiga <olga@orangeqs.com>, Gabor Oszkar Denes <viacheslav@orangeqs.com>, Amirtha Varshiny Arumugam <amirthavarshiny@orangeqs.com>, Gabriel Chatelain <gabriel@orangeqs.com>
+License: BSD-3-Clause
+Project-URL: Website, https://quantify-os.org
+Project-URL: Source, https://gitlab.com/quantify-os/quantify
+Project-URL: Issue tracker, https://gitlab.com/quantify-os/quantify/-/issues
+Project-URL: Slack, https://join.slack.com/t/quantify-hq/shared_invite/zt-1nd78r4e9-rbWdna53cW4DO_YbtMhVuA
+Keywords: quantum,quantify
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: adaptive
+Requires-Dist: appnope
+Requires-Dist: columnar
+Requires-Dist: dataclasses-json
+Requires-Dist: dill
+Requires-Dist: fastjsonschema
+Requires-Dist: filelock
+Requires-Dist: h5netcdf
+Requires-Dist: jinja2>=3.1.2
+Requires-Dist: jsonschema
+Requires-Dist: lmfit>=1.0.3
+Requires-Dist: matplotlib!=3.5.0
+Requires-Dist: methodtools
+Requires-Dist: networkx
+Requires-Dist: numpy!=1.19.4
+Requires-Dist: pandas[output_formatting]
+Requires-Dist: pathvalidate
+Requires-Dist: plotly
+Requires-Dist: pre-commit
+Requires-Dist: pre-commit-hooks
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyqt5>5.15.2
+Requires-Dist: pyqtgraph
+Requires-Dist: pyright
+Requires-Dist: qcodes>=0.37.0
+Requires-Dist: qcodes-loop
+Requires-Dist: rich[jupyter]
+Requires-Dist: scikit-learn
+Requires-Dist: scipy!=1.6.0,>=1.5.0
+Requires-Dist: typing-extensions
+Requires-Dist: uncertainties
+Requires-Dist: xarray>=0.19.0
+Requires-Dist: xxhash
+Requires-Dist: lmfit>=1.3.3
+Dynamic: license-file
+
+# Quantify
+
+![Quantify logo](https://orangeqs.com/logos/QUANTIFY_LANDSCAPE.svg)
+
+Quantify is a Python-based data acquisition framework focused on Quantum Computing and
+solid-state physics experiments.
+Currently it is a metapackage for [quantify-core](https://pypi.org/project/quantify-core/)
+([git repo](https://gitlab.com/quantify-os/quantify-core/))
+and [quantify-scheduler](https://pypi.org/project/quantify-scheduler/)
+([git repo](https://gitlab.com/quantify-os/quantify-scheduler/)).
+They are built on top of [QCoDeS](https://qcodes.github.io/Qcodes/) and are a spiritual
+successor of [PycQED](https://github.com/DiCarloLab-Delft/PycQED_py3).
+
+Take a look at the latest documentation for
+[quantify-core](https://quantify-quantify-core.readthedocs-hosted.com/) and
+[quantify-scheduler](https://quantify-quantify-scheduler.readthedocs-hosted.com/)
+for the usage instructions.
+
+## Overview and Community
+
+For a general overview of Quantify and connecting to its open-source community,
+see [quantify-os.org](https://quantify-os.org/).
+Quantify is maintained by the Quantify Consortium consisting of Qblox and
+Orange Quantum Systems.
+
+[<img src="https://cdn.sanity.io/images/ostxzp7d/production/f9ab429fc72aea1b31c4b2c7fab5e378b67d75c3-132x31.svg" alt="Qblox logo" width=200px/>](https://qblox.com)
+&nbsp;
+&nbsp;
+&nbsp;
+&nbsp;
+[<img src="https://orangeqs.com/OQS_logo_with_text.svg" alt="Orange Quantum Systems logo" width=200px/>](https://orangeqs.com)
+
+&nbsp;
+
+The software is licensed under a [BSD 3-clause license](https://gitlab.com/quantify-os/quantify/-/raw/main/LICENSE).

quantify-0.0.0a0/README.md

@@ -0,0 +1,35 @@
+# Quantify
+
+![Quantify logo](https://orangeqs.com/logos/QUANTIFY_LANDSCAPE.svg)
+
+Quantify is a Python-based data acquisition framework focused on Quantum Computing and
+solid-state physics experiments.
+Currently it is a metapackage for [quantify-core](https://pypi.org/project/quantify-core/)
+([git repo](https://gitlab.com/quantify-os/quantify-core/))
+and [quantify-scheduler](https://pypi.org/project/quantify-scheduler/)
+([git repo](https://gitlab.com/quantify-os/quantify-scheduler/)).
+They are built on top of [QCoDeS](https://qcodes.github.io/Qcodes/) and are a spiritual
+successor of [PycQED](https://github.com/DiCarloLab-Delft/PycQED_py3).
+
+Take a look at the latest documentation for
+[quantify-core](https://quantify-quantify-core.readthedocs-hosted.com/) and
+[quantify-scheduler](https://quantify-quantify-scheduler.readthedocs-hosted.com/)
+for the usage instructions.
+
+## Overview and Community
+
+For a general overview of Quantify and connecting to its open-source community,
+see [quantify-os.org](https://quantify-os.org/).
+Quantify is maintained by the Quantify Consortium consisting of Qblox and
+Orange Quantum Systems.
+
+[<img src="https://cdn.sanity.io/images/ostxzp7d/production/f9ab429fc72aea1b31c4b2c7fab5e378b67d75c3-132x31.svg" alt="Qblox logo" width=200px/>](https://qblox.com)
+&nbsp;
+&nbsp;
+&nbsp;
+&nbsp;
+[<img src="https://orangeqs.com/OQS_logo_with_text.svg" alt="Orange Quantum Systems logo" width=200px/>](https://orangeqs.com)
+
+&nbsp;
+
+The software is licensed under a [BSD 3-clause license](https://gitlab.com/quantify-os/quantify/-/raw/main/LICENSE).

quantify-0.0.0a0/pyproject.toml

@@ -0,0 +1,170 @@
+[build-system]
+requires = ["setuptools>=66.1"]
+build-backend = 'setuptools.build_meta'
+
+[project]
+name = "quantify"
+description="""\
+A framework for controlling quantum computing and solid-state physics experiments.\
+"""
+maintainers = [
+    {name = "Robert Sokolewicz", email = "rsokolewicz@qblox.com"},
+    {name = "Olga Lebiga", email = "olga@orangeqs.com"},
+    {name = "Gabor Oszkar Denes", email = "viacheslav@orangeqs.com"},
+    {name = "Amirtha Varshiny Arumugam", email = "amirthavarshiny@orangeqs.com"},
+    {name = "Gabriel Chatelain", email = "gabriel@orangeqs.com"},
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: BSD License",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+]
+keywords = [
+    "quantum",
+    "quantify",
+]
+license = { text = "BSD-3-Clause" }
+version = "0.0.0.a0"
+dynamic = ["readme"]
+
+dependencies = [
+    "adaptive",
+    "appnope",
+    "columnar",
+    "dataclasses-json",
+    "dill",  # Tests fail without dill installed, likely for a good reason
+    "fastjsonschema",
+    "filelock",
+    "h5netcdf",
+    "jinja2>=3.1.2", # pandas requires version 3.1.2 or newer
+    "jsonschema",
+    "lmfit >=1.0.3", # Bugfix for lmfit (https://github.com/lmfit/lmfit-py/pull/758)
+    "matplotlib !=3.5.0",
+    "methodtools",  # used in base_analysis for self-bound lru_cache
+    "networkx",
+    "numpy!=1.19.4",
+    "pandas[output_formatting]",
+    "pathvalidate",
+    "plotly",
+    "pre-commit",
+    "pre-commit-hooks",
+    "pydantic>=2.0",
+    "pyqt5 >5.15.2",  # 5.15.2 has known bug, #170, https://bugreports.qt.io/browse/PYSIDE-1473
+    "pyqtgraph",
+    "pyright",
+    "qcodes >=0.37.0", # 0.37.0 replaces deprecated pyqtgraph functionality
+    "qcodes-loop",
+    "rich[jupyter]",
+    "scikit-learn",
+    "scipy >=1.5.0, !=1.6.0",
+    "typing-extensions",  # Independency from python version for "new" typing features
+    "uncertainties",
+    "xarray >=0.19.0",
+    "xxhash",
+    "lmfit>=1.3.3"
+]
+
+
+[project.urls]
+"Website" = "https://quantify-os.org"
+"Source" = "https://gitlab.com/quantify-os/quantify"
+"Issue tracker" = "https://gitlab.com/quantify-os/quantify/-/issues"
+"Slack" = "https://join.slack.com/t/quantify-hq/shared_invite/zt-1nd78r4e9-rbWdna53cW4DO_YbtMhVuA"
+
+[tool.setuptools.packages.find]
+include = ["quantify", "quantify.*"]
+
+[tool.setuptools.dynamic]
+readme = { file = ["README.md"], content-type = "text/markdown" }
+
+[tool.ruff]
+line-length = 88
+lint.select = [
+    "F",  # pyflakes
+    "E",  # pycodestyle
+    "W",  # pycodestyle
+    "D",  # pydocstyle
+    "I",  # isort
+    "N",  # flake8-naming
+    "UP", # pyupgrade
+    "TID",  # flake8-tidy-imports
+    "SIM",  # flake8-simplify
+    "TCH",  # flake8-type-checking
+    "Q", #flake8-quotes
+    "ARG", #flake8-unused-arguments
+    "ANN",  # flake8-annotations
+    #Pylint (PLC, PLE, PLR, PLW)
+    "PLC",
+    "PLE",
+    "PLR",
+    "PLW",
+]
+extend-exclude = [
+    "setup.py",
+    "quantify/_version.py",
+    "quantify/_static_version.py",
+]
+
+# ignore these rules for all files:
+lint.ignore = [
+            # 1 blank line required before class docstring
+            "D203",
+            # Multi-line docstring summary should start at the first line
+            "D212",
+            # Ambiguous variable name
+            "E741",
+            # Variable `...` in function should be lowercase
+            "N806",
+            # Too many arguments to function call (.../5)
+            "PLR0913",
+            # Class attribute `compile` is shadowing a python builtin
+            "A003",
+            # Missing type annotation for `self` in method
+            "ANN101",
+            # Magic value used in comparison, consider replacing `...` with a constant variable
+            "PLR2004",
+            # First line of docstring should be in imperative mood
+            "D401",
+            # 1 blank line required between summary line and description
+            "D205",
+            # Multi-line docstring summary should start at the second line (conflicts with black)
+            "D213",
+            # Missing type annotation for `**kwargs`
+            "ANN003",
+            # Missing type annotation for `*args`
+            "ANN002",
+            # No blank lines allowed before class docstring (conflicts with black)
+            "D211",
+            # Functions or methods that have more than 12 branches
+            "PLR0912"
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["quantify", "quantify_core", "quantify_scheduler"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["D", "ANN"]
+
+# - E402: Module level import not at top of file
+"docs/conf.py" = ["E402"]
+
+[tool.pyright]
+pythonVersion = "3.12"
+exclude = [
+    "tests",
+    "docs",
+    "build",
+    "conftest.py",
+    "quantify/_static_version.py",
+    "quantify/_version.py",
+    "quantify/__init__.py",
+    "quantify/visualization/mpl_plotting.py",
+    "quantify/visualization/SI_utilities.py",
+    "quantify/operations/pulse_library.py",
+    "quantify/measurement/control.py",
+
+]

quantify-0.0.0a0/quantify/__init__.py

@@ -0,0 +1,78 @@
+# Repository: https://gitlab.com/quantify-os/quantify
+# Licensed according to the LICENSE file on the main branch
+"""
+Data acquisition framework focused on Quantum Computing and solid-state physics
+experiments.
+
+.. list-table::
+    :header-rows: 1
+    :widths: auto
+
+    * - Import alias
+      - Target
+    * - :class:`.QuantumDevice`
+      - :class:`!quantify.QuantumDevice`
+    * - :class:`.Schedule`
+      - :class:`!quantify.Schedule`
+    * - :class:`.Resource`
+      - :class:`!quantify.Resource`
+    * - :class:`.ClockResource`
+      - :class:`!quantify.ClockResource`
+    * - :class:`.BasebandClockResource`
+      - :class:`!quantify.BasebandClockResource`
+    * - :class:`.DigitalClockResource`
+      - :class:`!quantify.DigitalClockResource`
+    * - :class:`.Operation`
+      - :class:`!quantify.Operation`
+    * - :obj:`.structure`
+      - :obj:`!quantify.structure`
+    * - :class:`.BasicTransmonElement`
+      - :class:`!quantify.BasicTransmonElement`
+    * - :class:`.CompositeSquareEdge`
+      - :class:`!quantify.CompositeSquareEdge`
+    * - :class:`.InstrumentCoordinator`
+      - :class:`!quantify.InstrumentCoordinator`
+    * - :class:`.GenericInstrumentCoordinatorComponent`
+      - :class:`!quantify.GenericInstrumentCoordinatorComponent`
+    * - :class:`.SerialCompiler`
+      - :class:`!quantify.SerialCompiler`
+    * - :class:`.MockLocalOscillator`
+      - :class:`!quantify.MockLocalOscillator`
+"""
+
+from quantify import structure, waveforms
+from quantify._version import __version__
+from quantify.backends import SerialCompiler
+from quantify.device_under_test import (
+    BasicTransmonElement,
+    QuantumDevice,
+)
+from quantify.instrument_coordinator.components.generic import (
+    GenericInstrumentCoordinatorComponent,
+)
+from quantify.instrument_coordinator.instrument_coordinator import InstrumentCoordinator
+from quantify.operations import Operation
+from quantify.resources import (
+    BasebandClockResource,
+    ClockResource,
+    DigitalClockResource,
+    Resource,
+)
+from quantify.schedules import Schedule
+
+__all__ = [
+    "structure",
+    "__version__",
+    "SerialCompiler",
+    "BasicTransmonElement",
+    "QuantumDevice",
+    "InstrumentCoordinator",
+    "GenericInstrumentCoordinatorComponent",
+    "Operation",
+    "BasebandClockResource",
+    "ClockResource",
+    "DigitalClockResource",
+    "Resource",
+    "Schedule",
+    "waveforms",
+]

quantify-0.0.0a0/quantify/_static_version.py

@@ -0,0 +1,2 @@
+# This file has been created by setup.py.
+version = 'unknown+g05f5352.dirty'

quantify-0.0.0a0/quantify/_version.py

@@ -0,0 +1,195 @@
+# -*- coding: utf-8 -*-
+# This file is part of 'miniver': https://github.com/jbweston/miniver
+#
+from collections import namedtuple
+import os
+
+Version = namedtuple("Version", ("release", "dev", "labels"))
+
+# No public API
+__all__ = []
+
+package_root = os.path.dirname(os.path.realpath(__file__))
+package_name = os.path.basename(package_root)
+
+STATIC_VERSION_FILE = "_static_version.py"
+
+
+def get_version(version_file=STATIC_VERSION_FILE):
+    version_info = get_static_version_info(version_file)
+    version = version_info["version"]
+    if version == "__use_git__":
+        version = get_version_from_git()
+        if not version:
+            version = get_version_from_git_archive(version_info)
+        if not version:
+            version = Version("unknown", None, None)
+        return pep440_format(version)
+    else:
+        return version
+
+
+def get_static_version_info(version_file=STATIC_VERSION_FILE):
+    version_info = {}
+    with open(os.path.join(package_root, version_file), "rb") as f:
+        exec(f.read(), {}, version_info)
+    return version_info
+
+
+def version_is_from_git(version_file=STATIC_VERSION_FILE):
+    return get_static_version_info(version_file)["version"] == "__use_git__"
+
+
+def pep440_format(version_info):
+    release, dev, labels = version_info
+
+    version_parts = [release]
+    if dev:
+        if release.endswith("-dev") or release.endswith(".dev"):
+            version_parts.append(dev)
+        else:  # prefer PEP440 over strict adhesion to semver
+            version_parts.append(".dev{}".format(dev))
+
+    if labels:
+        version_parts.append("+")
+        version_parts.append(".".join(labels))
+
+    return "".join(version_parts)
+
+
+def get_version_from_git():
+    import subprocess
+
+    # git describe --first-parent does not take into account tags from branches
+    # that were merged-in. The '--long' flag gets us the 'dev' version and
+    # git hash, '--always' returns the git hash even if there are no tags.
+    for opts in [["--first-parent"], []]:
+        try:
+            p = subprocess.Popen(
+                ["git", "describe", "--long", "--always"] + opts,
+                cwd=package_root,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+            )
+        except OSError:
+            return
+        if p.wait() == 0:
+            break
+    else:
+        return
+
+    description = (
+        p.communicate()[0]
+        .decode()
+        .strip("v")  # Tags can have a leading 'v', but the version should not
+        .rstrip("\n")
+        .rsplit("-", 2)  # Split the latest tag, commits since tag, and hash
+    )
+
+    try:
+        release, dev, git = description
+    except ValueError:  # No tags, only the git hash
+        # prepend 'g' to match with format returned by 'git describe'
+        git = "g{}".format(*description)
+        release = "unknown"
+        dev = None
+
+    labels = []
+    if dev == "0":
+        dev = None
+    else:
+        labels.append(git)
+
+    try:
+        p = subprocess.Popen(
+            ["git", "describe", "--dirty"],
+            cwd=package_root,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+        )
+    except OSError:
+        labels.append("confused")  # This should never happen.
+    else:
+        dirty_output = p.communicate()[0].decode().strip("\n")
+        if dirty_output.endswith("dirty"):
+            labels.append("dirty")
+
+    return Version(release, dev, labels)
+
+
+# TODO: change this logic when there is a git pretty-format
+#       that gives the same output as 'git describe'.
+#       Currently we can only tell the tag the current commit is
+#       pointing to, or its hash (with no version info)
+#       if it is not tagged.
+def get_version_from_git_archive(version_info):
+    try:
+        refnames = version_info["refnames"]
+        git_hash = version_info["git_hash"]
+    except KeyError:
+        # These fields are not present if we are running from an sdist.
+        # Execution should never reach here, though
+        return None
+
+    if git_hash.startswith("$Format") or refnames.startswith("$Format"):
+        # variables not expanded during 'git archive'
+        return None
+
+    VTAG = "tag: v"
+    refs = set(r.strip() for r in refnames.split(","))
+    version_tags = set(r[len(VTAG) :] for r in refs if r.startswith(VTAG))
+    if version_tags:
+        release, *_ = sorted(version_tags)  # prefer e.g. "2.0" over "2.0rc1"
+        return Version(release, dev=None, labels=None)
+    else:
+        return Version("unknown", dev=None, labels=["g{}".format(git_hash)])
+
+
+__version__ = get_version()
+
+
+# The following section defines a 'get_cmdclass' function
+# that can be used from setup.py. The '__version__' module
+# global is used (but not modified).
+
+
+def _write_version(fname):
+    # This could be a hard link, so try to delete it first.  Is there any way
+    # to do this atomically together with opening?
+    try:
+        os.remove(fname)
+    except OSError:
+        pass
+    with open(fname, "w") as f:
+        f.write(
+            "# This file has been created by setup.py.\n"
+            "version = '{}'\n".format(__version__)
+        )
+
+
+def get_cmdclass(pkg_source_path):
+    from setuptools.command.build_py import build_py as build_py_orig
+    from setuptools.command.sdist import sdist as sdist_orig
+
+    class _build_py(build_py_orig):
+        def run(self):
+            super().run()
+
+            src_marker = "".join(["src", os.path.sep])
+
+            if pkg_source_path.startswith(src_marker):
+                path = pkg_source_path[len(src_marker) :]
+            else:
+                path = pkg_source_path
+            _write_version(
+                os.path.join(self.build_lib, path, STATIC_VERSION_FILE)
+            )
+
+    class _sdist(sdist_orig):
+        def make_release_tree(self, base_dir, files):
+            super().make_release_tree(base_dir, files)
+            _write_version(
+                os.path.join(base_dir, pkg_source_path, STATIC_VERSION_FILE)
+            )
+
+    return dict(sdist=_sdist, build_py=_build_py)

quantify-0.0.0a0/quantify/analysis/__init__.py

@@ -0,0 +1,30 @@
+# Repository: https://gitlab.com/quantify-os/quantify
+# Licensed according to the LICENSE file on the main branch
+"""Quantify's analysis module."""
+
+from .base_analysis import Basic2DAnalysis, BasicAnalysis
+from .cosine_analysis import CosineAnalysis
+from .interpolation_analysis import InterpolationAnalysis2D
+from .optimization_analysis import OptimizationAnalysis
+from .single_qubit_timedomain import (
+    AllXYAnalysis,
+    EchoAnalysis,
+    RabiAnalysis,
+    RamseyAnalysis,
+    T1Analysis,
+)
+from .spectroscopy_analysis import ResonatorSpectroscopyAnalysis
+
+__all__ = [
+    "Basic2DAnalysis",
+    "BasicAnalysis",
+    "CosineAnalysis",
+    "InterpolationAnalysis2D",
+    "OptimizationAnalysis",
+    "AllXYAnalysis",
+    "EchoAnalysis",
+    "RabiAnalysis",
+    "RamseyAnalysis",
+    "T1Analysis",
+    "ResonatorSpectroscopyAnalysis",
+]