MirnyChannel

Class Arguments

Argument

Type

Default Value

mirny

Mirny

device

TStr

ttl

None

default_attenuation

TFloat

0.0

default_powerlevel

TFloat

3

freq_limit

tuple

(53125000.0, 4000000000.0)

default_frequency

TFloat

100000000.0

default_phase

TFloat

0.0

amp_limit

tuple

(0.0, 1.0)

blind

TBool

False

default_ramp_steps

TInt32

30

debug_output

TBool

False

Bold arguments are mandatory. For more documentation on the listed arguments refer to the class definition below. If parameters appear in this list but not in the class definition below, please recursively check the linked base classes for the definition of the parameter.

Inheritance Diagram

Inheritance diagram of atomiq.components.sinara.mirny.MirnyChannel

Example Component Dictionary

   {
    "mirny_example": {
        "classname": "atomiq.components.sinara.mirny.MirnyChannel",
        "arguments": {
            "mirny": "<mandatory parameter (Mirny)>",
            "device": "<mandatory parameter (TStr)>",
            "ttl": null,
            "default_attenuation": 0.0,
            "default_powerlevel": 3,
            "freq_limit": [
                53125000.0,
                4000000000.0
            ],
            "default_frequency": 100000000.0,
            "default_phase": 0.0,
            "amp_limit": [
                0.0,
                1.0
            ],
            "blind": false,
            "default_ramp_steps": 30,
            "debug_output": false
        }
    }
}

Class Description

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: RFSource, 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 (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.

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

kernel_invariants = {'default_attenuation', 'default_powerlevel', 'device', 'mirny', 'sw'}
init()[source]

Initialize CPLD (if needed) and PLL. Slow; run once after power-on.

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)

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

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.

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 -- List of amplitude samples. If this list is empty (default), the amplitude is not modified.

  • samples_freq -- List of frequency samples. If this list is empty (default), the frequency is not modified.

  • samples_phase -- List of phase samples. If this list is empty (default), the phase is not modified.

  • duration -- The time in which the whole sequence of samples should be played back [s].

  • repetitions -- Number of times the sequence of all samples should be played. (default 1)

  • prepare_only -- Only write the sequence to RAM, don't play it.

  • run_prepared -- 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).

get_amplitude()
Return type:

artiq.language.types.TFloat

get_frequency()
Return type:

artiq.language.types.TFloat

get_phase()
Return type:

artiq.language.types.TFloat

is_on(channel=None)
Parameters:

channel (artiq.language.types.TStr)

pulse(pulsetime, channel='')
Parameters:

  • pulsetime (artiq.language.types.TFloat)

  • channel (artiq.language.types.TStr)

ramp(duration, frequency_start=nan, frequency_end=nan, amplitude_start=nan, amplitude_end=nan, ramp_timestep=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)

set(frequency=nan, amplitude=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)

set_amplitude(amplitude)
Parameters:

amplitude (artiq.language.types.TFloat)

set_frequency(frequency)
Parameters:

frequency (artiq.language.types.TFloat)

set_parameter(value, channel=None)
Parameters:

  • value (artiq.language.types.TFloat)

  • channel (artiq.language.types.TStr)

set_phase(phase)
Parameters:

phase (artiq.language.types.TFloat)

toggle(channel=None)
Parameters:

channel (artiq.language.types.TStr)