Pulse sequence builder and compiler for q1asm. q1pulse is a simple library to compile pulse sequence to q1asm, the assembly language of Qblox instruments. q1pulse supports loops, variables and expressions that are translated to q1asm.
The current status of q1pulse is quite experimental. Code may change without any backwards compatibility.
This project has several goals:
- create a driver to use in the backend of pulse_lib
- provide a very simple API to test QCM and QRM
- explore the possibilities of q1asm and the QCM and QRM
- have fun with building a compiler for q1asm.
q1pulse is inspired on pulse_lib. The following features of pulse_lib are not available in q1pulse:
- Virtual matrix for compensation of capacitive coupling of device gates.
- Channel delay compensation.
- Compensation for attenuators on output.
- DC compensation to discharge bias-T.
- Bias-T compensation to compensate for high-pass filter. These features will be handled by pulse_lib when q1pulse is used as pulse_lib backend.
A q1pulse program is written in Python using the q1pulse API. A program consists of instructions like pulses, wait statements, loops and acquisitions for the QCM and QRM sequencers. An instruction can apply to 1 or more sequencers. All instructions are executed in sequential order, unless otherwise specified in a "parallel section". The instruction sequence is synchronized across all the sequencers.
Program and sequences
A program is created for a Q1Instrument. The instrument definition contains the definition of the sequencers and their mapping to the output and input channels of the modules. A program has a sequence for every configured sequencer. The individual sequences can be accessed via an attribute of the program object or as an index of the program object.
Every instruction advances the time of all sequencers, unless otherwise specified. Instructions added to the Program object apply to multiple sequencers simultaneously. Instructions added to a sequence only affect the timing of the other sequences.
A program can have a parallel section. In a parallel section the program time does not advance. So, instructions can be scheduled to overlap. After the parallel section the time is set after the end of all the instructions in the parallel section.
Example program and sequences
This simple program shows the use of program object and sequence objects.
p = instrument.new_program('ramp') # sequencer P1 P1 = p.P1 # sequencer P2 using indexer P2 = p['P2'] # sequencer R1 (readout) R1 = p.R1 R1.add_acquisition_bins('default', 10) # generate a block pulse of 20 ns and amplitude 0.5 on P1 P1.block_pulse(20, 0.5) # After that generate a block pulse of 100 ns and amplitude -0.25 on P2 P2.block_pulse(100, -0.25) # Wait 40 ns after last pulse p.wait(40) # generate pulse of 200 ns on P1 and P2 simultaneously with amplitudes 0.5 and -0.5 p.block_pulse(200, [P1, P2], [0.5, -0.5]) # simultaneous pulses using parallel section: # - a block pulse on P1 # - an overlapping ramp on P2 with an offset of 20 ns # - acquisition on R1 starts immediately with parallel section (no offset) # - wait(100) has latest end time and determines total duration of section. with p.parallel(): P1.block_pulse(40, -0.1) # ramp from 0.05 to 0.4 in 60 ns. Start 20 ns after begin of parallel section P2.ramp(60, 0.05, 0.40, t_offset=20) R1.acquire('default', 'increment') p.wait(100)
Output channels and sequencer instructions
Sequencers can be configured to control 1 or 2 outputs. Sequencers controlling 1 output will most likely be used to directly control a voltage on the target device. Sequencers controlling 2 outputs will most likely be used for the generation of RF signals. Some instructions intended for voltage control, e.g. ramp, will fail on sequencers controlling 2 output channels.
Instruction arguments: floating point and nanoseconds
The arguments that specify an amplitude, offset, gain or phase are all specified as floating point values in the range [-1.0, 1.0]. For amplitude and gain the actual value has to be multiplied with the voltage range of the output channel. The value of the phase is in units of PI. The time in instructions is always specified in nanoseconds.
Program flow and timing instructions:
- wait(t): wait t ns
- loop_range, loop_linspace
- parallel: starts parallel section where time is not incremented automatically
Instructions for simultaneous execution on multiple sequencers where each sequencer is controlling only 1 output:
- set_offsets: Does not advance time.
ramp instruction does not yet accept variables or expressions as argument.
QCM Sequence instructions
- add_wave: adds a wave to be used in shaped pulses
- add_comment: add a comment line in the q1asm
- set_offset, set_gain, set_phase, shift_phase : Do not advance time.
- ramp: creates ramp on 1 output
ramp instruction does not yet accept variables or expressions as argument.
QRM Sequence instructions
QRM can execute all QCM instructions.
QRM specific instructions:
add_acquisition: add a (binned) acquisition specification
add_acquisition_weights: add specification for weights (TODO)
acquire: acquire data, optionally incrementing the bin counter. Doesn't advance time.
Variables and expressions
Programs can make use of variables that will be translated to q1asm registers. Variables can be global to the program or local to a sequence. Global variables can be created via the R attribute of the program object,
p.R.amplitude = 0.5. Sequence local variables can be created via the Rs attribute of a sequence object,
P1.Rs.t_wait = 200. Global variables can be used in program and sequence instructions. Sequence local variables can only be used in sequence instructions.
The type of a variable can be either float or int. It is inferred on the first assignment and cannot change within the program. Internally the float variables are represented as 32 bit fixed point values in the range [-1.0, 1.0]. Integers are 32 bit signed int, unless otherwise specified. Where needed and as far as possible the compiler inserts additional q1asm instructions to emulate signed int operations.
The following Python operations are supported:
>> and bitwise
~. Evaluation order is determined by the Python operator rules.
- The shift right operator does an unsigned shift right.
- There is no overflow checking on integer and fixed point operations. So, 1.0 + 0.5 gives -0.5.
# integers: p.R.a = 0 p.R.b = p.R.a + 1 p.R.b = 5 + (p.R.a << 1) p.R.c = p.R.b + p.R.a p.R.c += 5 p.R.d = 1 - p.R.a # floating point: p.R.f = 1.0 p.R.f -= 0.1 p.R.g = 0.5 p.R.h = p.R.f - p.R.g # sequence variables: P1.Rs.x = 9 P1.Rs.y = P1.Rs.x + p.R.b P1.Rs.amplitude = p.R.f - 0.2 # use of variables and expressions in instruction arguments p.wait(p.R.c + 10) P1.block_pulse(p.R.d, P1.Rs.amplitude)
Loops can be created on program level and will be executed on all sequences in parallel to ensure synchronized execution of all sequences. There are two types of loops.
loop_range creates a loop in q1asm which is similar to
for i in range(...). It uses the same arguments as
loop_linspace creates a loop in q1asm with a fixed point variable which is similar to
for x in numpy.linspace(...) It uses the same arguments as
numpy.linspace. The loops should be used with a
with statement. The statements return a global variable that can be used as such.
# initialize, varying wait, readout. with p.loop_range(100, 1000, 10) as t_wait: p.block_pulse(200, gates, v_init) p.wait(t_wait) p.block_pulse(200, gates, v_readout) # create a staircase with p.loop_linspace(-0.5, 0.5, 20) as v1: P1.block_pulse(200, v1)
instrument = Q1Instrument() instrument.add_qcm(0, qcm0) instrument.add_qrm(1, qrm1) # add sequencers with output channels instrument.add_control('q1', 0, [0,1]) instrument.add_control('P1', 0, ) instrument.add_control('P2', 0, ) instrument.add_readout('R1', 1, ) p = instrument.new_program('my_q1_program')
- Refactor code to be separate a driver to use with pulse_lib and a standalone pulse sequence builder.
- Implement markers