Skip to content

Configuration files

This section describes the various ways in which to configure shared AutoBernese settings and build templates for campaign-specific configuration files.

Configuration kinds and their locations

The types of configuration are shown in the table below:

File Location Purpose
env.yaml Inside the package Integrate with activated Bernese environment and provide default settings.
autobernese.yaml AutoBernese runtime directory Let users add data sources, campaign-creation setup and station sitelog settings.
<campaign-type>.yaml templates directory in runtime directory let users have pre-set campaign configuration for campaigns of the same type.

The details of each kind is explained below.

Campaign-configuration templates included in the package

There are also a couple of default campaign templates that come with the package:

  • A default campaign which is empty.
    • Usage: Selected by default if none given by the user.
  • A campaign-template for the example campaign.
    • This is a special campaign template that does not use the dates given by the user, but which overrules them with the dates for which there are data in the campaign EXAMPLE that comes with Bernese 5.4.
    • Usage: copy this template into the EXAMPLE campaign and add a metadata section.

The built-in configuration file

The AutoBernese package comes with a built-in configuration that:

  • Determines what environment variables set by the LOADGPS.setvar script to load into AutoBernese. These, in turn, are made available for re-use in other configuration settings, so that can these integrate into relevant Bernese directories such as the DATAPOOL [${D}] and SAVEDISK [${S}] areas.

  • Enables AutoBernese to create a directory for runtime files at the same directory level as the activated Bernese-installation directory. Runtime files are the logfile, campaign templates and a file with configuration overrides for common user settings.

  • Provides default settings for campaign creation, external-data source specification and sitelog-to-STA file transformation, the latter being a specific need we have at the agency.

The built-in configuration file is prepended the campaign-specific configuration files, so that the relative paths and other data can be re-used here as well. (More on this later below.)

Look at the built-in configuration file
Built-in configuration file `env.yaml`
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Bernese GNSS Software [BSW] environment variables available after 'source'ing
# the shell script `LOADGPS.setvar` in the root of the installation directory.
bsw_env:

  # Installation directory
  C: &C !ENV C

  # Bernese documentation files
  DOC: &DOC !ENV DOC

  # Built-in Bernese program panels
  PAN: &PAN !ENV PAN

  # Global model files used by Bernese programs
  MODEL: &MODEL !ENV MODEL

  # Global configuration file used by Bernese programs
  CONFIG: &CONFIG !ENV CONFIG

  # DATAPOOL directory
  D: &D !ENV D

  # CAMPAIGN directory
  P: &P !ENV P

  # SAVEDISK directory
  S: &S !ENV S

  # User directory
  U: &U !ENV U

  # Temporary directory
  T: &T !ENV T

# Specific files in the Bernese environment that we need to access
bsw_files:

  # Release-information file
  release_info: !Path [*DOC, RELEASE.TXT]

  # README files
  # readme_files: !Path [*DOC, README*]

  # Input file with the list of existing Bernese campaigns
  campaign_menu: !Path [*PAN, MENU_CMP.INP]

  # CPU files in the user-environment program panels directory
  cpu_files: !Path [*U, PAN, '*.CPU']

  # SAVEDISK `_REF` files
  # Slows down reading of the configuration file
  # reference_output: !Path [*S, '**', '*_REF']

  # Reference files and expected products for the EXAMPLE campaign.
  check_install:

  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD]
  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD]

  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD]
  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD]

  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD]
  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD]

# We define the environment root directory as the one containing the BSW
# installation. It is assumed to be a directory that each user can can write to.
env: &env !Parent [*C]

# AutoBernese runtime environment
runtime:

  # Root of the package's runtime files
  ab: &ab !Path [*env, autobernese]

  logging:
    filename: !Path [*ab, autobernese.log]
    # Special parameters that can be added here are:
    # `{user}` which adds the username using Python's getpass.getuser().
    format: '%(asctime)s | {user} | %(levelname)s | %(name)s | %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '%'
    level: DEBUG

  # Directory of the user-defined templates for each campaign-type's
  # configuration.
  campaign_templates: !Path [*ab, templates]

  # Filename for the user-defined configuration.
  user_config: !Path [*ab, autobernese.yaml]

  # Sections that the user can override in the general configuration.
  user_sections:
  - station
  - troposphere
  - campaign
  - sources

