atomiq.components.electronics.currentsource module¶

class atomiq.components.electronics.currentsource.CurrentSource(min_current=-inf, max_current=inf, default_ramp_steps=30, *args, **kwargs)[source]¶

Bases: Component, Parametrizable

Current Source

This abstract class represents any device that can output a defined, controllable current.

Parameters:

min_current (TFloat) -- The minimum current the device can output [A]
max_current (TFloat) -- The maximum current the device can output [A]
default_ramp_steps (TInt32) -- The default number of steps that this device should use if the current is ramped. This value is only used if no ramp_steps are given in the ramp_current() method.

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'default_ramp_steps', 'max_current', 'min_current'}¶

set_current(current)[source]¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)[source]¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

class atomiq.components.electronics.currentsource.HBridgedCurrentSource(current_source, *args, **kwargs)[source]¶

Bases: CurrentSource, Switchable

Combination of an H-bridge and a current source

Combining an H-bridge with a unipolar current source allows to create a bipolar current source. This class bundles these two comoponents an exposes them as a bipolar current source.

Parameters:: current_source (CurrentSource) -- The current source connected to the H-bridge

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

class HBridgeState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]¶

Bases: IntEnum

FORWARD = 1¶

OFF = 0¶

REVERSE = -1¶

conjugate()¶: Returns self, the complex conjugate of any int.

bit_length()¶

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length=1, byteorder='big', *, signed=False)¶

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder='big', *, signed=False)¶

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Indicates whether two's complement is used to represent the integer.

as_integer_ratio()¶

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

is_integer()¶: Returns True. Exists for duck type compatibility with float.is_integer.

real¶: the real part of a complex number

imag¶: the imaginary part of a complex number

numerator¶: the numerator of a rational number in lowest terms

denominator¶: the denominator of a rational number in lowest terms

kernel_invariants = {'current_source'}¶

hbridge_off()[source]¶

hbridge_reverse()[source]¶

hbridge_forward()[source]¶

hbridge_toggle()[source]¶

off()[source]¶

on()[source]¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

class atomiq.components.electronics.currentsource.TTLHardwareLogicHBridgedCurrentSource(switch_direction, switch_on, invert_direction=False, *args, **kwargs)[source]¶

Bases: HBridgedCurrentSource

H-bridged current source with control logic implemented in hardware

Some external hardware (logic gates) take care to set all MOSFETs of the H-bridge based on the desired direction as indicated by switch_direction. Via switch_on the entire bridge can be enabled and disabled.

`switch_on`	`switch_direction`	current flow
off	on	off
off	off	off
on	on	forward
on	off	reverse

Parameters:

switch_on (Switchable) -- When ON, H-bridge is eith forward or reverse; when OFF, load is disconnected from the PSU
switch_direction (Switchable) -- select forward or reverse direction of current flow
invert_direction (TBool) -- flip forward/reverse

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'invert_direction', 'switch_direction', 'switch_on'}¶

class HBridgeState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶

Bases: IntEnum

conjugate()¶: Returns self, the complex conjugate of any int.

bit_length()¶

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length=1, byteorder='big', *, signed=False)¶

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder='big', *, signed=False)¶

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Indicates whether two's complement is used to represent the integer.

as_integer_ratio()¶

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

is_integer()¶: Returns True. Exists for duck type compatibility with float.is_integer.

real¶: the real part of a complex number

imag¶: the imaginary part of a complex number

numerator¶: the numerator of a rational number in lowest terms

denominator¶: the denominator of a rational number in lowest terms

FORWARD = 1¶

OFF = 0¶

REVERSE = -1¶

hbridge_forward()¶

hbridge_off()¶

hbridge_reverse()¶

hbridge_toggle()¶

off()¶

on()¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

class atomiq.components.electronics.currentsource.TTLSoftwareLogicHBridgedCurrentSource(switch_forward, switch_reverse, *args, **kwargs)[source]¶

Bases: HBridgedCurrentSource

H-bridged current source with control logic implemented in software

Each pair of MOSFETs is directly controlled by one switch. So when both TTLs are off, the bridge is off, but also when both are on the PSU is shorted.

`switch_forward`	`switch_reverse`	current flow
off	off	off
off	on	reverse
on	off	forward
on	on	INVALID

Parameters:

