qcodes-loop 0.1.3__tar.gz → 0.2.1__tar.gz

{qcodes_loop-0.1.3/src/qcodes_loop.egg-info → qcodes_loop-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: qcodes_loop
-Version: 0.1.3
+Version: 0.2.1
 Summary: Features previously in QCoDeS
 Maintainer-email: QCoDeS Core Developers <qcodes-support@microsoft.com>
 License: MIT
@@ -12,19 +12,18 @@ Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Science/Research
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3 :: Only
-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: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering
-Requires-Python: >=3.9
+Requires-Python: >=3.12
 Description-Content-Type: text/x-rst
 License-File: LICENSE
 Requires-Dist: qcodes>=0.42.0
 Requires-Dist: h5py>=3.0.0
 Requires-Dist: lazy_loader>=0.1
 Requires-Dist: matplotlib>=3.3.0
-Requires-Dist: numpy>=1.21.0
+Requires-Dist: numpy<2.5.0,>=1.21.0
 Requires-Dist: pandas>=1.0.0
 Requires-Dist: versioningit>=2.2.1
 Requires-Dist: xarray>=0.18.0
@@ -42,19 +41,20 @@ Requires-Dist: hypothesis>=5.49.0; extra == "test"
 Requires-Dist: pytest>=6.1.0; extra == "test"
 Requires-Dist: pytest-xdist>=2.0.0; extra == "test"
 Requires-Dist: pytest-mock>=3.0.0; extra == "test"
-Requires-Dist: pyqtgraph>=0.11.0; extra == "test"
-Requires-Dist: PyQt5>=5.15.0; extra == "test"
+Requires-Dist: pyqtgraph>=0.13.0; extra == "test"
+Requires-Dist: pyside6>=6.8.0; extra == "test"
 Requires-Dist: slack-sdk>=3.4.2; extra == "test"
 Requires-Dist: requests; extra == "test"
 Requires-Dist: urllib3; extra == "test"
 Provides-Extra: docs
 Requires-Dist: nbsphinx>=0.8.9; extra == "docs"
-Requires-Dist: PyQt5>=5.15.0; extra == "docs"
-Requires-Dist: pyqtgraph>=0.11.0; extra == "docs"
-Requires-Dist: sphinx<9.0.0,>=4.5.0; extra == "docs"
+Requires-Dist: pyside6>=6.8.0; extra == "docs"
+Requires-Dist: pyqtgraph>=0.13.0; extra == "docs"
+Requires-Dist: sphinx<9.2.0,>=4.5.0; extra == "docs"
 Requires-Dist: slack-sdk>=3.4.2; extra == "docs"
 Requires-Dist: requests; extra == "docs"
 Requires-Dist: urllib3; extra == "docs"
+Dynamic: license-file
 
 qcodes_loop
 ===========

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/pyproject.toml

@@ -14,20 +14,19 @@ classifiers = [
     "Intended Audience :: Science/Research",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3 :: Only",
-    "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",
+    "Programming Language :: Python :: 3.14",
     "Topic :: Scientific/Engineering",
 ]
 license = {text = "MIT"}
-requires-python = ">=3.9"
+requires-python = ">=3.12"
 dependencies = [
     "qcodes>=0.42.0",
     "h5py>=3.0.0",
     "lazy_loader>=0.1",
     "matplotlib>=3.3.0",
-    "numpy>=1.21.0",
+    "numpy>=1.21.0,<2.5.0",  # 2.4 removed support for assigning non scalar values to array elements. Code needs updating for this
     "pandas>=1.0.0",
     "versioningit>=2.2.1",
     "xarray>=0.18.0",
@@ -56,17 +55,17 @@ test = [
     "pytest>=6.1.0",
     "pytest-xdist>=2.0.0",
     "pytest-mock>=3.0.0",
-    "pyqtgraph>=0.11.0", # pyqtgraph tests
-    "PyQt5>=5.15.0", # pyqtgraph tests
+    "pyqtgraph>=0.13.0", # pyqtgraph tests
+    "pyside6>=6.8.0", # pyqtgraph tests
     "slack-sdk>=3.4.2", # slack tests and typecheck
     "requests", # slack tests and typecheck
     "urllib3", # slack tests and typecheck
 ]
 docs = [
     "nbsphinx>=0.8.9",
-    "PyQt5>=5.15.0", # pyqtgraph examples
-    "pyqtgraph>=0.11.0", # pyqtgraph examples
-    "sphinx>=4.5.0,<9.0.0",
+    "pyside6>=6.8.0", # pyqtgraph examples
+    "pyqtgraph>=0.13.0", # pyqtgraph examples
+    "sphinx>=4.5.0,<9.2.0",
     "slack-sdk>=3.4.2", # slack docs
     "requests", # slack docs
     "urllib3", # slack docs
@@ -83,12 +82,6 @@ exclude_lines = [
     "if TYPE_CHECKING:",
 ]
 
-[tool.darker]
-isort = true
-
-[tool.isort]
-profile = "black"
-
 [tool.pytest.ini_options]
 minversion = "6.0"
 junit_family = "legacy"
@@ -104,6 +97,11 @@ filterwarnings = [
     "ignore:SelectableGroups dict interface is deprecated:DeprecationWarning"
 ]
 
+[tool.ruff]
+
+[tool.ruff.lint]
+
+select = ["I","UP"]
 [tool.setuptools.cmdclass]
 sdist = "versioningit.cmdclass.sdist"
 build_py = "versioningit.cmdclass.build_py"

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/setup.py

@@ -2,6 +2,7 @@
 This file only exists as a fallback for older versions of pip/setuptools
 All configuration is done in pyproject.toml
 """
+
 from setuptools import setup
 
 if __name__ == "__main__":

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/src/qcodes_loop/__init__.py

@@ -1,6 +1,7 @@
 import qcodes
 
 import qcodes_loop._version
+from qcodes_loop.sweep_values import Sweeper, SweepFixedValues, SweepValues
 
 __version__ = qcodes_loop._version.__version__
 

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/src/qcodes_loop/_version.py

@@ -9,4 +9,4 @@ def _get_version() -> str:
     return versioningit.get_version(project_dir=module_path.parent.parent)
 
 
-__version__ = "0.1.3"
+__version__ = "0.2.1"

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/src/qcodes_loop/actions.py

@@ -1,9 +1,10 @@
 """Actions, mainly to be executed in measurement Loops."""
+
 import time
 
 from qcodes.utils import is_function, thread_map
 
-_NO_SNAPSHOT = {'type': None, 'description': 'Action without snapshot'}
+_NO_SNAPSHOT = {"type": None, "description": "Action without snapshot"}
 
 
 # exception when threading is attempted used to simultaneously
@@ -16,7 +17,7 @@ def _actions_snapshot(actions, update):
     """Make a list of snapshots from a list of actions."""
     snapshot = []
     for action in actions:
-        if hasattr(action, 'snapshot'):
+        if hasattr(action, "snapshot"):
             snapshot.append(action.snapshot(update=update))
         else:
             snapshot.append(_NO_SNAPSHOT)
@@ -41,6 +42,7 @@ class Task:
         **kwargs: pass to func, after evaluation if callable
 
     """
+
     def __init__(self, func, *args, **kwargs):
         self.func = func
         self.args = args
@@ -62,7 +64,7 @@ class Task:
         Returns:
             dict: snapshot
         """
-        return {'type': 'Task', 'func': repr(self.func)}
+        return {"type": "Task", "func": repr(self.func)}
 
 
 class Wait:
@@ -80,6 +82,7 @@ class Wait:
     Raises:
         ValueError: if delay is negative
     """
+
     def __init__(self, delay):
         if not delay >= 0:
             raise ValueError(f"delay must be > 0, not {repr(delay)}")
@@ -98,7 +101,7 @@ class Wait:
         Returns:
             dict: snapshot
         """
-        return {'type': 'Wait', 'delay': self.delay}
+        return {"type": "Wait", "delay": self.delay}
 
 
 class _Measure:
@@ -107,6 +110,7 @@ class _Measure:
 
     This should not be constructed manually, only by an ActiveLoop.
     """
+
     def __init__(self, params_indices, data_set, use_threads):
         self.use_threads = use_threads and len(params_indices) > 1
         # the applicable DataSet.store function
@@ -124,7 +128,7 @@ class _Measure:
             if param._instrument:
                 paramcheck.append((param, param._instrument))
 
-            if hasattr(param, 'names'):
+            if hasattr(param, "names"):
                 part_ids = []
                 for i in range(len(param.names)):
                     param_id = data_set.action_id_map[action_indices + (i,)]
@@ -138,14 +142,16 @@ class _Measure:
 
         if self.use_threads:
             insts = [p[1] for p in paramcheck]
-            if (len(set(insts)) != len(insts)):
+            if len(set(insts)) != len(insts):
                 duplicates = [p for p in paramcheck if insts.count(p[1]) > 1]
-                raise UnsafeThreadingException('Can not use threading to '
-                                               'read '
-                                               'several things from the same '
-                                               'instrument. Specifically, you '
-                                               'asked for'
-                                               ' {}.'.format(duplicates))
+                raise UnsafeThreadingException(
+                    "Can not use threading to "
+                    "read "
+                    "several things from the same "
+                    "instrument. Specifically, you "
+                    "asked for"
+                    f" {duplicates}."
+                )
 
     def __call__(self, loop_indices, **ignore_kwargs):
         out_dict = {}
@@ -154,8 +160,7 @@ class _Measure:
         else:
             out = [g() for g in self.getters]
 
-        for param_out, param_id, composite in zip(out, self.param_ids,
-                                                  self.composite):
+        for param_out, param_id, composite in zip(out, self.param_ids, self.composite):
             if composite:
                 for val, part_id in zip(param_out, composite):
                     out_dict[part_id] = val
@@ -166,7 +171,6 @@ class _Measure:
 
 
 class _Nest:
-
     """
     Wrapper to make a callable nested ActiveLoop.
 
@@ -182,7 +186,6 @@ class _Nest:
 
 
 class BreakIf:
-
     """
     Loop action that breaks out of the loop if a condition is truthy.
 
@@ -198,8 +201,7 @@ class BreakIf:
 
     def __init__(self, condition):
         if not is_function(condition, 0):
-            raise TypeError('BreakIf condition must be a callable with '
-                            'no arguments')
+            raise TypeError("BreakIf condition must be a callable with no arguments")
         self.condition = condition
 
     def __call__(self, **ignore_kwargs):
@@ -216,7 +218,7 @@ class BreakIf:
             dict: snapshot
 
         """
-        return {'type': 'BreakIf', 'condition': repr(self.condition)}
+        return {"type": "BreakIf", "condition": repr(self.condition)}
 
 
 class _QcodesBreak(Exception):

{qcodes_loop-0.1.3 → qcodes_loop-0.2.1}/src/qcodes_loop/data/data_array.py

@@ -1,5 +1,5 @@
 import collections.abc
-from typing import TYPE_CHECKING, Any, Dict, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
 import numpy as np
 
@@ -12,8 +12,8 @@ from qcodes.utils import DelegateAttributes, full_class
 
 _LOG = logging.getLogger(__name__)
 
-class DataArray(DelegateAttributes):
 
+class DataArray(DelegateAttributes):
     """
     A container for one parameter in a measurement loop.
 
@@ -91,35 +91,46 @@ class DataArray(DelegateAttributes):
 
     # attributes of self to include in the snapshot
     SNAP_ATTRS = (
-        'array_id',
-        'name',
-        'shape',
-        'unit',
-        'label',
-        'action_indices',
-        'is_setpoint')
+        "array_id",
+        "name",
+        "shape",
+        "unit",
+        "label",
+        "action_indices",
+        "is_setpoint",
+    )
 
     # attributes of the parameter (or keys in the incoming snapshot)
     # to copy to DataArray attributes, if they aren't set some other way
-    COPY_ATTRS_FROM_INPUT = (
-        'name',
-        'label',
-        'unit')
+    COPY_ATTRS_FROM_INPUT = ("name", "label", "unit")
 
     # keys in the parameter snapshot to omit from our snapshot
     SNAP_OMIT_KEYS = (
-        'ts',
-        'value',
-        '__class__',
-        'set_arrays',
-        'shape',
-        'array_id',
-        'action_indices')
-
-    def __init__(self, parameter=None, name=None, full_name=None, label=None,
-                 snapshot=None, array_id=None, set_arrays=(), shape=None,
-                 action_indices=(), unit=None, units=None, is_setpoint=False,
-                 preset_data=None):
+        "ts",
+        "value",
+        "__class__",
+        "set_arrays",
+        "shape",
+        "array_id",
+        "action_indices",
+    )
+
+    def __init__(
+        self,
+        parameter=None,
+        name=None,
+        full_name=None,
+        label=None,
+        snapshot=None,
+        array_id=None,
+        set_arrays=(),
+        shape=None,
+        action_indices=(),
+        unit=None,
+        units=None,
+        is_setpoint=False,
+        preset_data=None,
+    ):
         self.name = name
         self.full_name = full_name or name
         self.label = label
@@ -152,25 +163,23 @@ class DataArray(DelegateAttributes):
         self._snapshot_input = {}
 
         if parameter is not None:
-            param_full_name = getattr(parameter, 'full_name', None)
+            param_full_name = getattr(parameter, "full_name", None)
             if param_full_name and not full_name:
                 self.full_name = parameter.full_name
 
-            if hasattr(parameter, 'snapshot') and not snapshot:
+            if hasattr(parameter, "snapshot") and not snapshot:
                 snapshot = parameter.snapshot()
             else:
                 # TODO: why is this in an else clause?
                 for attr in self.COPY_ATTRS_FROM_INPUT:
-                    if (hasattr(parameter, attr) and
-                            not getattr(self, attr, None)):
+                    if hasattr(parameter, attr) and not getattr(self, attr, None):
                         setattr(self, attr, getattr(parameter, attr))
 
         for key, value in snapshot.items():
             if key not in self.SNAP_OMIT_KEYS:
                 self._snapshot_input[key] = value
 
-                if (key in self.COPY_ATTRS_FROM_INPUT and
-                        not getattr(self, key, None)):
+                if key in self.COPY_ATTRS_FROM_INPUT and not getattr(self, key, None):
                     setattr(self, key, value)
 
         if not self.label:
@@ -193,10 +202,12 @@ class DataArray(DelegateAttributes):
 
     @data_set.setter
     def data_set(self, new_data_set):
-        if (self._data_set is not None and
-                new_data_set is not None and
-                self._data_set != new_data_set):
-            raise RuntimeError('A DataArray can only be part of one DataSet')
+        if (
+            self._data_set is not None
+            and new_data_set is not None
+            and self._data_set != new_data_set
+        ):
+            raise RuntimeError("A DataArray can only be part of one DataSet")
         self._data_set = new_data_set
 
     def nest(self, size, action_index=None, set_array=None):
@@ -225,20 +236,21 @@ class DataArray(DelegateAttributes):
                 chained method calls.
         """
         if self.ndarray is not None and not self._preset:
-            raise RuntimeError('Only preset arrays can be nested after data '
-                               'is initialized! {}'.format(self))
+            raise RuntimeError(
+                f"Only preset arrays can be nested after data is initialized! {self}"
+            )
 
         if set_array is None:
             if self.set_arrays:
-                raise TypeError('a setpoint array must be its own inner loop')
+                raise TypeError("a setpoint array must be its own inner loop")
             set_array = self
 
-        self.shape = (size, ) + self.shape
+        self.shape = (size,) + self.shape
 
         if action_index is not None:
-            self.action_indices = (action_index, ) + self.action_indices
+            self.action_indices = (action_index,) + self.action_indices
 
-        self.set_arrays = (set_array, ) + self.set_arrays
+        self.set_arrays = (set_array,) + self.set_arrays
 
         if self._preset:
             inner_data = self.ndarray
@@ -289,9 +301,12 @@ class DataArray(DelegateAttributes):
             if self.shape is None:
                 self.shape = data.shape
             elif data.shape != self.shape:
-                raise ValueError('preset data must be a sequence '
-                                 'with shape matching the array shape',
-                                 data.shape, self.shape)
+                raise ValueError(
+                    "preset data must be a sequence "
+                    "with shape matching the array shape",
+                    data.shape,
+                    self.shape,
+                )
             self.ndarray = data
             self._preset = True
 
@@ -300,8 +315,10 @@ class DataArray(DelegateAttributes):
 
         elif self.ndarray is not None:
             if self.ndarray.shape != self.shape:
-                raise ValueError('data has already been initialized, '
-                                 'but its shape doesn\'t match self.shape')
+                raise ValueError(
+                    "data has already been initialized, "
+                    "but its shape doesn't match self.shape"
+                )
             return
         else:
             self.ndarray = np.ndarray(self.shape)
@@ -319,7 +336,7 @@ class DataArray(DelegateAttributes):
         # what people want anyway.
         if self.ndarray.dtype != float:
             self.ndarray = self.ndarray.astype(float)
-        self.ndarray.fill(float('nan'))
+        self.ndarray.fill(float("nan"))
 
     def __setitem__(self, loop_indices, value):
         """
@@ -342,8 +359,7 @@ class DataArray(DelegateAttributes):
             if isinstance(index, slice):
                 start, stop, step = index.indices(self.shape[i])
                 min_indices[i] = start
-                max_indices[i] = start + (
-                    ((stop - start - 1)//step) * step)
+                max_indices[i] = start + (((stop - start - 1) // step) * step)
 
         min_li = self.flat_index(min_indices, self._min_indices)
         max_li = self.flat_index(max_indices, self._max_indices)
@@ -354,7 +370,7 @@ class DataArray(DelegateAttributes):
     def __getitem__(self, loop_indices):
         return self.ndarray[loop_indices]
 
-    delegate_attr_objects = ['ndarray']
+    delegate_attr_objects = ["ndarray"]
 
     def __len__(self):
         """
@@ -385,13 +401,15 @@ class DataArray(DelegateAttributes):
             int: the resulting flat index.
         """
         if len(indices) < len(self.shape):
-            indices = indices + index_fill[len(indices):]
+            indices = indices + index_fill[len(indices) :]
         return np.ravel_multi_index(tuple(zip(indices)), self.shape)[0]
 
     def _update_modified_range(self, low, high):
         if self.modified_range:
-            self.modified_range = (min(self.modified_range[0], low),
-                                   max(self.modified_range[1], high))
+            self.modified_range = (
+                min(self.modified_range[0], low),
+                max(self.modified_range[1], high),
+            )
         else:
             self.modified_range = (low, high)
 
@@ -410,9 +428,10 @@ class DataArray(DelegateAttributes):
             if last_saved_index >= self.modified_range[1]:
                 self.modified_range = None
             else:
-                self.modified_range = (max(self.modified_range[0],
-                                           last_saved_index + 1),
-                                       self.modified_range[1])
+                self.modified_range = (
+                    max(self.modified_range[0], last_saved_index + 1),
+                    self.modified_range[1],
+                )
         self.last_saved_index = last_saved_index
 
     def clear_save(self):
@@ -438,7 +457,7 @@ class DataArray(DelegateAttributes):
             int: the last flat index which has been synced from the server,
                 or -1 if no data has been synced.
         """
-        if not hasattr(self, 'synced_index'):
+        if not hasattr(self, "synced_index"):
             self.init_data()
             self.synced_index = -1
 
@@ -471,11 +490,7 @@ class DataArray(DelegateAttributes):
         ]
 
         if vals:
-            return {
-                'start': synced_index + 1,
-                'stop': latest_index,
-                'vals': vals
-            }
+            return {"start": synced_index + 1, "stop": latest_index, "vals": vals}
 
     def apply_changes(self, start, stop, vals):
         """
@@ -497,14 +512,17 @@ class DataArray(DelegateAttributes):
         self.synced_index = stop
 
     def __repr__(self):
-        array_id_or_none = f' {self.array_id}' if self.array_id else ''
-        return '{}[{}]:{}\n{}'.format(self.__class__.__name__,
-                                      ','.join(map(str, self.shape)),
-                                      array_id_or_none, repr(self.ndarray))
+        array_id_or_none = f" {self.array_id}" if self.array_id else ""
+        return "{}[{}]:{}\n{}".format(
+            self.__class__.__name__,
+            ",".join(map(str, self.shape)),
+            array_id_or_none,
+            repr(self.ndarray),
+        )
 
     def snapshot(self, update=False):
         """JSON representation of this DataArray."""
-        snap = {'__class__': full_class(self)}
+        snap = {"__class__": full_class(self)}
 
         snap.update(self._snapshot_input)
 
@@ -531,25 +549,26 @@ class DataArray(DelegateAttributes):
             last_index = max(last_index, self.last_saved_index)
         if self.modified_range is not None:
             last_index = max(last_index, self.modified_range[1])
-        if getattr(self, 'synced_index', None) is not None:
+        if getattr(self, "synced_index", None) is not None:
             last_index = max(last_index, self.synced_index)
 
         return (last_index + 1) / self.ndarray.size
 
     def to_xarray(self) -> "xr.DataArray":
-        """ Return this DataArray as an xarray dataarray
+        """Return this DataArray as an xarray dataarray
 
         Returns:
             DataArray in xarray format
         """
         import xarray as xr
+
         xarray_dictionary = data_array_to_xarray_dictionary(self)
         xarray_dataarray = xr.DataArray.from_dict(xarray_dictionary)
         return xarray_dataarray
 
     @classmethod
     def from_xarray(
-        cls, xarray_dataarray: "xr.DataArray", array_id: Optional[str] = None
+        cls, xarray_dataarray: "xr.DataArray", array_id: str | None = None
     ) -> "DataArray":
         """Create a DataArray from an xarray DataArray
 
@@ -560,12 +579,14 @@ class DataArray(DelegateAttributes):
         """
         xarray_dict = xarray_dataarray.to_dict()
         if array_id is None:
-            array_id = list(xarray_dict['dims'])[0]
-        data_array = xarray_data_array_dictionary_to_data_array(array_id, xarray_dict, is_setpoint=False)
+            array_id = list(xarray_dict["dims"])[0]
+        data_array = xarray_data_array_dictionary_to_data_array(
+            array_id, xarray_dict, is_setpoint=False
+        )
         return data_array
 
 
-def data_array_to_xarray_dictionary(data_array: DataArray) -> Dict[str, Any]:
+def data_array_to_xarray_dictionary(data_array: DataArray) -> dict[str, Any]:
     """Convert DataArray to a dictionary in xarray format.
 
     Args:
@@ -576,7 +597,7 @@ def data_array_to_xarray_dictionary(data_array: DataArray) -> Dict[str, Any]:
     """
     key_mapping = {"unit": "units", "name": "name", "label": "long_name"}
 
-    data_dictionary: Dict[str, Any] = {"name": data_array.array_id}
+    data_dictionary: dict[str, Any] = {"name": data_array.array_id}
     data_dictionary["attrs"] = {
         target_key: getattr(data_array, key) for key, target_key in key_mapping.items()
     }
@@ -598,7 +619,11 @@ def data_array_to_xarray_dictionary(data_array: DataArray) -> Dict[str, Any]:
 
 
 def xarray_data_array_dictionary_to_data_array(
-        array_id: str, array_dictionary: Dict[str, Any], is_setpoint: bool = False, preset_data=None):
+    array_id: str,
+    array_dictionary: dict[str, Any],
+    is_setpoint: bool = False,
+    preset_data=None,
+):
     """Convert xarray dictionary to a DataArray
 
     This conversion is for bith the data array and the the internal xarray structure, e.g. the datavars and coords.