print_readable_snapshot

static ZISnapshotHelper.print_readable_snapshot(qcodes_object: Instrument, update: bool = False, max_chars: int = 80) → None

Prints a readable version of the snapshot.

The readable snapshot includes the name, value and unit of each parameter. A convenience function to quickly get an overview of the status of an instrument.

Parameters:

• qcodes_object (object) – Object for which the snapshot should be printed.

• update (bool) – Flag if the state should be queried from the instrument.

• max_chars (int) – The maximum number of characters per line. The readable snapshot will be cropped if this value is exceeded. Defaults to 80 to be consistent with default terminal width.

Return type:

None