qcodes_contrib_drivers.drivers.Keysight package

Subpackages

• qcodes_contrib_drivers.drivers.Keysight.SD_common package
  • Submodules
  • qcodes_contrib_drivers.drivers.Keysight.SD_common.SD_AWG module
    • SD_AWG
      • SD_AWG.awg_config_external_trigger()
      • SD_AWG.awg_flush()
      • SD_AWG.awg_from_array()
      • SD_AWG.awg_from_file()
      • SD_AWG.awg_is_running()
      • SD_AWG.awg_jump_next_waveform()
      • SD_AWG.awg_pause()
      • SD_AWG.awg_pause_multiple()
      • SD_AWG.awg_queue_config()
      • SD_AWG.awg_queue_waveform()
      • SD_AWG.awg_resume()
      • SD_AWG.awg_resume_multiple()
      • SD_AWG.awg_start()
      • SD_AWG.awg_start_multiple()
      • SD_AWG.awg_stop()
      • SD_AWG.awg_stop_multiple()
      • SD_AWG.awg_trigger()
      • SD_AWG.awg_trigger_multiple()
      • SD_AWG.config_amplitude_modulation()
      • SD_AWG.config_angle_modulation()
      • SD_AWG.config_clock_io()
      • SD_AWG.config_fpga_trigger()
      • SD_AWG.config_trigger_io()
      • SD_AWG.convert_prescaler_to_sample_rate()
      • SD_AWG.convert_sample_rate_to_prescaler()
      • SD_AWG.flush_waveform()
      • SD_AWG.get_clock_frequency()
      • SD_AWG.get_clock_sync_frequency()
      • SD_AWG.get_trigger_io()
      • SD_AWG.get_waveform_status()
      • SD_AWG.get_waveform_type()
      • SD_AWG.load_fpga_image()
      • SD_AWG.load_waveform()
      • SD_AWG.load_waveform_int16()
      • SD_AWG.new_waveform_from_double()
      • SD_AWG.new_waveform_from_file()
      • SD_AWG.new_waveform_from_int()
      • SD_AWG.off()
      • SD_AWG.read_fpga()
      • SD_AWG.read_fpga_array()
      • SD_AWG.reload_waveform()
      • SD_AWG.reload_waveform_int16()
      • SD_AWG.reset_channel_phase()
      • SD_AWG.reset_clock_phase()
      • SD_AWG.reset_multiple_channel_phase()
      • SD_AWG.set_channel_amplitude()
      • SD_AWG.set_channel_frequency()
      • SD_AWG.set_channel_offset()
      • SD_AWG.set_channel_phase()
      • SD_AWG.set_channel_wave_shape()
      • SD_AWG.set_clock_frequency()
      • SD_AWG.set_digital_filter_mode()
      • SD_AWG.set_iq_modulation()
      • SD_AWG.set_marker_config()
      • SD_AWG.set_trigger_io()
      • SD_AWG.write_fpga()
      • SD_AWG.write_fpga_array()
  • qcodes_contrib_drivers.drivers.Keysight.SD_common.SD_AWG_Async module
    • SD_AWG_Async
      • SD_AWG_Async.asynchronous()
      • SD_AWG_Async.awg_flush()
      • SD_AWG_Async.awg_from_array()
      • SD_AWG_Async.awg_from_file()
      • SD_AWG_Async.awg_queue_waveform()
      • SD_AWG_Async.close()
      • SD_AWG_Async.flush_waveform()
      • SD_AWG_Async.load_waveform()
      • SD_AWG_Async.load_waveform_int16()
      • SD_AWG_Async.release_waveform_memory()
      • SD_AWG_Async.reload_waveform()
      • SD_AWG_Async.reload_waveform_int16()
      • SD_AWG_Async.set_asynchronous()
      • SD_AWG_Async.set_waveform_limit()
      • SD_AWG_Async.upload_waveform()
      • SD_AWG_Async.uploader_ready()
    • Task
      • Task.run()
      • Task.result
      • Task.verbose
    • WaveformReference
      • WaveformReference.is_uploaded()
      • WaveformReference.release()
      • WaveformReference.wait_uploaded()
      • WaveformReference.awg_name
      • WaveformReference.wave_number
    • switchable()
    • threaded()
  • qcodes_contrib_drivers.drivers.Keysight.SD_common.SD_DIG module
    • SD_DIG
      • SD_DIG.__init__()
      • SD_DIG.daq_flush()
      • SD_DIG.daq_flush_multiple()
      • SD_DIG.daq_read()
      • SD_DIG.daq_start()
      • SD_DIG.daq_start_multiple()
      • SD_DIG.daq_stop()
      • SD_DIG.daq_stop_multiple()
      • SD_DIG.daq_trigger()
      • SD_DIG.daq_trigger_multiple()
      • SD_DIG.get_coupling()
      • SD_DIG.get_full_scale()
      • SD_DIG.get_impedance()
      • SD_DIG.get_prescaler()
      • SD_DIG.get_trigger_io()
      • SD_DIG.get_trigger_mode()
      • SD_DIG.get_trigger_threshold()
      • SD_DIG.reset_clock_phase()
      • SD_DIG.set_analog_trigger_mask()
      • SD_DIG.set_clksys_frequency()
      • SD_DIG.set_coupling()
      • SD_DIG.set_daq_trigger_delay()
      • SD_DIG.set_daq_trigger_mode()
      • SD_DIG.set_digital_trigger_mode()
      • SD_DIG.set_digital_trigger_source()
      • SD_DIG.set_ext_trigger_behaviour()
      • SD_DIG.set_ext_trigger_source()
      • SD_DIG.set_full_scale()
      • SD_DIG.set_impedance()
      • SD_DIG.set_n_cycles()
      • SD_DIG.set_n_points()
      • SD_DIG.set_points_per_cycle()
      • SD_DIG.set_prescaler()
      • SD_DIG.set_timeout()
      • SD_DIG.set_trigger_io()
      • SD_DIG.set_trigger_mode()
      • SD_DIG.set_trigger_threshold()
  • qcodes_contrib_drivers.drivers.Keysight.SD_common.SD_Module module
    • SD_Module
      • SD_Module.close()
      • SD_Module.close_soft()
      • SD_Module.get_chassis()
      • SD_Module.get_firmware_version()
      • SD_Module.get_fpga_pc_port()
      • SD_Module.get_hardware_version()
      • SD_Module.get_hvi_register()
      • SD_Module.get_idn()
      • SD_Module.get_module_count()
      • SD_Module.get_open()
      • SD_Module.get_product_name()
      • SD_Module.get_product_name_by_index()
      • SD_Module.get_product_name_by_slot()
      • SD_Module.get_pxi_trigger()
      • SD_Module.get_serial_number()
      • SD_Module.get_serial_number_by_index()
      • SD_Module.get_serial_number_by_slot()
      • SD_Module.get_slot()
      • SD_Module.get_status()
      • SD_Module.get_temperature()
      • SD_Module.get_type()
      • SD_Module.get_type_by_index()
      • SD_Module.get_type_by_slot()
      • SD_Module.load_fpga_image()
      • SD_Module.open_with_serial_number()
      • SD_Module.open_with_slot()
      • SD_Module.run_self_test()
      • SD_Module.set_fpga_pc_port()
      • SD_Module.set_hvi_register()
      • SD_Module.set_pxi_trigger()
    • result_parser()
  • qcodes_contrib_drivers.drivers.Keysight.SD_common.memory_manager module
    • MemoryManager
      • MemoryManager.AllocatedSlot
        • MemoryManager.AllocatedSlot.release()
        • MemoryManager.AllocatedSlot.allocation_ref
        • MemoryManager.AllocatedSlot.memory_manager
        • MemoryManager.AllocatedSlot.number
      • MemoryManager.allocate()
      • MemoryManager.allocation_state()
      • MemoryManager.get_uninitialized_slots()
      • MemoryManager.mem_usage()
      • MemoryManager.release()
      • MemoryManager.release_all()
      • MemoryManager.set_waveform_limit()
      • MemoryManager.memory_sizes
      • MemoryManager.verbose
  • Module contents

