atomiq.components.sinara.mirny¶

Sinara 4456 Mirny (4-channel ADF5356 PLL).

Classes¶

`Mirny`	Sinara Mirny 4 Channel PLL/VCO-based microwave frequency synthesizer
`MirnyChannel`	Single Mirny ADF5356 channel: PLL frequency, step attenuator, and RF switch.

Functions¶

`_amplitude_to_att_db`(amplitude)
`_att_db_to_amplitude`(att_db)

Module Contents¶

atomiq.components.sinara.mirny._amplitude_to_att_db(amplitude)[source]¶

Parameters:: amplitude (artiq.language.types.TFloat)
Return type:: artiq.language.types.TFloat

atomiq.components.sinara.mirny._att_db_to_amplitude(att_db)[source]¶

Parameters:: att_db (artiq.language.types.TFloat)
Return type:: artiq.language.types.TFloat

class atomiq.components.sinara.mirny.Mirny(cpld, *args, **kwargs)[source]¶

Bases: atomiq.components.primitives.Component

Sinara Mirny 4 Channel PLL/VCO-based microwave frequency synthesizer

Parameters:: cpld (Mirny) -- ARTIQ artiq.coredevice.mirny.Mirny instance from the device database (e.g. @mirny0_cpld).

kernel_invariants¶

cpld¶

experiment¶

identifier¶

debug_output = False¶

core¶

_kernel_invariants¶

_prepare_done = False¶

_build_done = False¶

_hooks_done = []¶

children = []¶

__in_build = True¶

class atomiq.components.sinara.mirny.MirnyChannel(mirny, device, ttl=None, default_attenuation=0.0, default_powerlevel=3, freq_limit=(53125000.0, 4000000000.0), **kwargs)[source]¶

Bases: atomiq.components.electronics.rfsource.RFSource, atomiq.components.primitives.Switchable

Single Mirny ADF5356 channel: PLL frequency, step attenuator, and RF switch.

Parameters:

mirny (Mirny) -- Parent Mirny board the channels belongs to.
device (artiq.language.types.TStr) -- ARTIQ artiq.coredevice.adf5356.ADF5356 channel device from the device_db (e.g. @mirny0_ch0).
ttl -- The ARTIQ device from the device_db representing the Urukul fast RF switch, (e.g. @ttl_mirny0_sw0). RF is switched on and off by disabling the PLL chip output (slow).
default_amplitude -- Default amplitude in interval [0,1] applied in prerun.
default_powerlevel (artiq.language.types.TFloat) -- Default PLL chip power index applied in prerun, this determines the maximum power. Defaults to 3 which is the maximum output power. See the datasheet for more info.
freq_limit (tuple) -- Allowed output frequency range in Hz.
blind -- If True, skip the usual _prerun() reprogramming (see RFSource).
default_attenuation (artiq.language.types.TFloat)

Note

Call init() once after power-on before experiments; it is not invoked automatically.

Warning

The Mirny can not ramp frequencies continuously, between each step there will be a gap of ~1-2ms as the PLL needs to relock.

kernel_invariants¶

mirny¶

device¶

default_attenuation = 0.0¶

default_powerlevel = 3¶

init()[source]¶: Initialize CPLD (if needed) and PLL. Slow; run once after power-on.

_prerun()[source]¶: Specify here what should be done for this component before the run starts. In contrast to the _build() method, the _prerun() routine is executed on the core device before the actual experiment starts.

set_att(attenuation)[source]¶

Set hardware digital attenuation in dB (0–31.5 in 0.5 dB steps).

Updates attenuation and keeps amplitude consistent with the mapping used by set().

Parameters:: attenuation (artiq.language.types.TFloat)

_set_frequency(frequency)[source]¶

Parameters:: frequency (artiq.language.types.TFloat)

_set_amplitude(amplitude)[source]¶

Parameters:: amplitude (artiq.language.types.TFloat)

_set_phase(phase)[source]¶

ADF5356 phase offset is not programmed by this Atomiq wrapper.

Parameters:: phase (artiq.language.types.TFloat)

on()[source]¶

off()[source]¶

set_output_power_mu(n)[source]¶

Set PLL chip output power index (0–3); see ADF5356 datasheet.

Parameters:: n (artiq.language.types.TInt32)

output_power_mu()[source]¶

Return type:: artiq.language.types.TInt32

_on_pll()[source]¶

_off_pll()[source]¶

amplitude = 0.0¶

frequency = 100000000.0¶

phase = 0.0¶

default_ramp_steps = 30¶

blind = False¶

_prerun_blind()¶

set_frequency(frequency)¶

Parameters:: frequency (artiq.language.types.TFloat)

_check_frequency(frequency)¶

get_frequency()¶

Return type:: artiq.language.types.TFloat

