Commit 987bed7a79c9edf2f6ee3055abc8315823ebfe87

Authored by Erwan Motte
1 parent 8d1026f6
Exists in master

Updated the documentation with sample config files for processing

source/PRO/PRO_config.rst
1 1 *********************
2 2 Configuration files
3   -*********************
4 3 \ No newline at end of file
  4 +*********************
  5 +
  6 +Description / Purpose
  7 +=====================
  8 +
  9 +The configuration files are written in order to be able to select the working
  10 +dir, the data to be processed and also to tune processing parameters.
  11 +It is recommended for configuration files to have explicit names
  12 +or to be saved in folders with explicit names, in order to directly identify
  13 +the specific parameters (e.g. *Flight_39_t_incoh_50ms.cfg*)
  14 +
  15 +
  16 +The configuration files are separated in two files:
  17 +
  18 +- One flight containing campaign and processing specific data.
  19 +
  20 +- One file containing flight specific data, calling the flight/processing file
  21 +
  22 +The configuration files are written in plain text, following the
  23 +YAML specifications. The basic fields will be described in this section,
  24 +while the module dependant settings will be detailed in the corresponding
  25 +module description, under the “input” section.
  26 +
  27 +
  28 +Flight configuration file
  29 +-------------------------
  30 +
  31 +Down below is an example of a commented flight configuration file
  32 +( *flight_conf.yaml* ) with all the available keywords and their definition.
  33 +
  34 +.. literalinclude:: /examples/config/flight_conf.yaml
  35 + :linenos:
  36 + :language: yaml
  37 +
  38 +
  39 +Processing configuration file
  40 +-----------------------------
  41 +
  42 +Down below is an example of a commented processing configuration file
  43 +( *proc_conf.yaml* ) with all the available keywords and their definition.
  44 +
  45 +.. literalinclude:: /examples/config/proc_conf.yaml
  46 + :linenos:
  47 + :language: yaml
5 48 \ No newline at end of file
... ...
source/PRO/PRO_index.rst
  1 +.. _Processing:
  2 +
1 3 **********
2 4 Processing
3 5 **********
... ...
source/blocks.rst
... ... @@ -13,7 +13,7 @@ blocks where identified:
13 13 interfaces with the plane, and all the way to raw data and ancillary
14 14 data storage.
15 15  
16   -- **Processing (PRO)**: Data processing routines,
  16 +- :ref:`Processing` **(PRO)**: Data processing routines,
17 17 from ancillary data to L1b data, and plotting routines.
18 18  
19 19 - **Ground truth data (GTD)**: Description of all the geo-referenced
... ...
source/examples/config/flight_conf.yaml 0 → 100644
... ... @@ -0,0 +1,27 @@
  1 +# Flight Info
  2 +
  3 +flight_id : 'GLORIE_Flight_2'
  4 +desc : 'GLORIE Flight 2, Short'
  5 +date : '2015-06-22'
  6 +
  7 +min_dt : '1979-12-23-103000'
  8 +max_dt : '2079-12-23-103000'
  9 +
  10 +# Base Paths
  11 +
  12 +base_dir : '/media/sf_F_DRIVE/2015-06_Campagne_GLORIE/'
  13 +flight_dir : '20150622_Flight_2_Short/'
  14 +
  15 +# Ancillary Data
  16 +
  17 +ubx_dir : 'UBlox/'
  18 +ubx_prefix : 'COM12_150622_052826'
  19 +ubx_type : 'UBX_ONLY'
  20 +
  21 +SAFIRE_dir : 'SAFIRE/'
  22 +SAFIRE_file : 'as150002_5.xlsx'
  23 +SAFIRE_type : 'xls'
  24 +
  25 +leapsec : 16
  26 +
  27 +proc_settings : proc_settings/GLORIE2015_v0.cfg
