pygsti.io.writers.write_dataset

Contents

pygsti.io.writers.write_dataset#

write_dataset(filename, dataset, circuits=None, outcome_label_order=None, fixed_column_mode='auto', with_times='auto')#

Write a text-formatted dataset file.

Parameters:

  • filename (string) – The filename to write.

  • dataset (DataSet) – The data set from which counts are obtained.

  • circuits (list of Circuits, optional) – The list of circuits to include in the written dataset. If None, all circuits are output.

  • outcome_label_order (list, optional) – A list of the outcome labels in dataset which specifies the column order in the output file.

  • fixed_column_mode (bool or 'auto', optional) – When True, a file is written with column headers indicating which outcome each column of counts corresponds to. If a row doesn’t have any counts for an outcome, ‘–’ is used in its place. When False, each row’s counts are written in an expanded form that includes the outcome labels (each “count” has the format <outcomeLabel>:<count>).

  • with_times (bool or "auto", optional) – Whether to include (save) time-stamp information in output. This can only be True when fixed_column_mode=False. “auto” will set this to True if fixed_column_mode=False and dataset has data at non-trivial (non-zero) times.

Return type:

None

Contents