Submodules

qcodes_contrib_drivers.drivers.Keysight.Keysight_E36313A module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_E36313A.E36313A(*args: Any, **kwargs: Any)

Bases: VisaInstrument

This is the qcodes driver for the Keysight E36313A programmable DC power supply

get_idn()

Parse a standard VISA *IDN? response into an ID dict.

Even though this is the VISA standard, it applies to various other types as well, such as IPInstruments, so it is included here in the Instrument base class.

Override this if your instrument does not support *IDN? or returns a nonstandard IDN string. This string is supposed to be a comma-separated list of vendor, model, serial, and firmware, but semicolon and colon are also common separators so we accept them here as well.

Returns:

A dict containing vendor, model, serial, and firmware.

class qcodes_contrib_drivers.drivers.Keysight.Keysight_E36313A.E36313AChannel(parent: Instrument, name: str, chan: int)

Bases: InstrumentChannel

__init__(parent: Instrument, name: str, chan: int) → None

Parameters:

• parent – The instrument to which the channel is

• attached.

• name – The name of the channel

• chan – The number of the channel in question (1-3)

qcodes_contrib_drivers.drivers.Keysight.Keysight_E5080B module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_E5080B.KeySight_E5080B(*args: Any, **kwargs: Any)

Bases: VisaInstrument

