labscript.labscript.stop

stop(t, target_cycle_time=None, cycle_time_delay_after_programming=False)

Indicate the end of an experiment at the given time, and initiate compilation of instructions, saving them to the HDF5 file. Configures some shot options.

Parameters:

• t (float) – The end time of the experiment.

• target_cycle_time (float, optional) – default: None How long, in seconds, after the previous shot was started, should this shot be started by BLACS. This allows one to run shots at a constant rate even if they are of different durations. If None, BLACS will run the next shot immediately after the previous shot completes. Otherwise, BLACS will delay starting this shot until the cycle time has elapsed. This is a request only, and may not be met if running/programming/saving data from a shot takes long enough that it cannot be met. This functionality requires the BLACS cycle_time plugin to be enabled in labconfig. Its accuracy is also limited by software timing, requirements of exact cycle times beyond software timing should be instead done using hardware triggers to Pseudoclocks.

• cycle_time_delay_after_programming (bool, optional) – default: False Whether the BLACS cycle_time plugin should insert the required delay for the target cycle time after programming devices, as opposed to before programming them. This is more precise, but may cause some devices to output their first instruction for longer than desired, since some devices begin outputting their first instruction as soon as they are programmed rather than when they receive their first clock tick. If not set, the average cycle time will still be just as close to as requested (so long as there is adequate time available), however the time interval between the same part of the experiment from one shot to the next will not be as precise due to variations in programming time.