Extend do_nd with option to perform "Parallel sweeps"

docs/changes/newsfragments/4325.improved

@@ -0,0 +1,2 @@
+``dond`` has gained the ability to sweep multiple parameters at the same time enabling the creation of more complex
+measurements.

qcodes/dataset/__init__.py

@@ -18,7 +18,7 @@
 from .dond.do_1d import do1d
 from .dond.do_2d import do2d
 from .dond.do_nd import dond
-from .dond.sweeps import AbstractSweep, ArraySweep, LinSweep, LogSweep
+from .dond.sweeps import AbstractSweep, ArraySweep, LinSweep, LogSweep, TogetherSweep
 from .experiment_container import (
     experiments,
     load_experiment,
@@ -54,6 +54,7 @@
     "LinSweep",
     "LogSweep",
     "Measurement",
+    "TogetherSweep",
     "ParamSpec",
     "SQLiteSettings",
     "SequentialParamsCaller",

qcodes/dataset/data_set.py

@@ -310,7 +310,7 @@ def prepare(
         *,
         snapshot: Mapping[Any, Any],
         interdeps: InterDependencies_,
-        shapes: Shapes = None,
+        shapes: Shapes | None = None,
         parent_datasets: Sequence[Mapping[Any, Any]] = (),
         write_in_background: bool = False,
     ) -> None:
@@ -531,9 +531,9 @@ def toggle_debug(self) -> None:
         self.conn.close()
         self.conn = connect(path_to_db, self._debug)
 
-    def set_interdependencies(self,
-                              interdeps: InterDependencies_,
-                              shapes: Shapes = None) -> None:
+    def set_interdependencies(
+        self, interdeps: InterDependencies_, shapes: Shapes | None = None
+    ) -> None:
         """
         Set the interdependencies object (which holds all added
         parameters and their relationships) of this dataset and

qcodes/dataset/data_set_in_memory.py

@@ -398,7 +398,7 @@ def prepare(
         *,
         snapshot: Mapping[Any, Any],
         interdeps: InterDependencies_,
-        shapes: Shapes = None,
+        shapes: Shapes | None = None,
         parent_datasets: Sequence[Mapping[Any, Any]] = (),
         write_in_background: bool = False,
     ) -> None:
@@ -700,7 +700,7 @@ def _set_parent_dataset_links(self, links: list[Link]) -> None:
         self._parent_dataset_links = links
 
     def _set_interdependencies(
-        self, interdeps: InterDependencies_, shapes: Shapes = None
+        self, interdeps: InterDependencies_, shapes: Shapes | None = None
     ) -> None:
         """
         Set the interdependencies object (which holds all added

qcodes/dataset/data_set_protocol.py

@@ -85,7 +85,7 @@ def prepare(
         *,
         snapshot: Mapping[Any, Any],
         interdeps: InterDependencies_,
-        shapes: Shapes = None,
+        shapes: Shapes | None = None,
         parent_datasets: Sequence[Mapping[Any, Any]] = (),
         write_in_background: bool = False,
     ) -> None:

qcodes/dataset/descriptions/rundescriber.py

@@ -30,14 +30,14 @@ class RunDescriber:
     attributes when converting itself to dictionary.
     """
 
-    def __init__(self, interdeps: InterDependencies_,
-                 shapes: Shapes = None) -> None:
+    def __init__(
+        self, interdeps: InterDependencies_, shapes: Shapes | None = None
+    ) -> None:
 
         if not isinstance(interdeps, InterDependencies_):
             raise ValueError('The interdeps arg must be of type: '
                              'InterDependencies_. '
                              f'Got {type(interdeps)}.')
-        self._verify_interdeps_shape(interdeps, shapes)
 
         self._interdeps = interdeps
 
@@ -49,32 +49,13 @@ def version(self) -> int:
         return self._version
 
     @property
-    def shapes(self) -> Shapes:
+    def shapes(self) -> Shapes | None:
         return self._shapes
 
     @property
     def interdeps(self) -> InterDependencies_:
         return self._interdeps
 
-    @staticmethod
-    def _verify_interdeps_shape(interdeps: InterDependencies_,
-                                shapes: Shapes) -> None:
-        """
-        Verify that interdeps and shape are consistent
-        """
-        for dependent, dependencies in interdeps.dependencies.items():
-            if shapes is not None:
-                shape = shapes.get(dependent.name)
-                if shape is not None:
-                    if len(shape) < len(dependencies):
-                        raise ValueError(f"Found inconsistency between "
-                                         f"InterDependencies and shape "
-                                         f"metadata. "
-                                         f"{dependent.name} has "
-                                         f"{len(dependencies)} dependencies "
-                                         f"but it's shape "
-                                         f"is given as {shape}")
-
     def _to_dict(self) -> RunDescriberV3Dict:
         """
         Convert this object into a dictionary. This method is intended to

qcodes/dataset/descriptions/versioning/rundescribertypes.py

@@ -33,7 +33,7 @@ class InterDependencies_Dict(TypedDict):
     standalones: list[str]
 
 
-Shapes = Optional[Dict[str, Tuple[int, ...]]]
+Shapes = Dict[str, Tuple[int, ...]]
 
 
 class RunDescriberV0Dict(TypedDict):
@@ -51,7 +51,7 @@ class RunDescriberV2Dict(RunDescriberV0Dict):
 
 
 class RunDescriberV3Dict(RunDescriberV2Dict):
-    shapes: Shapes
+    shapes: Shapes | None
     # dict from dependent to dict from depenency to num points in grid
 
 

qcodes/dataset/dond/do_0d.py

@@ -69,7 +69,7 @@ def do0d(
     )
 
     try:
-        shapes: Shapes = detect_shape_of_measurement(
+        shapes: Shapes | None = detect_shape_of_measurement(
             measured_parameters,
         )
     except TypeError:

qcodes/dataset/dond/do_1d.py

@@ -114,7 +114,9 @@ def do1d(
     )
     try:
         loop_shape = (num_points,) + tuple(1 for _ in additional_setpoints)
-        shapes: Shapes = detect_shape_of_measurement(measured_parameters, loop_shape)
+        shapes: Shapes | None = detect_shape_of_measurement(
+            measured_parameters, loop_shape
+        )
     except TypeError:
         LOG.exception(
             f"Could not detect shape of {measured_parameters} "

qcodes/dataset/dond/do_2d.py

@@ -138,7 +138,9 @@ def do2d(
 
     try:
         loop_shape = (num_points1, num_points2) + tuple(1 for _ in additional_setpoints)
-        shapes: Shapes = detect_shape_of_measurement(measured_parameters, loop_shape)
+        shapes: Shapes | None = detect_shape_of_measurement(
+            measured_parameters, loop_shape
+        )
     except TypeError:
         LOG.exception(
             f"Could not detect shape of {measured_parameters} "