pygsti.io.readers.read_results_from_dir

read_results_from_dir(dirname, name=None, preloaded_data=None, quick_load=False, comm=None)

Load a ProtocolResults or ProtocolsResultsDir from a directory on disk.

Which object type is loaded depends on whether name is given: if it is, then a ProtocolResults object is loaded. If not, a ProtocolsResultsDir results.

Parameters:

• dirname (string) – Directory name. This should be a “base” directory, containing subdirectories like “edesign”, “data”, and “results”

• name (string or None) – The ‘name’ of a particular ProtocolResults object, which is a sub-directory beneath dirname/results/. If None, then all the results (all names) at the given base-directory are loaded and returned as a ProtocolResultsDir object.

• preloaded_data (ProtocolData, optional) – The data object belonging to the to-be-loaded results, in cases when this has been loaded already (only use this if you know what you’re doing).

• quick_load (bool, optional) – Setting this to True skips the loading of data and experiment-design components that may take a long time to load. This can be useful all the information of interest lies only within the results objects.

• comm (mpi4py.MPI.Comm, optional) – When not None, an MPI communicator used to synchronize file access.

Return type:

ProtocolResults or ProtocolResultsDir