System Configuration
The system configuration file defines the parameters and settings required for the initial setup and operation of the survey system. It includes specifications for the transmitter, data handling, waveform properties, and receiver configurations to ensure accurate data collection and processing.
deliverables:
logo_file: ""
area_name: "Benchmark"
project_id: "benchmark_1234"
transmitter:
off_time_s: 0.0059
peak_time_s: 0.00335
tx_radius_m: 17.5
tx_turns: 4
ramp_on_rate: 3.0
max_current: 100.0
data:
data_file_name: "data.csv"
data_tc_end: 47
data_tc_start: 14
col_names:
xcol: "x"
ycol: "y"
zcol: "radarb"
sfz: "SFz"
line_column: "Line"
topo_column: "DEM"
units: "pV/(Am^4)"
waveform:
waveform_file_name: "waveform.csv"
type: "VTEM"
current_col: "Tx_curr"
time_col: "Time"
receiver:
sampling_file_name: "offtime_sampling.csv"
sampling_col_name: "Middle"
file_start_index: 14
time_scale_s: 1.0e-3
offset_from_tx: [0.0,0.0,0.0]
The system configuration file must be named config_system.yaml and must be located in the ‘data’ folder.
Components of the System Configuration File
Deliverables
(Optional) The filename (including extension) of the customer company logo image file within the data folder. This image will appear in the final reports. Data Type: Optional String.
(Optional) The name of the survey area for which the inversion is performed. Data Type: Optional String.
(Optional) The ID of the project for which the inversion is performed. Data Type: Optional String.
Transmitter
The off-time of the transmitter waveform in seconds. Data Type: Positive Float.
The peak time of the transmitter waveform in seconds. Data Type: Positive Float.
The radius of the transmitter loop in meters. This is used for the modelling of the signal. Data Type: Positive Float.
The number of turns in the transmitter coil. This must be an integer and it is used for the modelling of the signal. Data Type: Positive Integer.
The ramp-on rate of the transmitter waveform. Data Type: Positive Float.
The maximum current of the transmitter waveform. This is only used to scale the data if the units are not in pV/(Am^4). Data Type: Positive Float.
Data
The filename (including extension) of the data file within the data folder. Data Type: String.
The index of the first time channel in the data file for which data is available. Data Type: Positive Integer.
The index of the last time channel in the data file for which data is available. Data Type: Positive Integer (must be greater than or equal to data_tc_start).
The name of the column within the data file that provides the easting coordinates (in meters) of each sounding. Data Type: String.
The name of the column within the data file that provides the northing coordinates (in meters) of each sounding. Data Type: String.
The name of the column within the data file that provides the EM transmitter-receiver loop terrain clearance. Data Type: String.
The prefix used within the data file to identify the column containing the derivative of the magnetic field in the z-direction. Data Type: String.
The name of the column within the data file that indicates the line of the sounding. Data Type: String.
The name of the column within the data file that provides the digital elevation model (DEM) of the sounding. Data Type: String.
The units of the data. The only valid option is “pV/(Am^4)” and “nT/s”. Data Type: String.
Waveform
The filename (including extension) of the waveform definition file within the data folder. If not provided, a default waveform will be used. Data Type: String.
The type of waveform used. Valid options are:
- “VTEM”
- “XCite”
The name of the column within the data file that provides the current waveform data. Data Type: String.
The name of the column within the data file that provides the time values for the current waveform data. Data Type: String.
Receiver
The filename (including extension) of the file within the data folder that contains the times of the offtime sampling. Data Type: String.
The name of the column within the data file that provides the sampling times for the offtime data. Data Type: String.
The index of the first data point in the data file. Data Type: Positive Integer.
The scale factor applied to the time values provided in the offtime_sampling file. Data Type: Positive Float (e.g., 1.0e-3 represents milliseconds).
The offset from the transmitter in the x, y, and z directions. Data Type: List of Floats.