pyGSTi 0.9.12__cp39-cp39-win_amd64.whl → 0.9.13__cp39-cp39-win_amd64.whl

pygsti/protocols/modeltest.py

@@ -13,6 +13,7 @@ ModelTest Protocol objects
 import collections as _collections
 import warnings as _warnings
 import pathlib as _pathlib
+from typing import Optional
 from pygsti.baseobjs.profiler import DummyProfiler as _DummyProfiler
 from pygsti.objectivefns.objectivefns import ModelDatasetCircuitsStore as _ModelDatasetCircuitStore
 from pygsti.protocols.estimate import Estimate as _Estimate
@@ -23,6 +24,7 @@ from pygsti.objectivefns import objectivefns as _objfns
 from pygsti.circuits import Circuit
 from pygsti.circuits.circuitlist import CircuitList as _CircuitList
 from pygsti.baseobjs.resourceallocation import ResourceAllocation as _ResourceAllocation
+from pygsti.forwardsims import ForwardSimulator
 
 
 class ModelTest(_proto.Protocol):
@@ -98,6 +100,7 @@ class ModelTest(_proto.Protocol):
                  set_trivial_gauge_group=True, verbosity=2, name=None):
 
         from .gst import GSTBadFitOptions as _GSTBadFitOptions
+        from .gst import GSTGaugeOptSuite as _GSTGaugeOptSuite
 
         if set_trivial_gauge_group:
             model_to_test = model_to_test.copy()
@@ -107,7 +110,7 @@ class ModelTest(_proto.Protocol):
         super().__init__(name)
         self.model_to_test = model_to_test
         self.target_model = target_model
-        self.gaugeopt_suite = gaugeopt_suite
+        self.gaugeopt_suite = _GSTGaugeOptSuite.cast(gaugeopt_suite)
         self.badfit_options = _GSTBadFitOptions.cast(badfit_options)
         self.verbosity = verbosity
 
@@ -125,13 +128,8 @@ class ModelTest(_proto.Protocol):
         self.circuit_weights = None
         self.unreliable_ops = ('Gcnot', 'Gcphase', 'Gms', 'Gcn', 'Gcx', 'Gcz')
 
-    #def run_using_germs_and_fiducials(self, model, dataset, target_model, prep_fiducials,
-    #                                  meas_fiducials, germs, maxLengths):
-    #    from .gst import StandardGSTDesign as _StandardGSTDesign
-    #    design = _StandardGSTDesign(target_model, prep_fiducials, meas_fiducials, germs, maxLengths)
-    #    return self.run(_proto.ProtocolData(design, dataset))
-
-    def run(self, data, memlimit=None, comm=None, checkpoint=None, checkpoint_path=None, disable_checkpointing= False):
+    def run(self, data, memlimit=None, comm=None, checkpoint=None, checkpoint_path=None, disable_checkpointing=False,
+            simulator: Optional[ForwardSimulator.Castable]=None):
         """
         Run this protocol on `data`.
 
@@ -164,12 +162,19 @@ class ModelTest(_proto.Protocol):
             to disk during the course of this protocol. It is strongly recommended
             that this be kept set to False without good reason to disable the checkpoints.
 
+        simulator : ForwardSimulator.Castable or None
+            Ignored if None. If not None, then we call
+                fwdsim = ForwardSimulator.cast(simulator),
+            and we set the .sim attribute of every Model we encounter to fwdsim.
+
         Returns
         -------
         ModelEstimateResults
         """
         the_model = self.model_to_test
-        
+        if simulator is not None:
+            the_model.sim = simulator
+            
         target_model = self.target_model  # can be None; target model isn't necessary
 
         #Create profiler
@@ -267,11 +272,13 @@ class ModelTest(_proto.Protocol):
         models.update({('iteration %d estimate' % k): the_model for k in range(len(bulk_circuit_lists))})
         # TODO: come up with better key names? and must we have iteration_estimates?
         if target_model is not None:
+            if simulator is not None:
+                target_model.sim = simulator
             models['target'] = target_model
         ret.add_estimate(_Estimate(ret, models, parameters, extra_parameters=extra_parameters), estimate_key=self.name)
 
