Adding parameter details

README.md

@@ -5,8 +5,24 @@ license: gpl-3.0
 This dataset is very large, and contains the performance of single-ended vias. The vias are created using HFSS. The columns are as follows:
 ['index', 'drill_dia', 'cu_thickness', 'trace_width', 'via_stub_length', 'input_ref_plane_dist', 'output_ref_plane_dist', 'ap_dia', 'stitch_via_distance', 'config_string', 'input_data', 's11_real', 's11_imag', 's12_real', 's12_imag', 's21_real', 's21_imag', 's22_real', 's22_imag', 's11_real_unif', 's11_imag_unif', 's12_real_unif', 's12_imag_unif', 's21_real_unif', 's21_imag_unif', 's22_real_unif', 's22_imag_unif']
 
-
-
+The parameters are described as follows:
+- index: Non-useful parameter giving an individual index of the row. May not be unique.
+- drill_dia: the diameter of the drill of the via
+- cu_thickness: The thickness of all copper layers in the stackup
+- trace_width: The width of the trace on both input and output layer. Note that since reference plane distances may be different, the characteristic impedance may be different for the input trace compared to output.
+- via_stub_length: If a stub exists under the via, this is its length
+- input_ref_plane_dist: The distance from input trace to reference plane. Sets Z0 of input trace
+- output_ref_plane_dist: Same as input (above) but used for output. May vary compared to input
+- ap_dia: The diameter of the via antipad
+- stitch_via_distance: There is one stitching via. This sets the center-to-center via from signal to stitching via
+- config_string: A unique string which describes all of these parameters
+- input_data: This is a 1x1,200,000 array. It describes the geometry in a voxel mesh, with '1' describing signal metal, '-1' describing ground metal and '0' describing dielectric
+- sxx_real: this is the real part of the output calculated S-parameters for each of the S11, S12, S21, and S22. The frequencies are non-uniform, spanning from 0 to 80 GHz.
+- sxx_imag: this is the real part of the output calculated S-parameters for each of the S11, S12, S21, and S22. The frequencies are non-uniform, spanning from 0 to 80 GHz.
+- sxx_{real, imag}_unif: These are the same S-parameters as above, but interpolated to a uniform frequency sweep. The frequencies are linspace(0, 80E9, 1001) (1001 points from DC to 80 GHz)
+
+
+The parameters are described in much more detail in the paper linked below. Note that while the parametric changes are given (the diameters, widths, etc.) it is also possible to simply use the mesh input_data as input to a neural net, in order to predict S-parameters.
 
 
 See: