From 987bed7a79c9edf2f6ee3055abc8315823ebfe87 Mon Sep 17 00:00:00 2001 From: Erwan Motte Date: Fri, 3 Jun 2016 16:44:12 +0200 Subject: [PATCH] Updated the documentation with sample config files for processing --- source/PRO/PRO_config.rst | 45 ++++++++++++++++++++++++++++++++++++++++++++- source/PRO/PRO_index.rst | 2 ++ source/blocks.rst | 2 +- source/examples/config/flight_conf.yaml | 27 +++++++++++++++++++++++++++ source/examples/config/proc_conf.yaml | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 164 insertions(+), 2 deletions(-) create mode 100644 source/examples/config/flight_conf.yaml create mode 100644 source/examples/config/proc_conf.yaml diff --git a/source/PRO/PRO_config.rst b/source/PRO/PRO_config.rst index 12e641d..bed7c73 100644 --- a/source/PRO/PRO_config.rst +++ b/source/PRO/PRO_config.rst @@ -1,3 +1,46 @@ ********************* Configuration files -********************* \ No newline at end of file +********************* + +Description / Purpose +===================== + +The configuration files are written in order to be able to select the working +dir, the data to be processed and also to tune processing parameters. +It is recommended for configuration files to have explicit names +or to be saved in folders with explicit names, in order to directly identify +the specific parameters (e.g. *Flight_39_t_incoh_50ms.cfg*) + + +The configuration files are separated in two files: + +- One flight containing campaign and processing specific data. + +- One file containing flight specific data, calling the flight/processing file + +The configuration files are written in plain text, following the +YAML specifications. The basic fields will be described in this section, +while the module dependant settings will be detailed in the corresponding +module description, under the “input” section. + + +Flight configuration file +------------------------- + +Down below is an example of a commented flight configuration file +( *flight_conf.yaml* ) with all the available keywords and their definition. + +.. literalinclude:: /examples/config/flight_conf.yaml + :linenos: + :language: yaml + + +Processing configuration file +----------------------------- + +Down below is an example of a commented processing configuration file +( *proc_conf.yaml* ) with all the available keywords and their definition. + +.. literalinclude:: /examples/config/proc_conf.yaml + :linenos: + :language: yaml \ No newline at end of file diff --git a/source/PRO/PRO_index.rst b/source/PRO/PRO_index.rst index 69dfd7f..7c5ae03 100644 --- a/source/PRO/PRO_index.rst +++ b/source/PRO/PRO_index.rst @@ -1,3 +1,5 @@ +.. _Processing: + ********** Processing ********** diff --git a/source/blocks.rst b/source/blocks.rst index 5615b49..646423a 100644 --- a/source/blocks.rst +++ b/source/blocks.rst @@ -13,7 +13,7 @@ blocks where identified: interfaces with the plane, and all the way to raw data and ancillary data storage. -- **Processing (PRO)**: Data processing routines, +- :ref:`Processing` **(PRO)**: Data processing routines, from ancillary data to L1b data, and plotting routines. - **Ground truth data (GTD)**: Description of all the geo-referenced diff --git a/source/examples/config/flight_conf.yaml b/source/examples/config/flight_conf.yaml new file mode 100644 index 0000000..162554a --- /dev/null +++ b/source/examples/config/flight_conf.yaml @@ -0,0 +1,27 @@ +# Flight Info + +flight_id : 'GLORIE_Flight_2' +desc : 'GLORIE Flight 2, Short' +date : '2015-06-22' + +min_dt : '1979-12-23-103000' +max_dt : '2079-12-23-103000' + +# Base Paths + +base_dir : '/media/sf_F_DRIVE/2015-06_Campagne_GLORIE/' +flight_dir : '20150622_Flight_2_Short/' + +# Ancillary Data + +ubx_dir : 'UBlox/' +ubx_prefix : 'COM12_150622_052826' +ubx_type : 'UBX_ONLY' + +SAFIRE_dir : 'SAFIRE/' +SAFIRE_file : 'as150002_5.xlsx' +SAFIRE_type : 'xls' + +leapsec : 16 + +proc_settings : proc_settings/GLORIE2015_v0.cfg \ No newline at end of file diff --git a/source/examples/config/proc_conf.yaml b/source/examples/config/proc_conf.yaml new file mode 100644 index 0000000..70d9f6f --- /dev/null +++ b/source/examples/config/proc_conf.yaml @@ -0,0 +1,90 @@ +## Raw data Paths + +Flight_dir : 'SDRNav/Flight/' +Cal_0_dir : 'SDRNav/Cal_0/' +Cal_1_dir : 'SDRNav/Cal_1/' +Cal_2_dir : 'SDRNav/Cal_2/' +Cal_3_dir : 'SDRNav/Cal_3/' + + +## Output structure + +out_dir : '/media/sf_F_DRIVE/2015-06_Campagne_GLORIE_out/' +anc_dir : 'anc/' +L0_dir : 'L0/01ms/' +calib_dir : 'calib/' +L1a_dir : 'L1a/' +L1b_dir : 'L1b/' +conf_dir : '../conf_05ms/' +tp_dir : 'timepos/' +fig_dir : 'figs/' +kml_dir : 'kml/' +tiff_dir : 'tiffs_cal/' + +# Regexp for parsing date from file names +dt_regex : '(\d{4}-\d{2}-\d{2}-\d{6})' + + +## Processing + +t_coh : 0.005 # Coherent averaging time +t_incoh : 0.200 # time to be integrated +n_sm : 3 # n of samples to be smoothed for interpolation +max_time_diff : 2700 # Maximum interval (seconds) between two measurements + +debug : False # Whether to toggle debig messages during processing +reprocess : False # Whether to reprocess formerly processed files + +exec_dir : '/media/sf_F_DRIVE/processing/' # Location of the exectutable folder +cStarlight_dir : 'CStarlight_bin/bin_nix64/' # Location of cStarlight +rawtoLev0_exe : 'raw_to_Lev0' # name of the raw to level 0 executable +rawtoLev0_cfg : 'L0_gps_settings.txt' # Location of raw to lev0 settings + +# Location of raw file converter executable +decompress_exe : 'dataConverters/raw_to_1bit_bin_IF_3ch_skip500kS' + +# Celestrak URL for retreiving GPS orbit file +clstrack_URL : 'http://celestrak.com/GPS/almanac/Yuma/2015/almanac.yuma.week0' + +# Antenna radiation pattern folder +ant_dir : '/media/sf_F_DRIVE/ant_rad_pat/' + +ant_ZR : 'Antcom_RHCP_GP_BCMA' # ZR Antenna Radiation pattern +ant_NL : 'Cobham_LHCP_GP' # NL Antenna Radiation pattern +ant_NR : 'Cobham_RHCP_GP' # NR Antenna Radiation pattern + +ant_amp_ZR : 33 # ZR Antenna LNA gain +ant_amp_NL : 0 # NL Antenna LNA gain +ant_amp_NR : 0 # NR Antenna LNA gain + + +## Filters + +thresh_elev : 30 # Minimum elevation threshold in deg +thresh_altOG : 15 # Minimum altitude over ground threshold in meters +thresh_gSpeed : 10 # Minimum speed over ground threshold in m/s +min_pZR : 0.02 # Minimum Direct correlation amplitude threshold +min_el_zen : 87.5 # Minimum zenith antenna elevation pointing threshold in deg + +## Receiver + +fs : 10000000. # Sampling Frequency +fif : 2500000. # IF frequency +fc : 1575420000. # GPS L1 signal center frequency +nbits : 2 # Number of bits per sample in raw file +nch : 4 # number of channels in raw file +delta_d_ant : 3.0 # vertical distance between direct and reflected antennas +ch_bias : 1 # Estimated geometrical bias in meters (Reflected - Direct) +delta_min : 0 # Estimated difference between filename stamp and UTC (min) +delta_sec : 0 # Estimated difference between filename stamp and UTC (sec) + + +## Plotting + +lowres_step : 2 # Period in seconds when time resampling the data fro plotting +kml_marker_type : 'point' # 'point' or 'ellipse' (estimated 1st Fresnel zone) + + +## Constants + +c : 299792458. # speed of light -- libgit2 0.21.0