qcodes_contrib_drivers.drivers.QuantumDesign package

Submodules

qcodes_contrib_drivers.drivers.QuantumDesign.Opticool module

QCoDeS Driver for Quantum Design Opticool Magnet Optical Cryostat. Requires MultiPyVu installed for client-server communication. Tested on a system with 7T bore magnet. https://qdusa.com/products/opticool.html

Authors:

Julien Barrier, <julien@julienbarrier.eu>

class qcodes_contrib_drivers.drivers.QuantumDesign.Opticool.Opticool(*args: Any, **kwargs: Any)

Bases: Instrument

Class to represent an Opticool cryostat.

Parameters:

• name (str) – name for the instrument

• address (str) – IP address of the MultiPyVu server instance. Defaults to localhost

• port (int) – port to connect IP. Defaults to 5000

Todo: include all temperature sensors in the driver

ask_raw(cmd: str, query: str = '')

Send a query to the server

Parameters:

• action – str - the general command sent to the MultiVu server. (TEMP(?), FIELD(?), CHAMBER(?), etc. Second item is the query

• query – str, optional - specific details of the command

Returns:

out

close() → None

Close the connection

get_idn() → dict[str, str | None]

Overrides instrument function

Returns:

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

high_vacuum()

High vacuum mode

pump_continuous()

Continuous pumping of chamber

purge_seal()

Purge seal

ramp_field()

Ramp field to values specified using magnet_ramp_* parameters

ramp_temp()

Ramp temperature to valuess specified using temperature_ramp_* parameters

seal()

Seal chamber

vent_continuous()

Continuous venting of chamber

vent_seal()

Vent seal

qcodes_contrib_drivers.drivers.QuantumDesign.Proteox module

DECS driver for Proteox dilution refrigerator systems

class qcodes_contrib_drivers.drivers.QuantumDesign.Proteox.DECS(*args: Any, **kwargs: Any)

Bases: VisaInstrument

Main implementation of the DECS driver

__init__(name, decs_visa_path, **kwargs)

name (str): instrument name e.g. ‘Proteox’ decs_visa_path (str): supply the file path from your working directory to the decs_visa.py file

ask(cmd: str) → str

Parameters:

cmd – the command to send to the instrument

close() → None

Disconnect and irreversibly tear down the instrument.

close_switch()

VRM utility function

enter_persistent_mode()

VRM utility function

hold_field()

VRM utility function

leave_persistent_mode()

VRM utility function

mixing_chamber_heater_off()

Function to turn off MC heater

open_switch()

VRM utility function

publish(msg, msg_group)

Function to publish an ‘event’

set_magnet_state(state)

Function to set VRM state target

set_magnet_target(coord, x, y, z, sweep_mode, sweep_rate, persist_on_completion)

Function to set field vector target

set_output_current_target(x, y, z, sweep_mode, sweep_rate, persist_on_completion)

Function to set current vector target

still_heater_off()

Function to turn off still heater

sweep_field()

VRM utility function

sweep_psu_output()

VRM utility function

sweep_small_field_step(coord)

Function sweeps a single VRM group. Used for changing the field by values < 100 mA.

wait_until_field_depersisted()

VRM utility function

wait_until_field_persistent()

VRM utility function

wait_until_field_stable()

VRM utility function

wait_until_field_stable_timeout(timeout=600)

VRM utility function. Takes timeout in seconds, switches magnet to hold in timeout*1.1 + 10 s. Default for timeout is 10min

wait_until_temperature_stable_std_control(stable_mean, stable_std, time_between_readings)

Mixing chamber temperature control utility function

Takes a moving average of 30 temperature readings and finds the mean and the std of the last 30 readings, until the difference between the mean and target value is below ‘stable_mean’ and the standard deviation is below ‘stable_std’.

Parameters:

• stable_mean – float - difference between the mean and target value to be achieved by the last 30 temperature readings

• stable_std – float - standard deviation to be achieved by the last 30 temperature readings

• time_between_readings – float - time between taking temperature readings

class qcodes_contrib_drivers.drivers.QuantumDesign.Proteox.MagnetCurrentParameters(name, instrument, **kwargs: Any)

Bases: MultiParameter

Parameter for retrieving X, Y, and Z components of the magnet current.

Retrieve all three parameters via instrument.Magnet_Current_Vector()

get_raw() → tuple[float, ...]

Gets the values of magnet current from the instrument

set_raw(value) → None

Unused overide of base class function

class qcodes_contrib_drivers.drivers.QuantumDesign.Proteox.MagneticFieldParameters(name, instrument, **kwargs: Any)

Bases: MultiParameter

Parameter for retrieving X, Y, and Z components of the magnetic field.

To Retrieve all three parameters via instrument.Magnetic_Field_Vector()

get_raw() → tuple[float, ...]

Gets the values of magnetic field from the instrument

set_raw(value) → None

Unused overide of base class function

Module contents