## Default sections that can be overriden by the user

station:
  # The following key-value pairs are arguments to the sitelog parser and can
  # not be changed.
  #
  # * `sitelogs`
  # * `individually_calibrated`
  # * `output_sta_file`
  #
  sitelogs: !Path [*D, sitelogs, '*.log']
  individually_calibrated: []
  output_sta_file: !Path [*D, station, sitelogs.STA]

campaign:

  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources: []
Built-in configuration file `env.yaml`
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Bernese GNSS Software [BSW] environment variables available after 'source'ing
# the shell script `LOADGPS.setvar` in the root of the installation directory.
bsw_env:

  # Installation directory
  C: &C !ENV C

  # Bernese documentation files
  DOC: &DOC !ENV DOC

  # Built-in Bernese program panels
  PAN: &PAN !ENV PAN

  # Global model files used by Bernese programs
  MODEL: &MODEL !ENV MODEL

  # Global configuration file used by Bernese programs
  CONFIG: &CONFIG !ENV CONFIG

  # DATAPOOL directory
  D: &D !ENV D

  # CAMPAIGN directory
  P: &P !ENV P

  # SAVEDISK directory
  S: &S !ENV S

  # User directory
  U: &U !ENV U

  # Temporary directory
  T: &T !ENV T

# Specific files in the Bernese environment that we need to access
bsw_files:

  # Release-information file
  release_info: !Path [*DOC, RELEASE.TXT]

  # README files
  # readme_files: !Path [*DOC, README*]

  # Input file with the list of existing Bernese campaigns
  campaign_menu: !Path [*PAN, MENU_CMP.INP]

  # CPU files in the user-environment program panels directory
  cpu_files: !Path [*U, PAN, '*.CPU']

  # SAVEDISK `_REF` files
  # Slows down reading of the configuration file
  # reference_output: !Path [*S, '**', '*_REF']

  # Reference files and expected products for the EXAMPLE campaign.
  check_install:

  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD]
  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD]

  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD]
  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD]

  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD]
  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD]

# We define the environment root directory as the one containing the BSW
# installation. It is assumed to be a directory that each user can can write to.
env: &env !Parent [*C]

# AutoBernese runtime environment
runtime:

  # Root of the package's runtime files
  ab: &ab !Path [*env, autobernese]

  logging:
    filename: !Path [*ab, autobernese.log]
    # Special parameters that can be added here are:
    # `{user}` which adds the username using Python's getpass.getuser().
    format: '%(asctime)s | {user} | %(levelname)s | %(name)s | %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '%'
    level: DEBUG

  # Directory of the user-defined templates for each campaign-type's
  # configuration.
  campaign_templates: !Path [*ab, templates]

  # Filename for the user-defined configuration.
  user_config: !Path [*ab, autobernese.yaml]

  # Sections that the user can override in the general configuration.
  user_sections:
  - station
  - troposphere
  - campaign
  - sources

## Default sections that can be overriden by the user

station:
  # The following key-value pairs are arguments to the sitelog parser and can
  # not be changed.
  #
  # * `sitelogs`
  # * `individually_calibrated`
  # * `output_sta_file`
  #
  sitelogs: !Path [*D, sitelogs, '*.log']
  individually_calibrated: []
  output_sta_file: !Path [*D, station, sitelogs.STA]

campaign:

  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources: []
Built-in configuration file `env.yaml`
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Bernese GNSS Software [BSW] environment variables available after 'source'ing
# the shell script `LOADGPS.setvar` in the root of the installation directory.
bsw_env:

  # Installation directory
  C: &C !ENV C

  # Bernese documentation files
  DOC: &DOC !ENV DOC

  # Built-in Bernese program panels
  PAN: &PAN !ENV PAN

  # Global model files used by Bernese programs
  MODEL: &MODEL !ENV MODEL

  # Global configuration file used by Bernese programs
  CONFIG: &CONFIG !ENV CONFIG

  # DATAPOOL directory
  D: &D !ENV D

  # CAMPAIGN directory
  P: &P !ENV P

  # SAVEDISK directory
  S: &S !ENV S

  # User directory
  U: &U !ENV U

  # Temporary directory
  T: &T !ENV T