Qcodes driver for the Keysight E5080B Vector Network Analyzer

get_data()

Retrieve the complex measurement data

get_frequencies()

return freqpoints

accept_trigger_before_armed: Parameter = self.add_parameter( "accept_trigger_before_armed", label="Accept Trigger Before Armed", get_cmd="CONT:SIGN:TRIG:ATBA?", set_cmd="CONT:SIGN:TRIG:ATBA {}", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Accept Trigger Before Armed

averages_count: Parameter = self.add_parameter( "averages_count", label="Averages Count", get_cmd="SENS:AVER:COUN?", get_parser=int, set_cmd="SENS:AVER:COUN {:d}", vals=Numbers(min_value=1, max_value=65536), )

Parameter averages count

averages_enabled: Parameter = self.add_parameter( "averages_enabled", label="Averages Enabled", get_cmd="SENS:AVER?", set_cmd="SENS:AVER {}", val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"), )

Parameter averages_enabled

averages_mode: Parameter = self.add_parameter( "averages_mode", label="Averages Mode", get_cmd="SENS:AVER:MODE?", set_cmd="SENS:AVER:MODE {}", vals=Enum("POIN", "SWE"), )

Parameter averages mode

center_freq: Parameter = self.add_parameter( "center_freq", label="Center Frequency", get_cmd="SENS:FREQ:CENT?", get_parser=float, set_cmd="SENS:FREQ:CENT {}", unit="Hz", vals=Numbers(min_value=min_freq, max_value=max_freq), )

Parameter center_freq

cw: Parameter = self.add_parameter( "cw", label="CW Frequency", get_cmd="SENS:FREQ:CW?", get_parser=float, set_cmd="SENS:FREQ:CW {}", unit="Hz", )

Parameter Continuous wave

format_border: Parameter = self.add_parameter( "format_border", label="Format Border", get_cmd="FORM:BORD?", set_cmd="FORM:BORD {}", vals=Enum("NORM", "SWAP"), )

Parameter Format Border

format_data: Parameter = self.add_parameter( "format_data", label="Format Data", get_cmd="FORM:DATA?", set_cmd="FORM:DATA {}", vals=Enum("REAL,32", "REAL,64", "ASCii,0"), )

Parameter averages mode

if_bandwidth: Parameter = self.add_parameter( "if_bandwidth", label="if_bandwidth", unit="Hz", get_cmd="SENS:BWID?", set_cmd="SENS:BWID {}", get_parser=float, vals=Numbers(min_value=1, max_value=15e6), )

Parameter if_bandwidth

operation_status: Parameter = self.add_parameter( "operation_status", label="Operation Status", get_cmd="STAT:OPER:COND?", get_parser=int, )

Status Operation

points: Parameter = self.add_parameter( "points", label="Points", get_cmd="SENS:SWE:POIN?", get_parser=int, set_cmd="SENS:SWE:POIN {}", unit="", vals=Numbers(min_value=1, max_value=100003), )

Parameter points

rf_on: Parameter = self.add_parameter( "rf_on", label="RF ON", get_cmd="OUTP?", set_cmd="OUTP {}", val_mapping=create_on_off_val_mapping(on_val="1", off_val="0"), )

Parameter RF Power Source

scattering_parameter: Parameter = self.add_parameter( "scattering_parameter", label="scattering_parameter", get_cmd="CALC:MEAS:PAR?", set_cmd="CALC:MEAS:PAR {}", vals=vals.Enum("S11", "S12", "S21", "S22"), )

Parameter scattering_parameter

source_power: Parameter = self.add_parameter( "source_power", label="source_power", unit="dBm", get_cmd="SOUR:POW?", set_cmd="SOUR:POW {}", get_parser=float, vals=Numbers(min_value=-100, max_value=20), )

Parameter source_power

span: Parameter = self.add_parameter( "span", label="Frequency Span", get_cmd="SENS:FREQ:SPAN?", get_parser=float, set_cmd="SENS:FREQ:SPAN {}", unit="Hz", )

Parameter span

start_freq: Parameter = self.add_parameter( "start_freq", label="Start Frequency", get_cmd="SENS:FREQ:STAR?", get_parser=float, set_cmd="SENS:FREQ:STAR {}", unit="Hz", vals=Numbers(min_value=min_freq, max_value=max_freq), )

Parameter start_freq

stop_freq: Parameter = self.add_parameter( "stop_freq", label="Stop Frequency", get_cmd="SENS:FREQ:STOP?", get_parser=float, set_cmd="SENS:FREQ:STOP {}", unit="Hz", vals=Numbers(min_value=min_freq, max_value=max_freq), )

Parameter stop_freq

sweep_group_count: Parameter = self.add_parameter( "sweep_group_count", label="sweep_group_count", get_cmd="SENS:SWE:GRO:COUN?", set_cmd="SENS:SWE:GRO:COUN {}", get_parser=int, vals=Numbers(min_value=1, max_value=2e6), )

Parameter sweep_group_count

sweep_mode: Parameter = self.add_parameter( "sweep_mode", label="Type", get_cmd="SENS:SWE:MODE?", set_cmd="SENS:SWE:MODE {}", vals=Enum("HOLD", "CONT", "GRO", "SING"), )

Parameter sweep_mode

sweep_time: Parameter = self.add_parameter( "sweep_time", label="sweep_time", unit="s", get_parser=float, get_cmd="SENS:SWE:TIME?", set_cmd="SENS:SWE:TIME {}", )

Parameter sweep_time

sweep_time_auto: Parameter = self.add_parameter( "sweep_time_auto", label="sweep_time_auto", get_parser=float, get_cmd="SENS:SWE:TIME:AUTO?", set_cmd="SENS:SWE:TIME:AUTO {}", val_mapping=create_on_off_val_mapping(on_val=1, off_val=0), )

Parameter sweep_time_auto

sweep_type: Parameter = self.add_parameter( "sweep_type", label="Type", get_cmd="SENS:SWE:TYPE?", set_cmd="SENS:SWE:TYPE {}", vals=Enum("LIN", "LOG", "POW", "CW", "SEGM"), )

Parameter sweep_type

trigger_slope: Parameter = self.add_parameter( "trigger_slope", label="Trigger Slope", get_cmd="TRIG:SLOP?", set_cmd="TRIG:SLOP {}", vals=Enum("POS", "NEG"), )

Trigger Slope

trigger_source: Parameter = self.add_parameter( "trigger_source", label="Trigger Source", get_cmd="TRIG:SOUR?", set_cmd="TRIG:SOUR {}", vals=Enum("EXT", "IMM", "MAN"), )

Trigger Source

trigger_type: Parameter = self.add_parameter( "trigger_type", label="Trigger Type", get_cmd="TRIG:TYPE?", set_cmd="TRIG:TYPE {}", vals=Enum("EDGE", "LEV"), )

Trigger Type

qcodes_contrib_drivers.drivers.Keysight.Keysight_E8267D module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_E8267D.Keysight_E8267D(*args: Any, **kwargs: Any)

Bases: VisaInstrument

This is the qcodes driver for the Keysight_E8267D signal generator

Status: beta-version.

TODO: - Add all parameters that are in the manual

This driver will most likely work for multiple Agilent sources.

This driver does not contain all commands available for the E8527D but only the ones most commonly used.

static deg_to_rad(angle_deg)

Convert degrees to radians.

off()

Turn the RF output off.

on()

Turn the RF output on.

static rad_to_deg(angle_rad)

Convert radians to degrees.

qcodes_contrib_drivers.drivers.Keysight.Keysight_J7211 module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_J7211.Keysight_J7211(*args: Any, **kwargs: Any)

Bases: VisaInstrument

Qcodes driver for the Keysight J7211 Attenuation Control Unit. Tested with J7211B.

Parameters:

• name – Instrument name

• address – Address or VISA alias of instrument

• attenuation – Optional attenuation level (in dB) to set on startup

• terminator – Termination character in VISA communication.

qcodes_contrib_drivers.drivers.Keysight.Keysight_M3201A module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_M3201A.Keysight_M3201A(*args: Any, **kwargs: Any)

Bases: SD_AWG

This is the qcodes driver for the Keysight M3201A AWG PXIe card

Parameters:

• name (str) – name for this instrument, passed to the base instrument

• chassis (int) – chassis number where the device is located

• slot (int) – slot number where the device is plugged in

qcodes_contrib_drivers.drivers.Keysight.Keysight_M3300A module

class qcodes_contrib_drivers.drivers.Keysight.Keysight_M3300A.M3300A_AWG(*args: Any, **kwargs: Any)

Bases: SD_AWG

Driver for the AWG of the Keysight M3300A card.

Parameters:

• name (str) – name for this instrument, passed to the base instrument

• chassis (int) – chassis number where the device is located

• slot (int) – slot number where the device is plugged in

Example

AWG = AWG(‘M3300A’)

class qcodes_contrib_drivers.drivers.Keysight.Keysight_M3300A.M3300A_DIG(*args: Any, **kwargs: Any)

Bases: SD_DIG

Driver for the digitizer of the keysight M3300A card.

Parameters:

• name (str) – name for this instrument, passed to the base instrument

• chassis (int) – chassis number where the device is located

• slot (int) – slot number where the device is plugged in

Example

DIG = DIG(‘M3300A’)

qcodes_contrib_drivers.drivers.Keysight.M3202A module

class qcodes_contrib_drivers.drivers.Keysight.M3202A.M3202A(*args: Any, **kwargs: Any)

Bases: SD_AWG_Async

qcodes driver for the Keysight M3202A AWG PXIe card.

M3202A channel numbers start with 1.

This driver is derived from SD_AWG_Async which uses a thread per module to upload waveforms concurrently. The sychronous methods like load_waveform are not available in this class.

Example

awg1 = M3202A(‘awg1’, 0, 2) ref_1 = awg1.upload_waveform(wave1)

trigger_mode = keysightSD1.SD_TriggerModes.EXTTRIG awg1.awg_queue_waveform(1, ref_1, trigger_mode, 0, 1, 0)

If you want to test M3202A based on the synchronous SD_AWG, then you can instantiate SD_AWG directly. .. rubric:: Example

m3202a_sync = SD_AWG(name, chassis, slot, channels=4, triggers=8,

legacy_channel_numbering=False)

Parameters:

• name – name for this instrument, passed to the base instrument

• chassis – chassis number where the device is located

• slot – slot number where the device is plugged in

Module contents