0 28 \ No newline at end of file
... ...
source/examples/config/proc_conf.yaml 0 → 100644
... ... @@ -0,0 +1,90 @@
  1 +## Raw data Paths
  2 +
  3 +Flight_dir : 'SDRNav/Flight/'
  4 +Cal_0_dir : 'SDRNav/Cal_0/'
  5 +Cal_1_dir : 'SDRNav/Cal_1/'
  6 +Cal_2_dir : 'SDRNav/Cal_2/'
  7 +Cal_3_dir : 'SDRNav/Cal_3/'
  8 +
  9 +
  10 +## Output structure
  11 +
  12 +out_dir : '/media/sf_F_DRIVE/2015-06_Campagne_GLORIE_out/'
  13 +anc_dir : 'anc/'
  14 +L0_dir : 'L0/01ms/'
  15 +calib_dir : 'calib/'
  16 +L1a_dir : 'L1a/'
  17 +L1b_dir : 'L1b/'
  18 +conf_dir : '../conf_05ms/'
  19 +tp_dir : 'timepos/'
  20 +fig_dir : 'figs/'
  21 +kml_dir : 'kml/'
  22 +tiff_dir : 'tiffs_cal/'
  23 +
  24 +# Regexp for parsing date from file names
  25 +dt_regex : '(\d{4}-\d{2}-\d{2}-\d{6})'
  26 +
  27 +
  28 +## Processing
  29 +
  30 +t_coh : 0.005 # Coherent averaging time
  31 +t_incoh : 0.200 # time to be integrated
  32 +n_sm : 3 # n of samples to be smoothed for interpolation
  33 +max_time_diff : 2700 # Maximum interval (seconds) between two measurements
  34 +
  35 +debug : False # Whether to toggle debig messages during processing
  36 +reprocess : False # Whether to reprocess formerly processed files
  37 +
  38 +exec_dir : '/media/sf_F_DRIVE/processing/' # Location of the exectutable folder
  39 +cStarlight_dir : 'CStarlight_bin/bin_nix64/' # Location of cStarlight
  40 +rawtoLev0_exe : 'raw_to_Lev0' # name of the raw to level 0 executable
  41 +rawtoLev0_cfg : 'L0_gps_settings.txt' # Location of raw to lev0 settings
  42 +
  43 +# Location of raw file converter executable
  44 +decompress_exe : 'dataConverters/raw_to_1bit_bin_IF_3ch_skip500kS'
  45 +
  46 +# Celestrak URL for retreiving GPS orbit file
  47 +clstrack_URL : 'http://celestrak.com/GPS/almanac/Yuma/2015/almanac.yuma.week0'
  48 +
  49 +# Antenna radiation pattern folder
  50 +ant_dir : '/media/sf_F_DRIVE/ant_rad_pat/'
  51 +
  52 +ant_ZR : 'Antcom_RHCP_GP_BCMA' # ZR Antenna Radiation pattern
  53 +ant_NL : 'Cobham_LHCP_GP' # NL Antenna Radiation pattern
  54 +ant_NR : 'Cobham_RHCP_GP' # NR Antenna Radiation pattern
  55 +
  56 +ant_amp_ZR : 33 # ZR Antenna LNA gain
  57 +ant_amp_NL : 0 # NL Antenna LNA gain
  58 +ant_amp_NR : 0 # NR Antenna LNA gain
  59 +
  60 +
  61 +## Filters
  62 +
  63 +thresh_elev : 30 # Minimum elevation threshold in deg
  64 +thresh_altOG : 15 # Minimum altitude over ground threshold in meters
  65 +thresh_gSpeed : 10 # Minimum speed over ground threshold in m/s
  66 +min_pZR : 0.02 # Minimum Direct correlation amplitude threshold
  67 +min_el_zen : 87.5 # Minimum zenith antenna elevation pointing threshold in deg
  68 +
  69 +## Receiver
  70 +
  71 +fs : 10000000. # Sampling Frequency
  72 +fif : 2500000. # IF frequency
  73 +fc : 1575420000. # GPS L1 signal center frequency
  74 +nbits : 2 # Number of bits per sample in raw file
  75 +nch : 4 # number of channels in raw file
  76 +delta_d_ant : 3.0 # vertical distance between direct and reflected antennas
  77 +ch_bias : 1 # Estimated geometrical bias in meters (Reflected - Direct)
  78 +delta_min : 0 # Estimated difference between filename stamp and UTC (min)
  79 +delta_sec : 0 # Estimated difference between filename stamp and UTC (sec)
  80 +
  81 +
  82 +## Plotting
  83 +
  84 +lowres_step : 2 # Period in seconds when time resampling the data fro plotting
  85 +kml_marker_type : 'point' # 'point' or 'ellipse' (estimated 1st Fresnel zone)
  86 +
  87 +
  88 +## Constants
  89 +
  90 +c : 299792458. # speed of light
... ...