# Specific files in the Bernese environment that we need to access
bsw_files:

  # Release-information file
  release_info: !Path [*DOC, RELEASE.TXT]

  # README files
  # readme_files: !Path [*DOC, README*]

  # Input file with the list of existing Bernese campaigns
  campaign_menu: !Path [*PAN, MENU_CMP.INP]

  # CPU files in the user-environment program panels directory
  cpu_files: !Path [*U, PAN, '*.CPU']

  # SAVEDISK `_REF` files
  # Slows down reading of the configuration file
  # reference_output: !Path [*S, '**', '*_REF']

  # Reference files and expected products for the EXAMPLE campaign.
  check_install:

  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD]
  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD]

  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD]
  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD]

  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD]
  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD]

# We define the environment root directory as the one containing the BSW
# installation. It is assumed to be a directory that each user can can write to.
env: &env !Parent [*C]

# AutoBernese runtime environment
runtime:

  # Root of the package's runtime files
  ab: &ab !Path [*env, autobernese]

  logging:
    filename: !Path [*ab, autobernese.log]
    # Special parameters that can be added here are:
    # `{user}` which adds the username using Python's getpass.getuser().
    format: '%(asctime)s | {user} | %(levelname)s | %(name)s | %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '%'
    level: DEBUG

  # Directory of the user-defined templates for each campaign-type's
  # configuration.
  campaign_templates: !Path [*ab, templates]

  # Filename for the user-defined configuration.
  user_config: !Path [*ab, autobernese.yaml]

  # Sections that the user can override in the general configuration.
  user_sections:
  - station
  - troposphere
  - campaign
  - sources

## Default sections that can be overriden by the user

station:
  # The following key-value pairs are arguments to the sitelog parser and can
  # not be changed.
  #
  # * `sitelogs`
  # * `individually_calibrated`
  # * `output_sta_file`
  #
  sitelogs: !Path [*D, sitelogs, '*.log']
  individually_calibrated: []
  output_sta_file: !Path [*D, station, sitelogs.STA]

campaign:

  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources: []
Built-in configuration file `env.yaml`
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Bernese GNSS Software [BSW] environment variables available after 'source'ing
# the shell script `LOADGPS.setvar` in the root of the installation directory.
bsw_env:

  # Installation directory
  C: &C !ENV C

  # Bernese documentation files
  DOC: &DOC !ENV DOC

  # Built-in Bernese program panels
  PAN: &PAN !ENV PAN

  # Global model files used by Bernese programs
  MODEL: &MODEL !ENV MODEL

  # Global configuration file used by Bernese programs
  CONFIG: &CONFIG !ENV CONFIG

  # DATAPOOL directory
  D: &D !ENV D

  # CAMPAIGN directory
  P: &P !ENV P

  # SAVEDISK directory
  S: &S !ENV S

  # User directory
  U: &U !ENV U

  # Temporary directory
  T: &T !ENV T

# Specific files in the Bernese environment that we need to access
bsw_files:

  # Release-information file
  release_info: !Path [*DOC, RELEASE.TXT]

  # README files
  # readme_files: !Path [*DOC, README*]

  # Input file with the list of existing Bernese campaigns
  campaign_menu: !Path [*PAN, MENU_CMP.INP]

  # CPU files in the user-environment program panels directory
  cpu_files: !Path [*U, PAN, '*.CPU']

  # SAVEDISK `_REF` files
  # Slows down reading of the configuration file
  # reference_output: !Path [*S, '**', '*_REF']

  # Reference files and expected products for the EXAMPLE campaign.
  check_install:

  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD]
  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD]

  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD]
  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD]

  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD]
  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD]

# We define the environment root directory as the one containing the BSW
# installation. It is assumed to be a directory that each user can can write to.
env: &env !Parent [*C]

