Experiment.cfg
Contents
- 1 Overview
- 2 Basic configuration
- 3 Parameter types
- 3.1 System parameters
- 3.2 Array description parameters
- 3.2.1 hardware_rc
- 3.2.2 hardware_sync
- 3.2.3 hardware_rect
- 3.2.4 hardware_fast_sq2
- 3.2.5 hardware_rc_data
- 3.2.6 config_rc
- 3.2.7 config_sync
- 3.2.8 config_filter
- 3.2.9 filter_params
- 3.2.10 default_num_rows, num_rows
- 3.2.11 default_sample_num, sample_num
- 3.2.12 default_data_mode
- 3.2.13 default_flux_jumping
- 3.2.14 default_servo_p, default_servo_i, default_servo_d
- 3.2.15 default_sa_bias, default_sq2_bias, default_sq1_bias, default_sq1_bias_off
- 3.2.16 columns_off
- 3.3 Tuning control parameters
- 3.4 Structural parameters
Overview
Basic configuration
To setup an array for the first time, be sure to set the following parameters:
Parameter types
System parameters
array_id
A string identifying the array. Unless you have multiple array setups that require different configuration files, use "default".
Array description parameters
hardware_rc
A list of 4 integers (boolean), identifying the presence (in the MCE) of each readout card. e.g. for RC1 and RC2 use:
hardware_rc = [1,1,0,0];
hardware_sync
An integer (boolean) identifying the presence of a sync box. This doesn't actually do anything -- use #config_sync to enable or disable the MCE's use of a connected syncbox.
hardware_rect
An integer (boolean) identifying the use of "rectangle mode" firmware on the MCE. Firmware revisions from v5.0.0 are "rectangle mode". The RC and CC configuration steps change substantially between non-rectangle and rectangle mode firmware so it is critical to set this flag correctly.
hardware_fast_sq2
An integer describing the capabilities of the card in the BC2 slot.
- Values
- 0 - old-school bias card, no fast-switching capabilities
- 1 - biasing address card, fast-switching only.
- 2 - new-school bias card support both behaviours.
hardware_rc_data
A list of 4 integers (boolean), identifying which RCs should be included when reading "RCS" data from the MCE. The flags are processed and written to "cc rcs_to_report_data" by the config script. This will usually match hardware_rc.
config_rc
A list of 4 integers (boolean) identifying what readout cards should be configured by the config script. It should probably match #hardware_rc.
config_sync
An integer (boolean). When set to 1, the MCE will be configured to take its timing parameters from the sync box. The sync box must be connected and properly configured for this to work. When set to 0, the MCE will be configured to ignore the sync_box.
config_filter
An integer (boolean) indicating that the low-pass filter parameters specified in #filter_params need to be written to the MCE. Starting with RC 5.1.0, alternative parameters can be written to the MCE.
filter_params
Filter parameters for RC. See description in template, or here: Digital 4-pole Butterworth Low-pass filter.
default_num_rows, num_rows
Integer specifying the number of rows to tune. Currently these both need to be set to same value.
default_sample_num, sample_num
Integer specifying the number of ADC samples the MCE should co-add when measuring the error signal. Currently these both need to be set to same value.
default_data_mode
Integer indicating the data_mode the MCE should be placed into at the end of the auto-setup.
default_flux_jumping
Integer (boolean) indicating whether to enable flux_jumping following auto-setup.
default_servo_p, default_servo_i, default_servo_d
Each of these parameters is a list of integers containing the default servo gain parameters. There is one value per column. Note that the values actually written to the mce are determined by servo_p, servo_i, servo_d. These are loaded from default_* at the end of auto-setup.
default_sa_bias, default_sq2_bias, default_sq1_bias, default_sq1_bias_off
Each is a list of integers, giving the default DAC values for the SA bias, SQ2 bias, SQ1 "on" bias and SQ1 "off" bias. The SA and SQ2 biases are lists of integers, one value per MCE column. The SQ1 values are one per row.
columns_off
A list of integers (boolean) indicating columns that should be disabled following auto-tuning. Disabled columns have their SA and SQ2 biases turned off. (It should also kill the servo gains, but it doesn't as of r809.)
Tuning control parameters
stop_after_sq1_servo
sa_ramp_bias
sa_ramp_flux_start, sa_ramp_flux_count, sa_ramp_flux_step
sa_ramp_bias_start, sa_ramp_bias_count, sa_ramp_bias_step
sq2_rows
List of integers indicating which row in each column should be used in the SQ1 servo step. Only relevant when config_fast_sq2 = 1.
Structural parameters
array_width
Some parameters specify values for every row and column. These are expressed as one-dimensional lists, such that the correspondence between (row,column) and index into the 1d array is
index = row + column * array_width
