pygsti.io.writers.write_empty_protocol_data

write_empty_protocol_data(dirname, edesign, sparse='auto', clobber_ok=False)

Write to disk an empty ProtocolData object.

Write to a directory an experimental design (edesign) and the dataset template files needed to load in a ProtocolData object, e.g. using the read_data_from_dir() function, after the template files are filled in.

Parameters:

• dirname (str) – The root directory to write into. This directory will have ‘edesign’ and ‘data’ subdirectories created beneath it.

• edesign (ExperimentDesign) – The experiment design defining the circuits that need to be performed.

• sparse (bool or "auto", optional) – If True, then the template data set(s) are written in a sparse-data format, i.e. in a format where not all the outcomes need to be given. If False, then a dense data format is used, where counts for all possible bit strings are given. “auto” causes the sparse format to be used when the number of qubits is > 2.

• clobber_ok (bool, optional) – If True, then a template dataset file will be written even if a file of the same name already exists (this may overwrite existing data with an empty template file, so be careful!).

Return type:

None