# AutoBernese runtime environment
runtime:

  # Root of the package's runtime files
  ab: &ab !Path [*env, autobernese]

  logging:
    filename: !Path [*ab, autobernese.log]
    # Special parameters that can be added here are:
    # `{user}` which adds the username using Python's getpass.getuser().
    format: '%(asctime)s | {user} | %(levelname)s | %(name)s | %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '%'
    level: DEBUG

  # Directory of the user-defined templates for each campaign-type's
  # configuration.
  campaign_templates: !Path [*ab, templates]

  # Filename for the user-defined configuration.
  user_config: !Path [*ab, autobernese.yaml]

  # Sections that the user can override in the general configuration.
  user_sections:
  - station
  - troposphere
  - campaign
  - sources

## Default sections that can be overriden by the user

station:
  # The following key-value pairs are arguments to the sitelog parser and can
  # not be changed.
  #
  # * `sitelogs`
  # * `individually_calibrated`
  # * `output_sta_file`
  #
  sitelogs: !Path [*D, sitelogs, '*.log']
  individually_calibrated: []
  output_sta_file: !Path [*D, station, sitelogs.STA]

campaign:

  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources: []
Built-in configuration file `env.yaml`
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
# Bernese GNSS Software [BSW] environment variables available after 'source'ing
# the shell script `LOADGPS.setvar` in the root of the installation directory.
bsw_env:

  # Installation directory
  C: &C !ENV C

  # Bernese documentation files
  DOC: &DOC !ENV DOC

  # Built-in Bernese program panels
  PAN: &PAN !ENV PAN

  # Global model files used by Bernese programs
  MODEL: &MODEL !ENV MODEL

  # Global configuration file used by Bernese programs
  CONFIG: &CONFIG !ENV CONFIG

  # DATAPOOL directory
  D: &D !ENV D

  # CAMPAIGN directory
  P: &P !ENV P

  # SAVEDISK directory
  S: &S !ENV S

  # User directory
  U: &U !ENV U

  # Temporary directory
  T: &T !ENV T

# Specific files in the Bernese environment that we need to access
bsw_files:

  # Release-information file
  release_info: !Path [*DOC, RELEASE.TXT]

  # README files
  # readme_files: !Path [*DOC, README*]

  # Input file with the list of existing Bernese campaigns
  campaign_menu: !Path [*PAN, MENU_CMP.INP]

  # CPU files in the user-environment program panels directory
  cpu_files: !Path [*U, PAN, '*.CPU']

  # SAVEDISK `_REF` files
  # Slows down reading of the configuration file
  # reference_output: !Path [*S, '**', '*_REF']

  # Reference files and expected products for the EXAMPLE campaign.
  check_install:

  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190440.CRD]
  - reference: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD_REF]
    result: !Path [*S, RNX2SNX, '2019', STA, FIN_20190450.CRD]

  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201790.CRD]
  - reference: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD_REF]
    result: !Path [*S, RNX2SNX, '2020', STA, FIN_20201800.CRD]

  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210950.CRD]
  - reference: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD_REF]
    result: !Path [*S, RNX2SNX, '2021', STA, FIN_20210960.CRD]

# We define the environment root directory as the one containing the BSW
# installation. It is assumed to be a directory that each user can can write to.
env: &env !Parent [*C]

# AutoBernese runtime environment
runtime:

  # Root of the package's runtime files
  ab: &ab !Path [*env, autobernese]

  logging:
    filename: !Path [*ab, autobernese.log]
    # Special parameters that can be added here are:
    # `{user}` which adds the username using Python's getpass.getuser().
    format: '%(asctime)s | {user} | %(levelname)s | %(name)s | %(message)s'
    datefmt: '%Y-%m-%d %H:%M:%S'
    style: '%'
    level: DEBUG

  # Directory of the user-defined templates for each campaign-type's
  # configuration.
  campaign_templates: !Path [*ab, templates]

  # Filename for the user-defined configuration.
  user_config: !Path [*ab, autobernese.yaml]

  # Sections that the user can override in the general configuration.
  user_sections:
  - station
  - troposphere
  - campaign
  - sources

## Default sections that can be overriden by the user

station:
  # The following key-value pairs are arguments to the sitelog parser and can
  # not be changed.
  #
  # * `sitelogs`
  # * `individually_calibrated`
  # * `output_sta_file`
  #
  sitelogs: !Path [*D, sitelogs, '*.log']
  individually_calibrated: []
  output_sta_file: !Path [*D, station, sitelogs.STA]

