Changelog

Starting from Version 2.2.0, this package follows Semantic Versioning as closely as possible. This changelog adopts the Keep a Changelog format.

Version 2.5.0 – 2022-09-20

Added

  • A pulsed measurement can now be triggered internally, by a SYSREF signal, or (new) by a signal on any of the digital inputs. See method Pulsed.run.

Changed

  • Replace the sliding-window low-pass filter for Lockin introduced in 2.3.0 with a customizable 43-tap FIR filter. For the occasion, the new optional argument fir_coeffs replaces the previous nbox in methods Lockin.get_pixels and SymmetricLockin.get_pixels.

Fixed

  • Fixed an issue that could result in a DC bias not being set reliably on some units.


Version 2.4.1 – 2022-07-08

Fixed


Version 2.4.0 – 2022-06-23

Added

  • You can now choose whether a long drive is an envelope or a template. See new optional parameter envelope in Pulsed.setup_long_drive. To maintain backwards compatibility, the default setting is envelope=True. Note that this is different from Pulsed.setup_template where the default is envelope=False.

  • New interface to asynchronous measurements: Pulsed.run_async returns a MeasurementHandle that allows interaction with a running measurement.

Changed

  • Methods Lockin.get_pixels and SymmetricLockin.get_pixels now return the standard deviation as a complex number, where the real and imaginary parts encode the standard deviation of the real and imaginary parts of the demodulated signals. Taking the absolute value of the complex number results in the total standard deviation that was previously returned.

  • Many methods in Pulsed raise a RuntimeError exception if called after a measurement has already been run. The previous behavior was not supported, see the warning in the documentation for the Pulsed class.

  • The output_port argument to Pulsed.setup_long_drive now accepts a list to output the same pulse on multiple ports, much like Pulsed.setup_template already did.

Fixed

  • Fix inconsistencies in the documentation regarding maximum length of templates.

  • Improve error messages when running out of template slots.


Version 2.3.2 – 2022-06-06

Fixed


Version 2.3.1 – 2022-04-25

Fixed

  • Restore compatibility with Python 3.7+


Version 2.3.0 – 2022-04-21

Added

  • New class lockin.SymmetricLockin: a special-purpose version of Lockin with same frequencies on input and output (symmetric). The new class inherits from the previous one, so most of the Lockin functionality is available in SymmetricLockin as well.

  • New features for the lock-in: Presto can now low-pass filter the measured lock-in packets in real time with a sliding-window average, and also compute mean and standard deviation of the measured lock-in packets in real time over chunks with configurable width. Check out the summed, nbox and nsum optional parameters to Lockin.get_pixels.

  • The lock-in can output a trigger signal at the start of each integration window: Lockin.set_trigger_out.

  • utils.sin2 can now create DRAG-corrected pulses.

  • It is now possible to modify the DC bias output during a pulsed measurement sequence: Pulsed.output_dc_bias.

  • Print a warning if the signal on any of the input ports is out of range.

Changed

  • Change the way errors from the hardware are reported to the user. It should help when the API is used through third-party software, such as Labber.

  • Improve handling of NCO frequencies when the same frequency is set on multiple ports. This can avoid long-term drift, see documentation for the tune parameter in Hardware.configure_mixer

  • Increase length of command buffers: you can now send more pulses closer together! Useful for randomized benchmarking.

Fixed

  • Fix bug in Lockin.get_pixels where the data in first lock-in packet would often be corrupt.

  • The pulsed mode of operation is now more resilient to aborting measurements with Ctrl+C.


Version 2.2.1 – 2022-02-10

Fixed


Version 2.2.0 – 2022-02-09

Added

  • Method Hardware.set_dc_bias now handles the DC bias outputs on Presto hardware.

  • Check that all programmed times in a pulsed sequence are nonnegative.

  • Method Pulsed.run will now check for more inconsistencies and report errors:

    • if the programmed sequence contains overlapping stores. Overlapping stores are not supported and could cause the experimental sequence to terminate abnormally, or not terminate at all.

    • if some select_frequency or select_scale event is trying to access indexes beyond what was programmed in the look-up tables with setup_freq_lut and setup_scale_lut.

  • Method Pulsed.run can now compress some pulse sequences so that they consume fewer commands. Compression is useful when there’s a long list of small templates output in quick repetition, such as in randomized benchmarking with thousands of Cliffords. To opt in to compression, pass enable_compression=True.

