Merge pull request #476 from JoelPasvolsky/mca_get_properties_update

Update multicolor annealing for updated structure of ``x_get_multicolor_annealing_exp_feature_info``

Author: JoelPasvolsky

docs/quantum_research/experimental_research.rst

@@ -542,7 +542,7 @@ needed to use multicolor annealing on your selected QPU, either through the
 
     exp_feature_info = mca.get_properties(qpu)
 
-    num_anneal_lines = len(exp_feature_info)
+    num_anneal_lines = len(exp_feature_info[1])
 
 >>> print(f"QPU {qpu.solver.name} has {num_anneal_lines} annealing lines.") # doctest: +SKIP
 QPU Advantage2_research1 has 6 annealing lines.
@@ -562,7 +562,7 @@ QPU Advantage2_research1 has 6 annealing lines.
     result = computation.result()
     exp_feature_info = result['x_get_multicolor_annealing_exp_feature_info']
 
-    num_anneal_lines = len(exp_feature_info)
+    num_anneal_lines = len(exp_feature_info[1])
 
 >>> print(f"QPU {qpu.solver.name} has {num_anneal_lines} annealing lines.") # doctest: +SKIP
 QPU Advantage2_research1 has 6 annealing lines.
@@ -594,7 +594,7 @@ repository.
     qubits_of_line = {}
 
     for q in range(num_anneal_lines):
-        qubits_of_line[q] = exp_feature_info[q]['qubits']
+        qubits_of_line[q] = exp_feature_info[1][q]['qubits']
 
     line_target = 0
     line_source = 1
@@ -658,16 +658,16 @@ schedule for the selected QPU.
 .. testcode::
     :skipif: True
 
-    Q_target_max_c = exp_feature_info[line_target]['maxC']
-    Q_target_min_c = exp_feature_info[line_target]['minC']
+    Q_target_max_c = exp_feature_info[1][line_target]['maxC']
+    Q_target_min_c = exp_feature_info[1][line_target]['minC']
 
-    Q_source_max_c = exp_feature_info[line_source]['maxC']
-    Q_source_min_c = exp_feature_info[line_source]['minC']
+    Q_source_max_c = exp_feature_info[1][line_source]['maxC']
+    Q_source_min_c = exp_feature_info[1][line_source]['minC']
 
-    Q_detector_max_c = exp_feature_info[line_detector]['maxC']
-    Q_detector_min_c = exp_feature_info[line_detector]['minC']
+    Q_detector_max_c = exp_feature_info[1][line_detector]['maxC']
+    Q_detector_min_c = exp_feature_info[1][line_detector]['minC']
 
-    min_time_step = exp_feature_info[0]["minAnnealingTimeStep"]
+    min_time_step = exp_feature_info[1][0]["minAnnealingTimeStep"]
 
 >>> print(f"Minimum time step is {min_time_step} µs")           # doctest: +SKIP
 Minimum time step is 0.01 µs
@@ -763,7 +763,7 @@ and shows a Larmor precession that corresponds to the chosen transverse energy,
         x_anneal_schedules = anneal_schedules,
         x_polarizing_schedule = polarization_schedule)
 
-    delay_sweep = np.arange(0.0, 0.02, 40*exp_feature_info[0]["scheduleDelayStep"])
+    delay_sweep = np.arange(0.0, 0.02, 40*exp_feature_info[1][0]["scheduleDelayStep"])
 
     res_plus=[]
 

docs/quantum_research/solver_properties_all.rst

@@ -854,19 +854,22 @@ and the range for the target normalized control bias :math:`c(s)` for a QPU.
 x_get_multicolor_annealing_exp_feature_info
 ===========================================
 
-Returns information about per-line anneal schedules, such as the subset of
-the QPU's qubits indexed to each line, supported minimum time steps, and ranges
+Returns information about multicolor annealing, such as the subset of the QPU's
+qubits indexed to each annealing line, supported minimum time steps, and ranges
 of normalized control bias, :math:`c(s)`, etc.
 
 .. note:: |research_property_note1|
 
     |research_property_note2|
 
 Submit a placeholder problem with this parameter set to True to return the