-        #Add some better handling for when gauge optimization is turned off (current code path isn't working.
-        if self.gaugeopt_suite is not None:
+        #Add some better handling for when gauge optimization is turned off (current code path isn't working.)
+        if not self.gaugeopt_suite.is_empty():
             ret= _add_gaugeopt_and_badfit(ret, self.name, target_model, self.gaugeopt_suite,
                                             self.unreliable_ops, self.badfit_options,
                                             None, resource_alloc, printer)
@@ -282,8 +289,8 @@ class ModelTest(_proto.Protocol):
             #and add a key for this to the goparameters dict (this is what the report
             #generation looks at to determine the names of the gauge optimized models).
             #Set the value to None as a placeholder.
-            from .gst import GSTGaugeOptSuite
             ret.estimates[self.name].goparameters['trivial_gauge_opt']= None
+        
         return ret
 
 

pygsti/protocols/protocol.py

@@ -1311,11 +1311,17 @@ class CombinedExperimentDesign(ExperimentDesign):  # for multiple designs on the
 
         if all_circuits is None:
             all_circuits = []
-            if not interleave:
+            if interleave:
+                subdesign_circuit_lists = [sub_design.all_circuits_needing_data for sub_design in sub_designs.values()]
+                #zip_longest is like zip, but if the iterables are of different lengths it returns a specified fill value
+                #(default None) in place of the missing elements once an iterable has been exhausted.
+                for circuits in _itertools.zip_longest(*subdesign_circuit_lists):
+                    for circuit in circuits:
+                        if circuit is not None:
+                            all_circuits.append(circuit)
+            else:
                 for des in sub_designs.values():
                     all_circuits.extend(des.all_circuits_needing_data)
-            else:
-                raise NotImplementedError("Interleaving not implemented yet")
             _lt.remove_duplicates_in_place(all_circuits)  # Maybe don't always do this?
 
         if qubit_labels is None and len(sub_designs) > 0:
@@ -1458,12 +1464,6 @@ class SimultaneousExperimentDesign(ExperimentDesign):
         else:
             raise ValueError("Cannot convert a %s to a %s!" % (str(type(edesign)), str(cls)))
 
-    #@classmethod
-    #def from_tensored_circuits(cls, circuits, template_edesign, qubit_labels_per_edesign):
-    #    pass #Useful??? - need to break each circuit into different parts
-    # based on qubits, then copy (?) template edesign and just replace itself
-    # all_circuits_needing_data member?
-
     def __init__(self, edesigns, tensored_circuits=None, qubit_labels=None):
         """
         Create a new SimultaneousExperimentDesign object.
@@ -1953,9 +1953,6 @@ class ProtocolData(_TreeNode, _MongoSerializable):
         """
         return isinstance(self.dataset, (_data.MultiDataSet, dict))
 
-    #def underlying_tree_paths(self):
-    #    return self.edesign.get_tree_paths()
-
     def prune_tree(self, paths, paths_are_sorted=False):
         """
         Prune the tree rooted here to include only the given paths, discarding all else.
@@ -2545,23 +2542,6 @@ class ProtocolResultsDir(_TreeNode, _MongoSerializable):
 
     2. Child :class:`ProtocolResultsDir` objects, obtained by indexing this
        object directly using the name of the sub-directory.
-
-    Parameters
-    ----------
-    data : ProtocolData
-        The data from which *all* the Results objects in this
-        ProtocolResultsDir are derived.
-
-    protocol_results : ProtocolResults, optional
-        An initial (single) results object to add.  The name of the
-        results object is used as its key within the `.for_protocol`
-        dictionary.  If None, then an empty results directory is created.
-
-    children : dict, optional
-        A dictionary of the :class:`ProtocolResultsDir` objects that are
-        sub-directories beneath this one.  If None, then children are
-        automatically created based upon the tree given by `data`.  (To
-        avoid creating any children, you can pass an empty dict here.)
     """
     collection_name = "pygsti_results_directories"
 
@@ -2681,14 +2661,6 @@ class ProtocolResultsDir(_TreeNode, _MongoSerializable):
         """
         Create a new ProtocolResultsDir object.
 
-        This container object holds two things:
-        
-        1. A `.for_protocol` dictionary of :class:`ProtocolResults` corresponding
-           to different protocols (keys are protocol names).
-
-        2. Child :class:`ProtocolResultsDir` objects, obtained by indexing this
-           object directly using the name of the sub-directory.
-
         Parameters
         ----------
         data : ProtocolData