API Reference Guide

This is the Python public API for controlling the Vivace and Presto hardware platforms.

Detailed information is provided in the documentation for each module.

dcbias	DC-bias waveform generation
hardware	Hardware configuration common to all modes of operation.
lockin	Continuous-wave generation and measurement.
pulsed	Pulse-based experiment design and measurement.
spectral	FFT-based measurements of spectral content.
ssh	Utilities for communicating with Presto over SSH.
utils	Collection of functions that might be useful, or might not.
version	Under-the-hood version information.

Modules:

• dcbias module
  • DcBiasWaveform
• hardware module
  • Advanced tile configuration
  • Hardware class
  • TriggerSource class
  • MultibandMode class
  • Converter modes
  • Converter rates
• lockin module
  • DF_MIN
  • DF_MAX
  • Lockin class
  • SymmetricLockin class
  • Input and output groups
  • Other
• pulsed module
  • MAX_LUT_ENTRIES
  • MAX_LUT_ENTRIES_DCBIAS
  • MAX_COMMANDS
  • MAX_STORE_LEN
  • MAX_TEMPLATE_LEN
  • MAX_THRESHOLD
  • Pulsed class
  • FlatPulse class
  • LongDrive class
  • Other Event classes
  • Async types
• spectral module
  • Spectral class
  • SpecMode class
  • SpecResult class
  • SpecReceiver class
  • Other
• ssh module
  • reboot()
  • restart()
• utils module
  • ProgressBar
  • Spinner
  • as_flat_list()
  • format_precision()
  • format_sec()
  • get_sourcecode()
  • newman_phases()
  • newman_scale()
  • plot_sequence()
  • recommended_dac_config()
  • rotate_opt()
  • si_prefix_scale()
  • sin2()
  • sinP()
  • ssh_reboot()
  • ssh_restart()
  • to_pm_pi()
  • triangle()
  • untwist_downconversion()
• version module
  • version_api
  • version_conductor
  • version_fpga
  • version_mbv_dcbias
  • version_rpu