campaign:

  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources: []

Common user configuration file

As mentioned above, a few sections of the built-in AutoBernese configuration can be overridden with a common user configuration file autobernese in the AutoBernese runtime directory.

Environment-specific files in the AutoBernese runtime directory
/path/to/environment
├── autobernese
│   ├── autobernese.log  # Log file with user-separable entries
│   ├── autobernese.yaml # Users can (and should) add this to configure
│   │                    # campaign setup and external-data download
│   │
│   └── (...)
│
├── BERN54
└── (...)

With this file, users may configure the following:

  • Common sources of external data
  • The directory structure of a new Bernese campaign
  • Settings for generating a STA-file from station site-log files
Configuration overrides in `autobernese/autobernese.yaml`
campaign:
  directories:
  - name: ATM
  - name: BPE
  - name: GEN
    files:
    - !Path [*CONFIG, OBSERV.SEL]
    - !Path [*PAN, SESSIONS.SES]
  - name: GRD
  - name: OBS
  - name: ORB
  - name: ORX
  - name: OUT
  - name: RAW
  - name: SOL
  - name: STA

sources:

- !Source
  identifier: EUREF_STA
  description: EUREF STA file from epncb
  url: ftp://epncb.oma.be/pub/station/general/EUREF.STA
  destination: !Path [*D, station]
  max_age: 1

Campaign-specific configuration files

Campaign-specific sources and, especially, PCF files to run with BPE, are managed from a campaign-specific configuration file in the root of a Bernese campaign directory.

Environment-specific files in the AutoBernese runtime directory
/path/to/CAMPAIGN54
├── EXAMPLE
│   ├── (...)
│   └── campaign.yaml
│
└── (...)

Below is an example of the the campaign-configuration file used for the EXAMPLE campaign:

Configuration used for the EXAMPLE campaign in `$P/EXAMPLE/campaign.yaml`
metadata:
  version: &version 0.3.0
  username: &username USERNAME
  created: &created 2024-04-08
  template: &template example
  campaign: &campaign EXAMPLE
  beg: &beg 2019-02-13
  end: &end 2019-02-14

custom:
  dates: &dates
  - 2019-02-13
  - 2019-02-14
  - 2020-06-27
  - 2020-06-28
  - 2021-04-05
  - 2021-04-06

tasks:

- !BPETask
  identifier: PPP
  description: Precise-Point Positioning
  arguments:
    pcf_file: PPP
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'PPP_{date.doy:0>3d}0'
    status: 'PPP_{date.doy:0>3d}0.RUN'
    taskid: PPP_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: RNX2SNX
  description: RINEX to SINEX
  arguments:
    pcf_file: RNX2SNX
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'RNX2SNX_{date.doy:0>3d}0'
    status: 'RNX2SNX_{date.doy:0>3d}0.RUN'
    taskid: R2S_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: BASTST
  description: |-
    Baseline by baseline processing for trouble shooting
  arguments:
    pcf_file: BASTST
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'BASTST_{date.doy:0>3d}0'
    status: 'BASTST_{date.doy:0>3d}0.RUN'
    taskid: BASTST_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: CLKDET
  description: |-
    Zero-difference network solution providing clock corrections
  arguments:
    pcf_file: CLKDET
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'CLKDET_{date.doy:0>3d}0'
    status: 'CLKDET_{date.doy:0>3d}0.RUN'
    taskid: CLKDET_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: IONDET
  description: |-
    Zero-difference network solution providing station-wise, regional, or global
    ionosphere maps and the related biases
  arguments:
    pcf_file: IONDET
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'IONDET_{date.doy:0>3d}0'
    status: 'IONDET_{date.doy:0>3d}0.RUN'
    taskid: IONDET_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: LEOPOD
  description: |-
    Precise Orbit Determination for a Low Earth Orbiting Satellites based on
    on-board GPS-measurements with phase ambiguity resolution
  arguments:
    pcf_file: LEOPOD
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'LEOPOD_{date.doy:0>3d}0'
    status: 'LEOPOD_{date.doy:0>3d}0.RUN'
    taskid: LEOPOD_{date.doy:0>3d}0
  parameters:
    date: !DateRange {beg: *beg, end: *end}

- !BPETask
  identifier: SLRVAL
  description: |-
    Validation of an existing GNSS or LEO orbit using SLR measurements
  arguments:
    pcf_file: SLRVAL
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'SLRVAL_{date.doy:0>3d}0'
    status: 'SLRVAL_{date.doy:0>3d}0.RUN'
    taskid: SLRVAL_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: ITRF
  description: |-
    Derives a coordinate and linear velocity approximation from the ITRF
    solution containing non-linear PSD corrections
  arguments:
    pcf_file: ITRF
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'ITRF_{date.doy:0>3d}0'
    status: 'ITRF_{date.doy:0>3d}0.RUN'
    taskid: ITRF_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

sources:

- !Source
  identifier: ITRF14
  description: IERS data needed for the EXAMPLE campaign
  url: https://datacenter.iers.org/products/reference-systems/terrestrial/itrf/itrf2014/
  filenames:
  - ITRF2014-IGS-TRF.SNX.gz  # 1.4 GB
  - ITRF2014-psd-gnss.dat  # 38 KB
  destination: !Path [*D, ITRF14]

The metadata section

The metadata section contains data about the campaign. The first four items in the dictionary contain the context in which the campaign was created. version refers to the AutoBernese version, username is the user that created the campaign, created is the campaign-creation time, and template is the filename without suffix for the campaign template that was used to create the [in this case example.yaml].

The last three items are shortcuts available, primarily, for the tasks in the tasks section below. The string value in campaign is the name of the directory in the campaign directory containing the Bernese campaign. The YAML anchor &campaign can be resolved in other places in the YAML document to re-use the string value, in this case EXAMPLE. this is particularly useful for specifying BPE tasks to be run for the campaign, since the campaign name, thanks to the YAML specification, need not be repeated explicitly, but can be written once. The same is the case for the items beg and end which denote the beginning and end date [both included] that the campaign covers.

The metadata section is there, because the data written here can be referred to in the rest of the document using the YAML anchors [the words starting with &...] prefixing the values for each key in the section. The keys are seen in the task lists, which is explained below.

The tasks section

A task in the list of tasks is something that is runnable by AutoBernese. Each list item specifies something that AutoBernese may initialise and start, when user decides to 'run' the campaign.

For now, AutoBernese only has one type of task, which is the primary goal of the first release: The concept of a BPETask. Using the YAML tag !BPETask before the content of the list-item, AutoBernese will run the BPE Perl module that is included in BSW.

tasks:

- !BPETask
  identifier: PPP
  description: Run PPP for the EXAMPLE campaign
  arguments:
    pcf_file: PPP
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'PPP_{date.doy:0>3d}0'
    status: 'PPP_{date.doy:0>3d}0.RUN'
    taskid: PP
  parameters:
    date: !DateRange {beg: *beg, end: *end}

Here, the YAML anchor &campaign is referred to with the syntax *campaign [a YAML alias] so that, in this case, the name of the campaign directory is inserted, when the configuration file is loaded.

Some of the strings given to the other items, e.g. year and session are Python format strings [more on this below]. The date reference is an AutoBernese GPSDate which has the day-of-year property doy that can be used inside the strings.

To use template strings requires that a parameters item is included as part of the BPETask. The parameters dictionary must have items with the keys used inside the Python format strings. The values must be a sequence of possible values.

In this case, the value of date in the parameters dictionary is another AutoBernese construction, denoted with the YAML tag !DateRange. When resolved as the document is loaded, the value of dateis a list of AutoBernese GPSDdate instances, one for each day in the interval specified. Here, the power of the metadata section is seen, as the dates defining the Bernese-campaign interval are referenced by their YAML alias. The user therefore only needs to write these dates once during campaign-creation time.

When runnning the tasks, each task is resolved to the concrete set of possible values that BPE can receive, and the BPE is run for each concrete given by the task specification. In this case, the BPE will run for each of three days that the EXAMPLE campaign stretches over.

The sources section

Campaign-specific sources of external data can be specified in a sources section in the campaign configuration.