Changed

  • Refactor calibration of ADC and DAC alignment. A calibration routine will be run when a new combination of Converter modes and Converter rates is requested. This will delay the start of a measurement by a few seconds, but only the first time a configuration is requested: the calibration will be stored on Vivace/Presto and will be available for all subsequent measurements without delay!

  • Method Pulsed.get_store_data returns data in real form when adc_mode=AdcMode.Direct and in complex form when adc_mode=AdcMode.Mixed (when using digital downconversion).

  • Method Pulsed.setup_template_matching_pair now accept complex-valued arguments when adc_mode=AdcMode.Mixed (when using digital downconversion).

  • Methods Pulsed.setup_long_drive and Pulsed.setup_template now accept complex-valued arguments when dac_mode=DacMode.Mixedxx (when using digital upconversion).

Fixed


Version 2.1.0 – 2021-12-01

  • Ability to choose frequency of external reference clock: see the optional argument ext_ref_clk to Pulsed and Lockin

  • Improvement to calibration routine during update.

pulsed module: presto.pulsed

  • Fix a bug that caused the experiment to terminate too early or to never terminate when running long sequences with lots of averages.

  • A single sequence (without accounting for repetitions and averages) can now run for ≈6.5 days, up from ≈8.6 seconds.

Pulsed class: presto.pulsed.Pulsed

  • Fix printing of estimated time left in a measurement when running from within some Python IDEs, e.g. Spyder.

  • Set tolerance for event times to 1% of get_clk_T, rather than fixed at 1 ps.

  • Method run:

    • Better handling of startup time for a sequence: fixes an inconsistency with requirements on the period argument.

    • Raise an error if the user runs a sequence without setting up the scale look-up table on an output port and group used by some template, or if the frequency/phase look-up table was non set up when some templates are used as envelopes.

  • The parameter output_port to setup_template can now be set to a list to more conveniently output the same pulse on multiple output ports.

  • Improve error messages when using not supported combinations of adc_mode, adc_fsample, dac_mode and dac_fsample

  • Fix error when running with dry_run set to True.

LongDrive class: presto.pulsed.LongDrive

lockin module: presto.lockin

Lockin class: presto.lockin.Lockin

  • Fix bug in tune_perfect

  • Improve error messages when using not supported combinations of adc_mode, adc_fsample, dac_mode and dac_fsample


Version 2.0.0 – 2021-05-21

This is the first major-version change since the previous Vivace API. This new API is compatible with both Vivace and Presto microwave platforms, and follows the same overall programming interface. There are, however, many differences that break backwards compatibility. See below for a summary of such changes.

hardware module: presto.hardware

New module to control configurations common to all modes of operation. Accessible as the hardware attribute of any instance of Pulsed, Lockin or Test.

pulsed module: presto.pulsed

Pulsed class: presto.pulsed.Pulsed

  • The class constructor takes 4 new optional arguments: adc_mode, adc_fsample, dac_mode and dac_fsample. These configure the Converter modes and Converter rates for the input analog-to-digital (ADC) and output digital-to-analog (DAC) converters. With these options it is possible to enable digital up- and downconversion using the built-in digital IQ mixers.

  • The methods next_frequency, next_scale, select_frequency and select_scale take a new optional argument group. If not specified, both output groups on output_ports are affected.

  • The method run (previously perform_measurement) does not return the result of store events: use get_store_data after running the experiment. To get the result of match events, use get_template_matching_data (same as before).

  • Method setup_freq_lut:

    • the old carrier argument (1 or 2) is replaced by the new group argument (0 or 1)

    • new argument phases_q must be specified when using the built-in digital IQ mixers for digital upconversion

    • the optional argument repeat_count is removed

  • Method setup_long_drive:

    • the old carrier argument (1 or 2) is replaced by the new group argument (0 or 1)

    • the optional argument use_scale is removed: all output templates are subject to the output scaler for the appropriate port and group

  • Method setup_scale_lut:

    • new mandatory argument group (0 or 1)

    • the optional argument repeat_count is removed

  • Method setup_template:

    • new mandatory argument group (0 or 1)

    • new argument template_q must be specified when using the built-in digital IQ mixers for digital upconversion

    • the optional argument use_scale is removed: all output templates are subject to the output scaler for the appropriate port and group

    • the optional argument envelope is now a boolean. To specify which signal generator to use when envelope=True, use the group argument (0 or 1)

  • New methods:

  • Deprecated methods:

    • perform_measurement: use run instead

  • Some methods are moved to the new Hardware class, which is available as the hardware attribute to any instance of Pulsed:

LongDrive class: presto.pulsed.LongDrive

Other

utils module: presto.utils

  • New function rotate_opt

  • The function untwist_downconversion now follows a different convention. The new convention is consistent with the built-in digital IQ mixers. It might or might not be consistent with the convention used by an external analog IQ mixer.

version module: presto.version

  • New attributes:

  • Removed functions:

    • get_variant_firmware

    • get_version_all

    • get_version_api

    • get_version_clock

    • get_version_firmware

    • get_version_server