export_to_file

DynamicDecouplingSequence.export_to_file(filename: str, file_format: str = 'Q-CTRL expanded', file_type: str = 'CSV', coordinates: str = 'cylindrical', maximum_rabi_rate: float = 6.283185307179586, maximum_detuning_rate: float = 6.283185307179586)None[source]

Prepares and saves the dynamical decoupling sequence in a file.

Parameters
  • filename (str) – Name and path of the file to save the control into.

  • file_format (str) – Specified file format for saving the control. Defaults to ‘Q-CTRL expanded’; Currently it does not support any other format. For detail of the Q-CTRL Expanded Format consult DrivenControl.export_to_file().

  • file_type (str, optional) – One of ‘CSV’ or ‘JSON’. Defaults to ‘CSV’.

  • coordinates (str, optional) – Indicates the co-ordinate system requested. Must be one of ‘cylindrical’, ‘cartesian’; defaults to ‘cylindrical’

  • maximum_rabi_rate (float, optional) – Maximum Rabi Rate; Defaults to \(2\pi\).

  • maximum_detuning_rate (float, optional) – Maximum Detuning Rate; Defaults to \(2\pi\).

Raises

ArgumentsValueError – Raised if some of the parameters are invalid.

Notes

The sequence is converted to a driven control using the maximum rabi and detuning rate. The driven control is then exported. This is done to facilitate a coherent integration with Q-CTRL BLACK OPAL’s 1-Qubit workspace.