set_amplitude(amplitude)¶

Parameters:: amplitude (artiq.language.types.TFloat)

_check_amplitude(amplitude)¶

Parameters:: amplitude (artiq.language.types.TFloat)

get_amplitude()¶

Return type:: artiq.language.types.TFloat

set_phase(phase)¶

Parameters:: phase (artiq.language.types.TFloat)

get_phase()¶

Return type:: artiq.language.types.TFloat

set(frequency=float('nan'), amplitude=float('nan'), phase=0.0)¶

Set the frequency and amplitude of the DDS channel

Frequency/amplitude are set to the last known value if float("nan") is passed (default).

Parameters:

frequency (artiq.language.types.TFloat) -- Frequency in Hz (nan to use previous value)
amplitude (artiq.language.types.TFloat) -- Amplitude (nan to use previous value)
phase (artiq.language.types.TFloat) -- Phase in rad (default 0.0)

_ramp(duration, frequency_start, frequency_end, amplitude_start, amplitude_end, ramp_timestep=0.0002)¶

This method implements a stupid ramp on an abstract level. This will most likely work but be slow. If your hardware has native support for ramping, please override this function when you inherit from RFSource

Parameters:

duration (artiq.language.types.TFloat)
frequency_start (artiq.language.types.TFloat)
frequency_end (artiq.language.types.TFloat)
amplitude_start (artiq.language.types.TFloat)
amplitude_end (artiq.language.types.TFloat)
ramp_timestep (artiq.language.types.TFloat)

ramp(duration, frequency_start=float('nan'), frequency_end=float('nan'), amplitude_start=float('nan'), amplitude_end=float('nan'), ramp_timestep=float('nan'), ramp_steps=-1)¶

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

Parameters:

duration (artiq.language.types.TFloat) -- ramp duration [s]
frequency_start (artiq.language.types.TFloat) -- initial frequency [Hz]
frequency_end (artiq.language.types.TFloat) -- end frequency [Hz]
amplitude_start (artiq.language.types.TFloat) -- initial amplitude [0..1]
amplitude_end (artiq.language.types.TFloat) -- end amplitude [0..1]
ramp_timesteps -- time between steps in the ramp [s]
ramp_steps (artiq.language.types.TInt32) -- number of steps the whole ramp should have. This takes precedence over ramp_timesteps
ramp_timestep (artiq.language.types.TFloat)

_arb(duration, samples_amp, samples_freq, samples_phase, repetitions=1, prepare_only=False, run_prepared=False, transform_amp=identity_float, transform_freq=identity_float, transform_phase=identity_float)¶

Parameters:

duration (artiq.language.types.TFloat)
samples_amp (TList(TFloat))
samples_freq (TList(TFloat))
samples_phase (TList(TFloat))
repetitions (artiq.language.types.TInt32)
prepare_only (artiq.language.types.TBool)
run_prepared (artiq.language.types.TBool)

arb(duration, samples_amp=[], samples_freq=[], samples_phase=[], repetitions=1, prepare_only=False, run_prepared=False, transform_amp=identity_float, transform_freq=identity_float, transform_phase=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.

Tip

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_prepared = True when the prepared arb should be played. In both calls the other parameters have to be passed.

Parameters:

samples_amp (TList(TFloat)) -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.
samples_freq (TList(TFloat)) -- List of frequency samples. If this list is empty (default), the frequency is not modified.
samples_phase (TList(TFloat)) -- List of phase samples. If this list is empty (default), the phase is not modified.
duration (artiq.language.types.TFloat) -- The time in which the whole sequence of samples should be played back [s].
repetitions (artiq.language.types.TInt32) -- Number of times the sequence of all samples should be played. (default 1)
prepare_only (artiq.language.types.TBool) -- Only write the sequence to RAM, don't play it.
run_prepared (artiq.language.types.TBool) -- Play arb sequence previously prepared with prepare_only.
transform_amp -- Function to transform amplitude samples, must take a single argument of type TFloat and return a single TFloat.
transform_freq -- Function to transform frequency samples (see transform_amp).
transform_phase -- Function to transform phase samples (see transform_amp).

experiment¶

identifier¶

debug_output = False¶

core¶

_kernel_invariants¶

_prepare_done = False¶

_build_done = False¶

_hooks_done = []¶

children = []¶

__in_build = True¶

set_parameter(value, channel=None)¶

Parameters:

value (artiq.language.types.TFloat)
channel (artiq.language.types.TStr)

abstractmethod is_on(channel=None)¶

Parameters:: channel (artiq.language.types.TStr)

toggle(channel=None)¶

Parameters:: channel (artiq.language.types.TStr)

pulse(pulsetime, channel='')¶

Parameters:

pulsetime (artiq.language.types.TFloat)
channel (artiq.language.types.TStr)