atomiq.components.sinara.suservo module

class atomiq.components.sinara.suservo.SUServo(suservo_device, start_loop=True, *args, **kwargs)

Bases: Component

Representation for the SUServo gateware

On init, the servo loop in the SUServo is stared automatically. If this is not wanted configure the :param:start_loop

Parameters:

• suservo_device -- The artiq SUServo device from your device_db, e.g. @suservo0.

• start_loop (TBool) -- Sets if the servo loop should be started at the prerun stage.

kernel_invariants = {'start_loop', 'suservo_device'}

set_servomode(enabled)

Parameters:

enabled (artiq.compiler.types.TMono('bool', OrderedDict()))

get_adc_value(channel)

Parameters:

channel (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

set_adc_gain(channel, gain=0)

Parameters:

• channel (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

• gain (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

class atomiq.components.sinara.suservo.SUServoChannel(suservo, suservo_channel, default_attenuation=19.0, default_profile=0, servo_divider=10.0, *args, **kwargs)

Bases: RFSource, Switchable

A Urukul DDS channel in SUServo configuration as RF Source

If not in servo mode, this can be used just like a normal :class:UrukulChannel

Parameters:

• suservo (SUServo) -- The atomiq SUServo component this channel belongs to

• suservo_channel -- The artiq SUServo channel from your device_db, e.g. @suservo0_ch2.

• default_profile -- Which of the 32 profiles of the SUServo should be used? (default 0)

• servo_divider (TFloat) -- Todo: Why do we need this? (default 10.0)

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

kernel_invariants = {'cpld', 'suservo', 'suservo_channel'}

set(frequency=-1.0, amplitude=-1.0, phase=0.0, profile=-1)

Set the frequency and amplitude of the DDS channel

Frequency/amplitude are set to the last known value if -1 is given.

Parameters:

• frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- frequency [Hz]. (default -1.0)

• amplitude (artiq.compiler.types.TMono('float', OrderedDict())) -- If servomode is off, this is the DDS amplitude (0..1). If servomode is on, this is the target voltage on the photodiode. (default -1)

• phase (artiq.compiler.types.TMono('float', OrderedDict())) -- Phase in rad to be set (default 0.0)

• profile (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_att(attenuation)

Set the hardware attenuation for this urukul channel via cpld.

Parameters:

attenuation (artiq.compiler.types.TMono('float', OrderedDict())) -- channel attenuation (0. to 31.0 in 0.5 increments) [dB]

set_amplitude(amplitude)

Set the amplitude of the DDS output

Parameters:

amplitude -- If servomode is off, this is the DDS amplitude (0..1). If servomode is on, this is the target voltage on the photodiode.

on()

Turn on the RF output via the fast switch

off()

Turn off the RF output via the fast switch

set_servomode(enabled)

Switch servo mode of the SUServo on or off

The servo loop in the SUServo gateware (running on the Kasli) can only be switched on globally for all channels. However, we can decide for each channel if the output of the servo loop should be given to the DDS. This function switches the the updating for this channel.

Parameters:

enabled (artiq.compiler.types.TMono('bool', OrderedDict())) -- Whether the servomode should be enabled

arb(duration, samples_amp=[], samples_freq=[], samples_phase=[], repetitions=1, prepare_only=False, run_prepared=False, transform_amp=<function identity_float>, transform_freq=<function identity_float>, transform_phase=<function identity_float>)

Play Arbitrary Samples from a List

This method allows to set the output amplitude, frequency an phase according to the values specified in respective lists. The whole sequence is played in the specified duration. The pattern store in the sample list can also be repeated.

We supports a scheme to prepare the arb function before it is actually used. If that is needed, run this function with prepapre_only = True when the arb should be prepared and with run_only = True when the prepared arb should be played. In both calls the other parameters have to be passed.

Parameters:

• samples_amp (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

• samples_freq (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of frequency samples. If this list is empty (default), the frequency is not modified.

• samples_phase (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of phase samples. If this list is empty (default), the phase is not modified.

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- The time in which the whole sequence of samples should be played back [s].

• repetitions (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- Number of times the sequence of all samples should be played. (default 1)

• prepare_only (artiq.compiler.types.TMono('bool', OrderedDict()))

• run_prepared (artiq.compiler.types.TMono('bool', OrderedDict()))

get_amplitude()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_frequency()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_phase()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

ramp(duration, frequency_start=-1.0, frequency_end=-1.0, amplitude_start=-1.0, amplitude_end=-1.0, ramp_timestep=-1.0, ramp_steps=-1)

Ramp frequency and amplitude over a given duration. Parameters default to -1 to indicate no change. If the start frequency/amplitude is set to -1, the ramp starts from the last frequency/amplitude which was set. This method advances the timeline by ´duration´

Parameters:

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]

• frequency_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial frequency [Hz]

• frequency_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end frequency [Hz]

• amplitude_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial amplitude [0..1]

• amplitude_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end amplitude [0..1]

• ramp_timesteps -- time between steps in the ramp [s]

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps

• ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))

set_frequency(frequency)

set_phase(phase)

class atomiq.components.sinara.suservo.SUServoADCChannel(suservo, default_gain=0, *args, **kwargs)

Bases: ADCChannel

Analog Input of a Sampler in an SUServo configuration

ATTENTION: When default_gain is !=1 is given, this might cause problems in closed loop mode. It seems SUServo internally uses gain=1. Maybe it can be set differntly but I don't see how.

Parameters:

• suservo (SUServo) -- The SUServo component that this channel belongs to

• default_gain (TInt32) -- The default gain in machine units (0: 1, ..., 3: 1000) to set for this channel on startup

A single channel of a (possibly multichannel) ADC

Parameters:

• adc_device -- The ADC the channel belongs to

• channel -- The number of the channel

• suservo (SUServo)

• default_gain (TInt32)

kernel_invariants = {'suservo'}

set_gain(gain=0)

Set the gain for the ADC channel in SUServo configuration

Parameters:

gain (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- Gain in machine units (0: 1, ..., 3: 1000)

measure(samples=1, cached=False)

Parameters:

• samples (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

• cached (artiq.compiler.types.TMono('bool', OrderedDict()))

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

class atomiq.components.sinara.suservo.SUServoModulatedLaser(default_kp, default_ki=0.0, default_ki_limit=0.0, *args, **kwargs)

Bases: ContinuouslyStabilizedModulatedLaser

A Laser with intensity stabilization realized by the SUServo

The SUServo realizes a PI servo controller in hardware with an update time inteval of 1.3us, leading to a maximum analog bandwith of >500kHz. To achieve this a Sampler (8 analog in) is bundled in the gateware with two Urukuls (2 x 4 DDS channels).

With this class, the SUServo can be used in open loop as well as in closed loop mode. Use the stabilize() function to switch between open and closed loop mode. When switching from closed to open loop, the last output power on the DDS channel will be hold.

Parameters:

• modulator -- The modulator (most likely an AOM) that is driven by the SUServo. The Modulator given here must be of a class derived from :class:RFLightModulator and the rfsource of the modulator must be of the class :class:SUServoChannel.

• photodiode -- The photodiode monitoring the laser. The photodiode must be of a class derived from :class:AnalogPhotodiode and the photodiode's :param:adc_channel must be of the class :class:SUServoADCChannel.

• default_kp (TFloat) -- default proportional (P-) part for the SUServo loop. Values should be negative.

• default_ki (TFloat) -- default integral (I-) part for the SUServo loop. Values should be negative. (default 0.0)

• default_ki_limit (TFloat) -- default limit for I-part of the SUServo loop. 0.0 means unlimited. (default 0.0)

A Switchable has one ore more channel(s) that can be switched on or off

kernel_invariants = {'default_ki', 'default_ki_limit', 'default_kp', 'suservo_channel'}

set_servo_parameter(adc_channel, kp, ki, ki_limit, delay=0.0)

Set servo loop parameters

Parameters:

• kp (artiq.compiler.types.TMono('float', OrderedDict())) -- proportional (P-) part for the SUServo loop. Values should be negative.

• ki (artiq.compiler.types.TMono('float', OrderedDict())) -- integral (I-) part for the SUServo loop. Values should be negative. (default 0.0)

• ki_limit (artiq.compiler.types.TMono('float', OrderedDict())) -- limit for I-part of the SUServo loop. 0.0 means unlimited. (default 0.0)

• delay (artiq.compiler.types.TMono('float', OrderedDict())) -- delay between switching on the laser an the servo loop becoming active

set_power(power)

Set the output power of the laser

If the SUServo is in open loop mode, this sets the amplitude of the DDS channel. If the SUServo is in closed loop mode, it sets the photodiode value the servo loop should target. If the photodiode is calibrated the power argument should be given in the calibrated units.

Parameters:

power (artiq.compiler.types.TMono('float', OrderedDict())) -- the power the laser should be set/stabilized to. In open loop mode it takes the DDS amplitude (0..1). In closed loop mode it takes the target value on the photodiode for the servo loop. If the photodiode is calibrated the power should be given in the calibrated units (e.g. mW).

arb(duration, samples_amp=[], samples_power=[], samples_freq=[], samples_det=[], samples_phase=[], repetitions=1, prepare_only=False, run_prepared=False, transform_amp=<function identity_float>, transform_freq=<function identity_float>, transform_phase=<function identity_float>)

Play Arbitrary Samples from a List

This method allows to set the output amplitude, frequency an phase according to the values specified in respective lists. The whole sequence is played in the specified duration. The pattern store in the sample list can also be repeated.

We supports a scheme to prepare the arb function before it is actually used. If that is needed, run this function with prepare_only = True when the arb should be prepared and with run_only = True when the prepared arb should be played. In both calls the other parameters have to be passed.

Parameters:

• samples_amp (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

• samples_power (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of power samples. If this list is empty (default), the amplitude is not modified. This overwrites samples_amp.

• samples_freq (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of frequency samples. If this list is empty (default), the frequency is not modified.

• samples_det (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of frequency samples relative to the zero frequency. If this list is empty (default), the frequency is not modified. This overwrites samples_frequency

• samples_phase (artiq.compiler.types.TMono('list', OrderedDict({'elt': artiq.compiler.types.TMono('float', OrderedDict())}))) -- List of phase samples. If this list is empty (default), the phase is not modified.

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- The time in which the whole sequence of samples should be played back [s].

• repetitions (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)}))) -- Number of times the sequence of all samples should be played. (default 1)

• prepare_only (artiq.compiler.types.TMono('bool', OrderedDict()))

• run_prepared (artiq.compiler.types.TMono('bool', OrderedDict()))

detune(frequency)

Alias for set_detuning()

Parameters:

frequency (artiq.compiler.types.TMono('float', OrderedDict()))

get_frequency()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

get_power()

Return type:

artiq.compiler.types.TMono('float', OrderedDict())

off()

on()

ramp(duration, frequency_start=-1.0, frequency_end=-1.0, amplitude_start=-1.0, amplitude_end=-1.0, power_start=-1.0, power_end=-1.0, ramp_timestep=-1.0, ramp_steps=-1)

Ramp frequency and/or power/amplitude over a given duration.

Parameters default to -1 to indicate no change. If the start frequency/amplitude is set to -1, the ramp starts from the last frequency/amplitude which was set.

Either power or amplitude can be given to ramp the intensity of the laser. If power is given, it overwrites the value for the amplitude

This method advances the timeline by ´duration´

Parameters:

• duration (artiq.compiler.types.TMono('float', OrderedDict())) -- ramp duration [s]

• frequency_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial frequency [Hz]

• frequency_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end frequency [Hz]

• amplitude_start (artiq.compiler.types.TMono('float', OrderedDict())) -- initial amplitude [Hz]

• amplitude_end (artiq.compiler.types.TMono('float', OrderedDict())) -- end amplitude [Hz]

• power_start (artiq.compiler.types.TMono('float', OrderedDict()))

• power_end (artiq.compiler.types.TMono('float', OrderedDict()))

• ramp_timestep (artiq.compiler.types.TMono('float', OrderedDict()))

• ramp_steps (artiq.compiler.types.TMono('int', OrderedDict({'width': artiq.compiler.types.TValue(32)})))

set_amplitude(amplitude)

Parameters:

amplitude (artiq.compiler.types.TMono('float', OrderedDict()))

set_detuning(detuning)

Set the detuning of the light from the frequency defined by zero_freq

Note

If you are using a modulator (e.g. AOM) the center frequency is not taken into account. If you want to set the detuning from the center frequency of the modulator use self.modulator.set_detuning

Parameters:

detuning (artiq.compiler.types.TMono('float', OrderedDict())) -- Detuning in Hz

set_frequency(frequency)

Set the absolute frequency of the light after modulation

Parameters:

frequency (artiq.compiler.types.TMono('float', OrderedDict())) -- Absolute frequency of the light after modulation in Hz

stabilize(enable)

Parameters:

enable (artiq.compiler.types.TMono('bool', OrderedDict()))