pygsti.io.readers.read_results_from_mongodb

pygsti.io.readers.read_results_from_mongodb#

read_results_from_mongodb(mongodb, doc_id, preloaded_data=None, quick_load=False, comm=None)#

Load a ProtocolResults from a MongoDB database.

Parameters:
  • mongodb (pymongo.database.Database) – The MongoDB instance to load data from.

  • doc_id (str) – The user-defined identifier of the results directory to load.

  • 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 database access.

Return type:

ProtocolResults