-information, as a Python list with a dict for each of the QPU's anneal lines,
-under the returned result's ``x_get_multicolor_annealing_exp_feature_info``
-field. (The length of the returned list is the number of anneal lines of the
-QPU.)
+information, under the returned result's
+``x_get_multicolor_annealing_exp_feature_info`` field, as a Python list
+containing a dict of values that apply across annealing lines and list of dicts,
+one for each of the QPU's annealing lines:
+``[{Shared fields}, [{Line 0 fields}, {Line 1 fields}, ...]]``.
+(The length of the returned *inner* list---i.e., the number of the dicts it
+contains---is the number of annealing lines of the QPU.)
 
 The returned information contains the following fields.
 
@@ -880,6 +883,22 @@ The returned information contains the following fields.
     *   -   Field Name
         -   Type
         -   Value
+    *   -   ``minPolarizingTimeStep``
+        -   Float
+        -   Minimum supported time step, in microseconds, for the
+            :ref:`parameter_polarizing_schedule` parameter. Values specified
+            with greater precision are rounded. This value is common to all
+            the QPU's annealing lines.
+    *   -   ``depolarizationAnneal``
+            ``ScheduleRequiredDelay``
+        -   Float
+        -   Time, in microseconds, after the
+            :ref:`parameter_polarizing_schedule` parameter changes the
+            polarization value from :math:`\pm 1` to :math:`0` for the qubits,
+            during which the :ref:`parameter_qpu_anneal_schedules` parameter
+            must not set a new value of the normalized control bias,
+            :math:`c(s)` line. This value is common to all the QPU's annealing
+            lines.
     *   -   ``annealingLine``
         -   Integer
         -   Index of the annealing line for which the other field values are
@@ -890,11 +909,6 @@ The returned information contains the following fields.
         -   Minimum supported time step, in microseconds, for the
             :ref:`parameter_qpu_anneal_schedules` parameter. Values specified
             with greater precision are rounded.
-    *   -   ``minPolarizingTimeStep``
-        -   Float
-        -   Minimum supported time step, in microseconds, for the
-            :ref:`parameter_polarizing_schedule` parameter. Values specified
-            with greater precision are rounded.
     *   -   ``holdOvershootFor``
         -   Float
         -   Maximum supported duration, in microseconds, that you can specify a
@@ -944,16 +958,6 @@ The returned information contains the following fields.
         -   Maximum supported precision, in microseconds, of the
             :ref:`parameter_qpu_schedule_delays` parameter. Values specified
             with greater precision are rounded.
-    *   -   ``depolarizationAnneal``
-            ``ScheduleRequiredDelay``
-        -   Float
-        -   Time, in microseconds, after the
-            :ref:`parameter_polarizing_schedule` parameter changes the
-            polarization value from :math:`\pm 1` to :math:`0` for the qubits of
-            an anneal line, during which the
-            :ref:`parameter_qpu_anneal_schedules` parameter must not set a new
-            value of the normalized control bias, :math:`c(s)`, on that same
-            line.
     *   -   ``qubits``
         -   Array of integers
         -   Indices of qubits controlled by the annealing line with the index
@@ -969,7 +973,7 @@ This example prints the first 5 qubits on annealing line 0.
 
     >>> from dwave.experimental import multicolor_anneal as mca
     >>> exp_feature_info = mca.get_properties()         # doctest: +SKIP
-    >>> print(exp_feature_info[0]['qubits'][:5])        # doctest: +SKIP
+    >>> print(exp_feature_info[1][0]['qubits'][:5])        # doctest: +SKIP
     [2, 5, 6, 9, 14]
 
 2.  Directly using the :ref:`property_qpu_get_multicolor_annealing_exp_feature_info`
@@ -982,5 +986,5 @@ This example prints the first 5 qubits on annealing line 0.
     ...         {next(iter(solver.nodes)): 0}, {}, x_get_multicolor_annealing_exp_feature_info=True)
     ...     result = computation.result()
     ...     exp_feature_info = result['x_get_multicolor_annealing_exp_feature_info']
-    >>> print(exp_feature_info[0]['qubits'][:5])        # doctest: +SKIP
+    >>> print(exp_feature_info[1][0]['qubits'][:5])        # doctest: +SKIP
     [2, 5, 6, 9, 14]

docs/requirements.txt

@@ -11,7 +11,7 @@ reno[sphinx]==3.3.0
 # TODO: remove the constraint once numpy 2.4.0 gets yanked
 numpy~=2.0,!=2.4.0
 
-dwave-experimental==2026.5.27
+dwave-experimental==2026.6.23
 
 # needed for some of the examples
 matplotlib