quantum_matter_lib.instruments package

Submodules

quantum_matter_lib.instruments.magnicon_squid_viewer module

exception quantum_matter_lib.instruments.magnicon_squid_viewer.MagSVException(error_code: int)

Bases: Exception

class quantum_matter_lib.instruments.magnicon_squid_viewer.MagniconSQUIDViewer

Bases: Client64

High-level 64 bits client to communicate with Magnicon SQUID Viewer.

check_error_code(error_code: int) → None

Raise exception if error code is not 0.

Parameters:

error_code (int) – error code from MAGSV.DLL.

Raises:

MagniconException – Function returned an error.

close_USB() → None

Close the USB connection with the SQUID electronics and release the USB handle.

disable_dummy(channel: int) → None

Disable dummy mode for channel.

Parameters:

channel (int) – Channel number.

enable_dummy(channel: int) → None

Enable dummy mode for channel.

Parameters:

channel (int) – Channel number.

get_bias_current(channel: int) → float

Get bias current of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias current value in µA.

Return type:

float

get_bias_flux(channel: int) → float

Get bias flux of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias flux in µA.

Return type:

float

get_bias_voltage(channel: int) → float

Get bias voltage of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias voltage in µV.

Return type:

float

init_USB(baudrate: int = 57600, timeout: int = 100) → None

Initialise the USB connection between MAGSV.DLL and the SQUID electronics via usb to serial converter. You need to close the connection to release the USB handle with close_USB.

Parameters:

• baudrate (int) – Set the baudrate of serial connection.

• timeout (int) – Timeout for the communication in ms.

is_dummy_enabled(channel: int) → bool

Return if the dummy state of the SQUID of channel is enabled.

Parameters:

channel (int) – Channel number.

Returns:

True if on and False if off.

Return type:

bool

set_active_channel(channel: int) → None

Set the active channel when reading or writing parameters with other functions.

Parameters:

channel (int) – Channel number.

set_bias_current(channel: int, bias_current: float) → float

Set bias current of channel.

Parameters:

• channel (int) – Channel number.

• bias_current (float) – Value of the bias current in µA.

Returns:

Actual set value of the bias current in µA.

Return type:

float

set_bias_flux(channel: int, bias_flux: float) → float

Set bias flux of channel.

Parameters:

• channel (int) – Channel number.

• bias_voltage (float) – Bias flux in µA.

Returns:

Actual set value of the bias flux in µA.

Return type:

float

set_bias_voltage(channel: int, bias_voltage: float) → float

Set bias voltage of channel.

Parameters:

• channel (int) – Channel number.

• bias_voltage (float) – Bias voltage in µV.

Returns:

Actual set value of the bias voltage in µV.

Return type:

float

class quantum_matter_lib.instruments.magnicon_squid_viewer.MagniconSQUIDViewerServer32(host: str, port: int)

Bases: Server32

Driver for Magnicon SQUID electronics. Requires Magnicon SQUID Viewer dll to work.

MA_SetActiveChannel(channel: int) → int

MA_closeUSB() → int

MA_initUSB(baudrate: int, timeout: int) → int

MA_read_Dummy(channel: int) → tuple[int, bool]

MA_read_Ib(channel: int) → tuple[int, list[float], int, float]

MA_read_Phiob(channel: int) → tuple[int, list[float], float]

MA_read_Vb(channel: int) → tuple[int, list[float], float]

MA_write_Dummy(channel: int, dummy: int) → int

MA_write_Ib(channel: int, bias_current: float, range: int) → tuple[int, float]

MA_write_Phiob(channel: int, flux_bias: float) → tuple[int, float]

MA_write_Vb(channel: int, voltage_bias: float) → tuple[int, float]

Module contents

exception quantum_matter_lib.instruments.magnicon_squid_viewer.MagSVException(error_code: int)

Bases: Exception

class quantum_matter_lib.instruments.magnicon_squid_viewer.MagniconSQUIDViewer

Bases: Client64

High-level 64 bits client to communicate with Magnicon SQUID Viewer.

check_error_code(error_code: int) → None

Raise exception if error code is not 0.

Parameters:

error_code (int) – error code from MAGSV.DLL.

Raises:

MagniconException – Function returned an error.

close_USB() → None

Close the USB connection with the SQUID electronics and release the USB handle.

disable_dummy(channel: int) → None

Disable dummy mode for channel.

Parameters:

channel (int) – Channel number.

enable_dummy(channel: int) → None

Enable dummy mode for channel.

Parameters:

channel (int) – Channel number.

get_bias_current(channel: int) → float

Get bias current of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias current value in µA.

Return type:

float

get_bias_flux(channel: int) → float

Get bias flux of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias flux in µA.

Return type:

float

get_bias_voltage(channel: int) → float

Get bias voltage of channel.

Parameters:

channel (int) – Channel number.

Returns:

Bias voltage in µV.

Return type:

float

init_USB(baudrate: int = 57600, timeout: int = 100) → None

Initialise the USB connection between MAGSV.DLL and the SQUID electronics via usb to serial converter. You need to close the connection to release the USB handle with close_USB.

Parameters:

• baudrate (int) – Set the baudrate of serial connection.

• timeout (int) – Timeout for the communication in ms.

is_dummy_enabled(channel: int) → bool

Return if the dummy state of the SQUID of channel is enabled.

Parameters:

channel (int) – Channel number.

Returns:

True if on and False if off.

Return type:

bool

set_active_channel(channel: int) → None

Set the active channel when reading or writing parameters with other functions.

Parameters:

channel (int) – Channel number.

set_bias_current(channel: int, bias_current: float) → float

Set bias current of channel.

Parameters:

• channel (int) – Channel number.

• bias_current (float) – Value of the bias current in µA.

Returns:

Actual set value of the bias current in µA.

Return type:

float

set_bias_flux(channel: int, bias_flux: float) → float

Set bias flux of channel.

Parameters:

• channel (int) – Channel number.

• bias_voltage (float) – Bias flux in µA.

Returns:

Actual set value of the bias flux in µA.

Return type:

float

set_bias_voltage(channel: int, bias_voltage: float) → float

Set bias voltage of channel.

Parameters:

• channel (int) – Channel number.

• bias_voltage (float) – Bias voltage in µV.

Returns:

Actual set value of the bias voltage in µV.

Return type:

float

class quantum_matter_lib.instruments.magnicon_squid_viewer.MagniconSQUIDViewerServer32(host: str, port: int)

Bases: Server32

Driver for Magnicon SQUID electronics. Requires Magnicon SQUID Viewer dll to work.

MA_SetActiveChannel(channel: int) → int

MA_closeUSB() → int

MA_initUSB(baudrate: int, timeout: int) → int

MA_read_Dummy(channel: int) → tuple[int, bool]

MA_read_Ib(channel: int) → tuple[int, list[float], int, float]

MA_read_Phiob(channel: int) → tuple[int, list[float], float]

MA_read_Vb(channel: int) → tuple[int, list[float], float]

MA_write_Dummy(channel: int, dummy: int) → int

MA_write_Ib(channel: int, bias_current: float, range: int) → tuple[int, float]

MA_write_Phiob(channel: int, flux_bias: float) → tuple[int, float]

MA_write_Vb(channel: int, voltage_bias: float) → tuple[int, float]