As illustrated in the EXAMPLE-campaign configuration file, a single FTP source with two files needed for the built-in process-control file ITRF.PCF is included so that the data can be downloaded to the DATAPOOL area to be used in this (and in this case, other) campaigns.

The purpose of the configuration-specific sources section is that a given campaign type may need, well, specific data for that campaign.

The clean section [not shown]

Available since: version 0.3.3

With the campaign command clean, it is possible to specify directories at the root of the campaign directory which will have their entire content deleted, if the user grants it when prompted.

To use the clean command, add a clean section to the campaign (template) configuration and provide a list of directories that exist at the root of the campaign.

Example of a `clean` section in a campaign-specific configuration file
clean: [SOL, OUT]

Campaign-configuration templates

Based on the assumption that most users do the same things over and over again to different data sets, and thus to avoid copying-and-pasting recurring processing workflow between Bernese campaigns, AutoBernese has the concept of a campaign type which is defined by a template campaign-configuration file in the templates directory of the AutoBernese runtime directory.

Adding different templates for different campaign scenarios, i.e. campaign types, will speed up the process of creating a new campaign, getting it ready by downloading data, and running the BPE tasks set in the campaign-specific configuration file.

Campaign-configuration templates can be put in the AutoBernese runtime directory:

Campaign-configuration template location in the AutoBernese runtime directory
/path/to/environment
├── autobernese
│   ├── (...)
│   └── templates        # Directory for user-created templates,
│       │                # one for each campaign type
│       │
│       ├── default.yaml # This default file is used as
│       │                # template if none specified.
│       │
│       └── example.yaml # Example of a user-created template
│                        # for campaign type named `example`.
│
├── BERN54
└── ...

Below is an example of the campaign-configuration template example.yaml:

Template based on the EXAMPLE-campaign configuration
# /path/to/environment/autobernese/templates/example.yaml
custom:
  dates: &dates
  - 2019-02-13
  - 2019-02-14
  - 2020-06-27
  - 2020-06-28
  - 2021-04-05
  - 2021-04-06

tasks:

- !BPETask
  identifier: PPP
  description: Precise-Point Positioning
  arguments:
    pcf_file: PPP
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'PPP_{date.doy:0>3d}0'
    status: 'PPP_{date.doy:0>3d}0.RUN'
    taskid: PPP_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: RNX2SNX
  description: RINEX to SINEX
  arguments:
    pcf_file: RNX2SNX
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'RNX2SNX_{date.doy:0>3d}0'
    status: 'RNX2SNX_{date.doy:0>3d}0.RUN'
    taskid: R2S_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: BASTST
  description: |-
    Baseline by baseline processing for trouble shooting
  arguments:
    pcf_file: BASTST
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'BASTST_{date.doy:0>3d}0'
    status: 'BASTST_{date.doy:0>3d}0.RUN'
    taskid: BASTST_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: CLKDET
  description: |-
    Zero-difference network solution providing clock corrections
  arguments:
    pcf_file: CLKDET
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'CLKDET_{date.doy:0>3d}0'
    status: 'CLKDET_{date.doy:0>3d}0.RUN'
    taskid: CLKDET_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: IONDET
  description: |-
    Zero-difference network solution providing station-wise, regional, or global
    ionosphere maps and the related biases
  arguments:
    pcf_file: IONDET
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'IONDET_{date.doy:0>3d}0'
    status: 'IONDET_{date.doy:0>3d}0.RUN'
    taskid: IONDET_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: LEOPOD
  description: |-
    Precise Orbit Determination for a Low Earth Orbiting Satellites based on
    on-board GPS-measurements with phase ambiguity resolution
  arguments:
    pcf_file: LEOPOD
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'LEOPOD_{date.doy:0>3d}0'
    status: 'LEOPOD_{date.doy:0>3d}0.RUN'
    taskid: LEOPOD_{date.doy:0>3d}0
  parameters:
    date: !DateRange {beg: *beg, end: *end}

- !BPETask
  identifier: SLRVAL
  description: |-
    Validation of an existing GNSS or LEO orbit using SLR measurements
  arguments:
    pcf_file: SLRVAL
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'SLRVAL_{date.doy:0>3d}0'
    status: 'SLRVAL_{date.doy:0>3d}0.RUN'
    taskid: SLRVAL_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

