Changelog#
Starting from v2.2.0, the presto
package follows Semantic Versioning as closely as
possible. This changelog adopts the Keep a Changelog format.
Each version officially supports only versions of Python that are actively supported at
the time of release. For example, presto
v2.7.0 (released on 2023-01-18) supports Python 3.7 and
above, but it does not support Python 3.6 and below.
Version 2.10.0 – 2023-06-27#
Note
presto
v2.10.0 is the last version supporting Python 3.7, which reached end of life on
2023-06-27. Starting from next version, the presto
package will require Python 3.8 or above.
Added#
Methods to program a digital delay on output and input ports, useful for compensating delay mismatches in your experimental setup:
Hardware.set_output_delay()
andset_input_delay()
.Helper function to select optimal DAC configuration for a given signal output frequency:
utils.recommended_dac_config()
Version 2.9.0 – 2023-03-30#
Added#
Method to ramp the DC bias to a new value with a controlled rate of change:
Hardware.ramp_dc_bias()
.Optional argument
get_range
toHardware.get_dc_bias()
to also get the current range.
Fixed#
Improve handling of abrupt interruption of a measurement.
Fix error message when rebooting Presto/Vivace via
ssh_reboot()
.
Version 2.8.1 – 2023-02-14#
Changed#
Allow for a list of ports in
Pulsed.output_dc_bias()
to change DC bias during a pulsed sequence simultaneously on many ports.
Version 2.8.0 – 2023-02-03#
Added#
Method to get the DC bias currently programmed:
Hardware.get_dc_bias()
.Methods to configure multiband mode on input/output:
Hardware.set_input_multiband()
andHardware.set_output_multiband()
.
Changed#
Enable positive-only DC-bias ranges in
Hardware.set_dc_bias()
(range_i
settings 0 and 1) for higher resolution on small positive voltages.
Version 2.7.1 – 2023-01-20#
Fixed#
Fixed Python 3.7 compatibility issue in pulsed module.
Version 2.7.0 – 2023-01-18#
Added#
Multi-dimensional parameter sweeps in
pulsed
mode are now available experimentally. See newaxis
optional parameter inPulsed.setup_scale_lut()
andPulsed.setup_freq_lut()
, and new options of therepeat_count
parameter inPulsed.run()
. Experimentally means that the API might be fine tuned in a future release.
Changed#
A DC bias set with
Hardware.set_dc_bias()
is now persistent across a firmware reload, e.g. when switching betweenpulsed
andlockin
mode, unless the hardware is initialized withforce_reload=True
.
Fixed#
Documentation for
Lockin.set_phase_reset()
.Fix bug causing spurious
Pulsed.next_scale()
events that could happen when the repetition period of an experiment was longer that half a millisecond.Fix erroneous error message that would warn of an error when using template matching even though everything was good.
Version 2.6.0 – 2022-12-07#
Added#
Abort a pulsed measurement early if data corruption is detected.
Changed#
Improve handling of pulsed-mode commands at run time to enable longer two-qubit randomized benchmarking.
Update all internal libraries.
Speed up reconnecting to Presto if no settings are changed.
Removed#
Remove experimental feature
enable_compression
inPulsed.run()
: this feature is now covered by the improved handling of pulse-mode commands.
Fixed#
Fix attenuation values in documentation for
Hardware.set_adc_attenuation()
.
Version 2.5.1 – 2022-11-05#
Fixed#
Bug in
Lockin
andSymmetricLockin
when setting a negative phase on the output I quadrature.Fix bug on Vivace hardware when changing output range with
Hardware.set_dac_current()
.
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 previousnbox
in methodsLockin.get_pixels()
andSymmetricLockin.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#
Fix documentation for DAC current settings in
Hardware.set_dac_current()
.Restore compatibility with Python 3.7+.
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
inPulsed.setup_long_drive()
. To maintain backwards compatibility, the default setting isenvelope=True
. Note that this is different fromPulsed.setup_template()
where the default isenvelope=False
.New interface to asynchronous measurements:
Pulsed.run_async()
returns aMeasurementHandle
that allows interaction with a running measurement.
Changed#
Methods
Lockin.get_pixels()
andSymmetricLockin.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 aRuntimeError
exception if called after a measurement has already beenrun()
. The previous behavior was not supported, see the warning in the documentation for thePulsed
class.The
output_port
argument toPulsed.setup_long_drive()
now accepts a list to output the same pulse on multiple ports, much likePulsed.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#
Improve resilience to rounding errors in
Hardware.configure_mixer()
Version 2.3.1 – 2022-04-25#
Fixed#
Restore compatibility with Python 3.7+
Version 2.3.0 – 2022-04-21#
Added#
New class
SymmetricLockin
: a special-purpose version ofLockin
with same frequencies on input and output (symmetric). The new class inherits from the previous one, so most of theLockin
functionality is available inSymmetricLockin
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
andnsum
optional parameters toLockin.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 inHardware.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#
Fix bug in compression algorithm in
Pulsed.run()
.
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 calls to
store()
. Overlapping stores are not supported and could cause the experimental sequence to terminate abnormally, or not terminate at all.if some
select_frequency()
orselect_scale()
event is trying to access indexes beyond what was programmed in the look-up tables withsetup_freq_lut()
andsetup_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, passenable_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 whenadc_mode=AdcMode.Direct
and in complex form whenadc_mode=AdcMode.Mixed
(when using digital downconversion).Method
Pulsed.setup_template_matching_pair()
now accept complex-valued arguments whenadc_mode=AdcMode.Mixed
(when using digital downconversion).Methods
Pulsed.setup_long_drive()
andPulsed.setup_template()
now accept complex-valued arguments whendac_mode=DacMode.Mixedxx
(when using digital upconversion).
Fixed#
Fix error message in
OutputGroup.set_frequencies()
andInputGroup.set_frequencies()
: while it’s certainly good practice to set IF frequencies smaller than 1 EHz (1018 Hz), we meant to write just 1 GHz.Fix a bug in
Pulsed.setup_condition()
when specifying templates to be output when the condition is False.Fix a bug that prevented
Pulsed.match()
events from being scheduled at times smaller than 6 ns.
Version 2.1.0 – 2021-12-01#
Ability to choose frequency of external reference clock: see the optional argument
ext_ref_clk
toPulsed
andLockin
Improvement to calibration routine during update.
pulsed
module#
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#
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
tosetup_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
anddac_fsample
Fix error when running with
dry_run
set to True.
LongDrive
class#
New method
get_duration()
for compatibility withTemplate
class.
lockin
module#
Lockin
class#
Fix bug in
tune_perfect()
Improve error messages when using not supported combinations of
adc_mode
,adc_fsample
,dac_mode
anddac_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#
New module to control configurations common to all modes of operation. Accessible as the hardware
attribute of any instance of Pulsed
and Lockin
.
pulsed
module#
Pulsed
class#
The class constructor takes 4 new optional arguments:
adc_mode
,adc_fsample
,dac_mode
anddac_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()
andselect_scale()
take a new optional argumentgroup
. If not specified, both output groups onoutput_ports
are affected.The method
run()
(previouslyperform_measurement
) does not return the result ofstore()
events: useget_store_data()
after running the experiment. To get the result ofmatch()
events, useget_template_matching_data()
(same as before).Method
setup_freq_lut()
:the old
carrier
argument (1 or 2) is replaced by the newgroup
argument (0 or 1)new argument
phases_q
must be specified when using the built-in digital IQ mixers for digital upconversionthe optional argument
repeat_count
is removed
Method
setup_long_drive()
:the old
carrier
argument (1 or 2) is replaced by the newgroup
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 upconversionthe optional argument
use_scale
is removed: all output templates are subject to the output scaler for the appropriate port and groupthe optional argument
envelope
is now a boolean. To specify which signal generator to use whenenvelope=True
, use thegroup
argument (0 or 1)
New methods:
Deprecated methods:
perform_measurement
: userun()
instead
Some methods are moved to the new
Hardware
class, which is available as thehardware
attribute to any instance ofPulsed
:blank_output
: nowhardware.blank_output
(function signature changed!)set_output_bias
: nowhardware.set_dc_bias
(function signature changed!)
LongDrive
class#
Renamed methods:
update_flat_duration
: nowset_flat_duration()
update_total_duration
: nowset_total_duration()
New methods:
Other#
utils
module#
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#
New attributes:
version_api
: the only one of interest to the user. It is also exported as the__version__
attribute to thepresto
moduleversion_conductor
version_fpga
version_rpu
Removed functions:
get_variant_firmware
get_version_all
get_version_api
get_version_clock
get_version_firmware
get_version_server