switch_forward (Switchable) -- TTL to enable forward pair of MOSFETs
switch_reverse (Switchable) -- TTL to enable reverse pair of MOSFETs

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'switch_forward', 'switch_reverse'}¶

class HBridgeState(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)¶

Bases: IntEnum

conjugate()¶: Returns self, the complex conjugate of any int.

bit_length()¶

Number of bits necessary to represent self in binary.

>>> bin(37)
'0b100101'
>>> (37).bit_length()
6

bit_count()¶

Number of ones in the binary representation of the absolute value of self.

Also known as the population count.

>>> bin(13)
'0b1101'
>>> (13).bit_count()
3

to_bytes(length=1, byteorder='big', *, signed=False)¶

Return an array of bytes representing an integer.

length: Length of bytes object to use. An OverflowError is raised if the integer is not representable with the given number of bytes. Default is length 1.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Determines whether two's complement is used to represent the integer. If signed is False and a negative integer is given, an OverflowError is raised.

from_bytes(byteorder='big', *, signed=False)¶

Return the integer represented by the given array of bytes.

bytes: Holds the array of bytes to convert. The argument must either support the buffer protocol or be an iterable object producing bytes. Bytes and bytearray are examples of built-in objects that support the buffer protocol.
byteorder: The byte order used to represent the integer. If byteorder is 'big', the most significant byte is at the beginning of the byte array. If byteorder is 'little', the most significant byte is at the end of the byte array. To request the native byte order of the host system, use `sys.byteorder' as the byte order value. Default is to use 'big'.
signed: Indicates whether two's complement is used to represent the integer.

as_integer_ratio()¶

Return a pair of integers, whose ratio is equal to the original int.

The ratio is in lowest terms and has a positive denominator.

>>> (10).as_integer_ratio()
(10, 1)
>>> (-10).as_integer_ratio()
(-10, 1)
>>> (0).as_integer_ratio()
(0, 1)

is_integer()¶: Returns True. Exists for duck type compatibility with float.is_integer.

real¶: the real part of a complex number

imag¶: the imaginary part of a complex number

numerator¶: the numerator of a rational number in lowest terms

denominator¶: the denominator of a rational number in lowest terms

FORWARD = 1¶

OFF = 0¶

REVERSE = -1¶

hbridge_forward()¶

hbridge_off()¶

hbridge_reverse()¶

hbridge_toggle()¶

off()¶

on()¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

class atomiq.components.electronics.currentsource.RPCCurrentSource(rpc_currentsource, *args, **kwargs)[source]¶

Bases: CurrentSource

A current source controlled via RPC calls

Parameters:: rpc_currentsource (Component) -- The ARTIQ rpc object representing the current source. This object needs to provide a function named set_current(current_in_A) to set the current.

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'currentsource'}¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

class atomiq.components.electronics.currentsource.RPCCurrentSourceChannel(rpc_currentsource, channel, *args, **kwargs)[source]¶

Bases: CurrentSource

One channel of a multi-channel currentsource controlled via RPC

Parameters:

rpc_currentsource (Component) -- The ARTIQ rpc object representing the multi channel current source. This object needs to provide a function named set_current(current_in_A, channel) to set the current.
channel (TInt32) -- channel of the multi-channel current source to operate on

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'channel', 'currentsource'}¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A

class atomiq.components.electronics.currentsource.VoltageControlledCurrentSource(voltage_source, calibration, *args, **kwargs)[source]¶

Bases: CurrentSource

A current source controlled by an analog voltage

A typical usecase for this class are voltage-controlled power supplies that drive the current through a coil.

Parameters:

voltage_source (VoltageSource) -- Voltage source that controls the current source
calibration (Calibration) -- Calibration U = f(I) to give the control voltage U for a desired current I

A Parametrizable is an entity that can be controlled by one or more continuous parameter(s)

kernel_invariants = {'calibration', 'voltage_source'}¶

ramp_current(duration, current_end, current_start=nan, ramp_timestep=-1.0, ramp_steps=-1)¶

Ramp current over a given duration.

This method advances the timeline by duration

Parameters:

duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]
current_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end current [A]
current_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial current [A]. If not given, the ramp starts from the current operating current.
ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))
ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_current(current)¶

Set the current delivered by the current source

Parameters:: current (artiq.compiler.types.TMono('float', OrderedDict())) -- Current in A