Configuration file details

Configuration File Structure

Defines global settings for the GNSS data processing environment, including paths to software tools and general application settings.

conv_software_paths: Specifies paths to GNSS raw data converters.
- Keys:
  - convbin: Path to RTKLIB converter.
  - mdb2rinex: Path to Leica converter.
  - sbf2rin: Path to Septentrio converter.
  - tps2rin: Path to Topcon converter.
  - t0xconvert: Path to Trimble official converter.
  - trm2rinex: Path to Trimble unofficial docker converter.
  - runpkr00: Path to Trimble legacy converter for TEQC.
  - converto: Path to ConvertoCPP tool.
  - gfzrnx: Path to GFZRNX tool.
  - teqc: Path to TEQC tool.
general:
- log_level: Logging verbosity (e.g., DEBUG, INFO).
- trimble_default_software: Default Trimble converter to use (e.g., trm2rinex).
- cfg_merge_strategy: Strategy for merging configuration files (replace or additive).

Contains station-specific information and configuration.

site: Metadata about the site.
- Keys:
  - operator: Name of the site operator.
  - agency: Name of the managing agency.
  - country: Country name in ISO 3166 format.
  - sitelog_path: Path to site logs (file or directory).
sessions: Defines the characteristics of recording sessions.

Each session is defined under a session_<sessionname> block. It includes the following:

general: General session settings.
- Keys:
  - active: Boolean indicating if the session is active.
  - name: Name of the session.
  - tmp_dir_parent: Parent directory for temporary files.
  - tmp_dir_structure: Directory structure for temporary files.
  - log_dir_parent: Parent directory for log files.
  - log_dir_structure: Directory structure for log files.
epoch_range: Time range for the session.
- Keys:
  - epoch1: Start of the epoch range (e.g., 10 days ago UTC).
  - epoch2: End of the epoch range (e.g., yesterday at 23:59 UTC).
  - period: Time period using Pandas offset aliases (e.g., 1D).
  - round_method: Method to round timestamps (e.g., floor).
  - tz: Timezone for the session (e.g., UTC).
steps: Workflow steps for the session.

Each step represents a specific operation in the workflow (e.g., download, convert, splice, split).

Keys:
- active: Boolean to enable or disable the step.
- inp_dir_parent: Parent directory for input files.
- inp_dir_structure: Directory structure for input files.
- out_dir_parent: Parent directory for output files.
- out_dir_structure: Directory structure for output files.
- epoch_range: Time range for the step (can use FROM_SESSION).
- options: Step-specific options.

download: Downloads GNSS data.
- Options:
  - force: Force re-download of files.
  - remote_find_method: Method to find remote files (ask or guess).
  - invalidate_small_local_files: Invalidate small local files (smaller than few kB) and force their download.
  - timeout: Timeout for remote connections in seconds.
  - max_try: Maximum number of retries for remote connections.
  - sleep_time: Sleep time between retries in seconds.
  - ping_timeout: Timeout for pinging remote servers in seconds.
  - ping_max_try: Maximum number of ping retries.
convert: Converts raw GNSS data to RINEX format.
- Options:
  - force: Force re-conversion of files.
  - converter: Converter to use (e.g., auto).
  - rinexmod_options:
    - compression: Compression format for RINEX files (e.g., gz).
    - longname: Use long file names.
    - force_rnx_load: Force loading of RINEX files.
    - verbose: Enable verbose output.
    - filename_style: Style for file names (e.g., basic).
    - full_history: Keep full history of operations.
    - See rinexmod API documentation for details.

Aliases allow dynamic values in the configuration files. Examples:

Configuration files are modular and can be merged using the cfg_merge_strategy.
Default values are assumed if certain parameters are not explicitly defined.