- !BPETask
  identifier: ITRF
  description: |-
    Derives a coordinate and linear velocity approximation from the ITRF
    solution containing non-linear PSD corrections
  arguments:
    pcf_file: ITRF
    campaign: *campaign
    year: '{date.year}'
    session: '{date.doy:0>3d}0'
    sysout: 'ITRF_{date.doy:0>3d}0'
    status: 'ITRF_{date.doy:0>3d}0.RUN'
    taskid: ITRF_{date.doy:0>3d}0
  parameters:
    date: !AsGPSDate [*dates]
    # date: *dates

sources:

- !Source
  identifier: ITRF14
  description: IERS data needed for the EXAMPLE campaign
  url: https://datacenter.iers.org/products/reference-systems/terrestrial/itrf/itrf2014/
  filenames:
  - ITRF2014-IGS-TRF.SNX.gz  # 1.4 GB
  - ITRF2014-psd-gnss.dat  # 38 KB
  destination: !Path [*D, ITRF14]

As seen above, the difference between a campaign-configuration file and its template it the metadata section that is part of the concrete Bernese campaign. AutoBernese adds the metadata section automatically, but a user can also ad it manually, if the configuration is made for an existing campaign such as the EXAMPLE campaign.

Using a campaign-specific configuration file in the root of a Bernese-campaign directory, AutoBernese is able to do two things at the campaign level:

  1. Download campaign-specific data from sources specified in the same way as in the general AutoBernese configuration file.
  2. Run the Bernese Processing Engine for PCF files with campaign-specific settings.

AutoBernese lets a user define configuration templates for common campaign scenarios, where the only difference is in the time interval for which a given campaign is created and run.

A default campaign template default.yaml is added to the autobernese directory, automatically, when the command ab campaign is run. If the file already exists, AutoBernese does nothing.

As the user create a campaign with AutoBernese, if no other template name is specified, the default campaign template is used. Therefore, this file should be edited to suit the most common scenario. Even so, having more than one configuration template will make common scenarios faster to setup.

With this template-management system, you only need to set up your Bernese campaigns once, or rarely. AS it is only the presence of the configuration file that enables AutoBernese to do its work, existing campaigns can be 'runable' with AutoBernese by adding a campaign-configuration file to those campaign directories.

Notes on Python-string templates in YAML documents

Python has multiple ways to work with strings, and many of the string-values given in the AutoBernese configuration files have content that requires soe knowldge about Python's Template strings. In addition, the format of these strings may clash with the YAML syntax, so a few potential problems and solutions are shown below.

Difference between Template strings and f string syntax

This example shows the difference in Python syntax between two Python-string types:

import datetime as dt

date = dt.date(2019, 2, 13)
date.day
# 13
f'{date.day}'
# '13'
f'{date.day:3d}'
# ' 13'
f'{date.day:03d}'
# '013'

import datetime as dt

date = dt.date(2019, 2, 13)
date.day
# 13
'{date.day}'.format(date=date)
# '13'
'{date.day:3d}'.format(date=date)
# ' 13'
'{date.day:03d}'.format(date=date)
# '013'

String templates are used in the YAML files that are used as configuration-file format.

Clash with the the YAML syntax

There is a subtle drawback in clarity, when the string template begins with a template part, since it clashes with the YAML syntax for a mapping which also begins and ends with { and }, respectively. In these cases, one must, explicitly, put quotes around the string:

Example
import yaml
s = """\
some configuration key: a string with {date.day}
another configuration key: {template} is at the beginning of the string.
"""
yaml.safe_load(s)
Output
# Output:
# ParserError: while parsing a block mapping
#   in "<unicode string>", line 1, column 1:
#     some configuration key: a string ...
#     ^
# expected <block end>, but found '<scalar>'
#   in "<unicode string>", line 2, column 37:
#     another configuration key: {prefix} is at the beginning of the string.
Example
import yaml
s = """\
some configuration key: a string with {date.day}
another configuration key: '{template} is at the beginning of the string.'
"""
yaml.safe_load(s)
Output
# Output:
# {
#   'some configuration key': 'a string with {date.day}',
#  'another configuration key': '{template} is at the beginning of the string.'
# }