source: ntrip/trunk/BNC/Example_Configs/00_Readme.md

Last change on this file was 11179, checked in by stuerze, 11 days ago

structuered logging is added and bug is fixed in SP3 file writing

File size: 17.9 KB
Line 
1#### Example Configurations ####
2
3BNC comes with a number of configuration examples which can be used on
4all operating systems. Copy the complete directory \'Example\_Configs\'
5which comes with the software to your disc. It includes sub-directories
6\'Input\' and \'Output\'. There are several ways to start BNC using one
7of the example configurations:
8
9- On graphical systems (except for Mac systems), you may use the
10 computer mouse to \'drag\' a configuration file icon and \'drop\' it
11 on top of BNC\'s program icon.
12- You could also start BNC using a command line for naming a specific
13 configuration file (suggested e.g. for Mac systems):\
14 /Applications/bnc.app/Contents/MacOS/bnc \--conf \<configFileName\>
15- On non-graphical systems or when running BNC in batch mode in the
16 background you may start the program using a command line with a
17 configuration file option in \'[n]{.underline}o
18 [w]{.underline}indow\' mode (example for Windows systems):\
19 bnc.exe \--conf \<configFileName\> \--nw
20
21Although it\'s not a must, we suggest that you always create BNC
22configuration files with filename extension \'.bnc\'.
23
24We furthermore suggest for convenience reasons that you configure your
25system to automatically start BNC when you double-click a file with the
26filename extension \'.bnc\'. The following describes what to do on MS
27Windows systems to associate the BNC program to such configuration
28files:
29
301. Right-click a file that has the extension \'.bnc\' and then click
31 \'Open\'. If the \'Open\' command is not available, click \'Open
32 With\' or double-click the file.
332. Windows displays a dialog box that says that the system cannot open
34 this file. The dialog box offers several options for selecting a
35 program.
363. Click \'Select the program from a list\', and then click \'OK\'.
374. The \'Open With\' dialog box is displayed. Click \'Browse\', locate
38 and then click the BNC program, and then click \'Open\'.
395. Click to select the \'Always use the selected program to open this
40 kind of file\' check box.
416. Click \'OK\'.
42
43Some of the presented example configurations contain a user ID
44\'Example\' with a password \'Configs\' for accessing a few GNSS streams
45from public Ntrip Broadcasters. This free generic account is arranged
46for convenience reasons only. Please be so kind as to replace the
47generic account details as well as the place holder\'s \'User\' and
48\'Pass\' by the personal user ID and password you receive following an
49online registration through <http://register.rtcm-ntrip.org>.
50
51Note that the account for an Ntrip Broadcaster is usually limited to
52pulling a specified maximum number of streams at the same time. As
53running some of the example configurations requires pulling several
54streams, it is suggested to make sure that you do not exceed your
55account\'s limits.
56
57Make also sure that sub-directories \'Input\' and \'Output\' which are
58part of the example configurations exist on your system or adjust the
59affected example configuration options according to your needs.
60
61Some BNC options require Antenna Phase Center variations as made
62available from IGS through so-called ANTEX files at
63<https://files.igs.org/pub/station/general/igs20.atx>. An example ANTEX
64file \'igs20.atx\' is part of the BNC package for convenience.
65
66The example configurations assume that no proxy protects your BNC host.
67Should a proxy be operated in front of BNC then you need to introduce
68its name or IP and port number in the \'Network\' panel.
69
70**(A) Working with Configuration Files**\
71\
72You should be able to run all configuration file examples without
73changing contained options. However, configuration \'Upload.bnc\' is an
74exception because it requires an input stream from a connected network
75engine.
76
771. Configuration File \'01\_RinexObs.bnc\'\
78 Purpose: Convert RTCM streams to RINEX Observation files. The
79 configuration pulls RTCM Version 3 streams from Ntrip Broadcasters
80 using Ntrip Version 2 to generate 15min 1Hz RINEX Version 4
81 Observation files. See <https://igs.bkg.bund.de/ntrip/#rtcm-obs> for
82 observation stream resources.
832. Configuration File \'02\_RinexEph.bnc\'\
84 Purpose: Convert a RTCM stream with navigation messages to RINEX
85 Navigation files. The configuration pulls a RTCM Version 3 stream
86 with Broadcast Ephemeris coming from the real-time EUREF and IGS
87 networks and saves hourly RINEX Version 4 Navigation files. See
88 <https://igs.bkg.bund.de/ntrip/#rtcm-eph> for further real-time
89 Broadcast Ephemeris resources.
903. Configuration File \'03\_BrdcCorr.bnc\'\
91 Purpose: Save Broadcast Corrections from RTCM SSR messages in hourly
92 plain ASCII files. See <https://igs.bkg.bund.de/ntrip/#rtcm-corr>
93 for various real-time IGS or EUREF orbit/clock correction products.
944. Configuration File \'04\_RinexConcat.bnc\'\
95 Purpose: Concatenate several RINEX Version 3 files to produce one
96 compiled file and edit the marker name in the file header. The
97 sampling interval is set to 30 seconds. See section \'RINEX Editing
98 & QC\' in the documentation for examples on how to call BNC from
99 command line in \'no window\' mode for RINEX file editing,
100 concatenation and quality check.
1015. Configuration File \'05\_RinexQC.bnc\'\
102 Purpose: Check the quality of a RINEX Version 4 file by means of a
103 multipath analysis. Results are saved on disk in terms of a plot in
104 PNG format. See section \'RINEX Editing & QC\' in the documentation
105 for examples on how to call BNC from command line in \'no window\'
106 mode for RINEX file editing, concatenation and quality check.
1076. Configuration File \'06\_RTK.bnc\'\
108 Purpose: Feed a serial connected receiver with observations from a
109 nearby reference station for conventional RTK. The stream is scanned
110 for RTCM messages. Message type numbers and latencies of incoming
111 observations are reported in BNC\'s logfile.
1127. Configuration File \'07\_FeedEngine.bnc\'\
113 Purpose: Feed a real-time GNSS engine with observations from remote
114 reference stations. The configuration pulls a single stream from an
115 Ntrip Broadcaster. You could also pull several streams from
116 different casters. Incoming observations are decoded, synchronized,
117 output through a local IP port and also saved into a file. Failure
118 and recovery thresholds are specified to inform about outages.
1198. Configuration File \'08\_PPP.bnc\'\
120 Purpose: Precise Point Positioning from observations of a rover
121 receiver. The configuration reads RTCM Version 3 observations, a
122 Broadcast Ephemeris stream and a stream with Broadcast Corrections.
123 Positions are saved in the logfile. More detailed PPP results are
124 saved in the PPP logfile.
1259. Configuration File \'09\_PPPNet.bnc\'\
126 Purpose: Precise Point Positioning for several rovers or receivers
127 from an entire network of reference stations in one BNC job. The
128 possible maximum number of PPP solutions per job depends on the
129 processing power of the hosting computer. This example configuration
130 reads two RTCM Version 3 observation streams, a Broadcast Ephemeris
131 stream and a stream with Broadcast Corrections. Detailed PPP Results
132 for the two stations are saved in PPP logfiles.
13310. Configuration File \'10\_PPPQuickStart.bnc\'\
134 Purpose: Precise Point Positioning in Quick-Start mode from
135 observations of a static receiver with precisely known position. The
136 configuration reads RTCM Version 3 observations, Broadcast
137 Corrections and a Broadcast Ephemeris stream. Positions are saved in
138 NMEA format on disc. They are also output through IP port for
139 real-time visualization with tools like RTKPLOT. Positions are saved
140 in the logfile.
14111. Configuration File \'11\_PPPPostProc.bnc\'\
142 Purpose: Precise Point Positioning in post processing mode. BNC
143 reads RINEX Version 3 Observation and Navigation files and a
144 Broadcast Correction file. Optionally, an Ionosphere file containing
145 VTEC informations can be used. If such a file is not specified, VTEC
146 informations from the Broadcast Corrections file are used. PPP
147 processing options are set to support the Quick-Start mode. The
148 output is saved in a specific post processing logfile and contains
149 coordinates derived over time following the implemented PPP filter
150 algorithm.
15112. Configuration File \'12\_PPPOsm.bnc\'\
152 Purpose: Track BNC\'s point positioning solutions using
153 OpenStreetMap as background. BNC reads a RINEX Observation file and
154 a RINEX Navigation file to carry out a \'Standard Point
155 Positioning\' solution in post processing mode. Although this is not
156 a real-time application it requires the BNC host to be connected to
157 the Internet. Specify a computation speed, then hit button \'Open
158 Map\' to open the track map, then hit \'Start\' to visualize
159 receiver positions on top of OSM maps.
16013. Configuration File \'13\_PPPGalHAS.bnc\'\
161 Purpose: Precise Point Positioning in Quick-Start mode with SSR
162 corrections from the Galileo HAS Internet Data Distribution (IDD)
163 interface with observations of a static receiver with quite
164 precisely known position. Because the Galileo HAS provides Code
165 Biases and corrections for satellite orbits and clocks for GPS and
166 Galileo, the configuration uses GPS and Galileo navigation data
167 only. Access to the Galileo HAS Internet Data Distribution is
168 available by registration:
169 <https://www.gsc-europa.eu/galileo/services/galileo-high-accuracy-service-has/internet-data-distribution-registration-form>
170 Purpose: Single Point Positioning in Quick-Start mode from
171 observations of a static receiver with quite precisely known
172 position. The configuration uses Galileo observations only and a
173 Broadcast Ephemeris stream.
17414. Configuration File \'14\_SaveSp3.bnc\'\
175 Purpose: Produces SP3 files from a Broadcast Ephemeris stream and a
176 Broadcast Correction stream. The Broadcast Correction stream is
177 formally introduced in BNC\'s \'Combine Corrections\' table. Note
178 that producing SP3 requires an ANTEX file because SP3 file content
179 should be referred to CoM..
18015. Configuration File \'15\_Sp3ETRF2000PPP.bnc\'\
181 Purpose: Produce SP3 files from a Broadcast Ephemeris stream and a
182 stream carrying ETRF2000 Broadcast Corrections. The Broadcast
183 Correction stream is formally introduced in BNC\'s \'Combine
184 Corrections\' table. The configuration leads to a SP3 file
185 containing orbits also referred to ETRF2000. Pulling in addition
186 observations from a reference station at precisely known ETRF2000
187 position allows comparing an \'INTERNAL\' PPP solution with a known
188 ETRF2000 reference coordinate.
18916. Configuration File \'16\_Upload.bnc\'\
190 Purpose: Upload orbits and clocks from a real-time GNSS engine to an
191 Ntrip Broadcaster. For that the configuration reads precise orbits
192 and clocks in RTNET format. It also reads a stream carrying
193 Broadcast Ephemeris. BNC converts the orbits and clocks into
194 Broadcast Corrections and encodes them to IGS-SSR messages to
195 finally upload them to an Ntrip Broadcaster. The Broadcast
196 Correction stream is referred to satellite Antenna Phase Center
197 (APC) and reference system IGS20. Orbits are saved on disk in SP3
198 format and clocks are saved in Clock RINEX format.
19917. Configuration File \'17\_Combi.bnc\'\
200 Purpose: Pull 2 streams carrying Broadcast Corrections, and
201 Satellite Code Biases together with Broadcast Ephemeris from an
202 Ntrip Broadcaster to produce a combined Broadcast Correction stream.
203 BNC encodes the combination product in IGS-SSR messages and uploads
204 them to an Ntrip Broadcaster. The Broadcast Correction stream is
205 referred to satellite Antenna Phase Center (APC) and not to
206 satellite Center of Mass (CoM). Its reference system is IGS20.
207 Orbits are saved in SP3 format (referred to CoM) and clocks in Clock
208 RINEX format.
20918. Configuration File \'18\_CombiPPP.bnc\'\
210 Purpose: This configuration equals the \'Combi.bnc\' configuration.
211 However, the combined Broadcast Corrections are in addition used for
212 an \'INTERNAL\' PPP solutions based on observations from a static
213 reference station with known precise coordinates. This allows a
214 continuous quality check of the combination product through
215 observing coordinate displacements.
21619. Configuration File \'19\_UploadEph.bnc\'\
217 Purpose: Pull a number of streams from reference stations to get the
218 contained Broadcast Ephemeris messages. They are encoded to RTCM
219 Version 3 format and uploaded for the purpose of providing a
220 Broadcast Ephemeris stream with an update rate of 5 seconds.
22120. Configuration File \'20\_UploadRaw.bnc\'\
222 Purpose: Forward the stream contents of the incoming stream
223 BCEP00BKG0 from products.igs-ip.net to another caster.
22421. Configuration File \'21\_CompareSp3.bnc\'\
225 Purpose: Compare two SP3 files to calculate RMS values for orbit and
226 clock differences: the IGS real-time combination of 15 October 2026
227 produced by BNC (CMB0MGXRTS, thinned to 5 minutes) and the GFZ rapid
228 product (GBM0MGXRAP). GLONASS satellite R08 (GLONASS-K2, its antenna
229 offsets were not yet used by all real-time ACs) is excluded from this
230 comparison. Comparison results are saved in a logfile.
23122. Configuration File \'22\_Empty.bnc\'\
232 Purpose: Provide an empty example configuration file for BNC which
233 only contains the default settings.
234
235<!-- -->
236
23729. Configuration File \'29\_PPPAR\_CNES.bnc\'\
238 Purpose: Precise Point Positioning with ambiguity resolution using
239 an raw input file. Call: bnc \--conf 29\_PPPAR\_CNES.bnc \--file
240 WTZR\_CNES\_20251117.raw The configuration reads RTCM Version 3
241 observations, a Broadcast Ephemeris stream and a stream with SSR
242 Corrections enabling PPP-AR. Positions are saved in the logfile.
243 More detailed PPP results are saved in the PPP logfile.
24430. Configuration File \'30\_PPPAR\_WHU.bnc\'\
245 Purpose: Precise Point Positioning with ambiguity resolution using
246 an raw input file. Call: bnc \--conf 30\_PPPAR\_WHU.bnc \--file
247 WTZR\_WHU\_20251129.raw The configuration reads RTCM Version 3
248 observations, a Broadcast Ephemeris stream and a stream with SSR
249 Corrections enabling PPP-AR. Positions are saved in the logfile.
250 More detailed PPP results are saved in the PPP logfile.
25131. Configuration File \'31\_SsrQC.bnc\'\
252 Purpose: Quality control of Broadcast Correction streams (see
253 section \'QC Logfile, QC Interval\'). The configuration reads a
254 Broadcast Ephemeris stream and three Broadcast Correction streams in
255 IGS-SSR format (SSRA00CNE1, SSRA00CHC1) and RTCM-SSR format (Galileo
256 HAS, SSRA00EUH0; needs an account at the Galileo HAS caster). Hourly
257 QC reports per system are saved in one file per stream in directory
258 \'Output\'. The configuration can be applied to a raw file as well:
259 bnc \--conf 31\_SsrQC.bnc \--file \<rawFile\> \--key ssrQcIntr \"5
260 min\"
261
262**(B) Working with Command Line configuration options**\
263\
264The following configuration examples make use of BNC\'s \'Command Line
265Interface\' (CLI). Configuration options are exclusively specified via
266command line. No configuration file is used. Examples are provided as
267shell scripts for a Linux system. They call BNC in \'no window\' batch
268mode (command line option -nw). The scripts expect \'Example\_Configs\'
269to be the current working directory.
270
27123. Shell Script \'23\_RinexQC.sh\'\
272 Purpose: Equals configuration file example \'RinexQC.bnc\', checks
273 the quality of a RINEX Version 4 file by means of a multipath
274 analysis. The platform offscreen is used while producing plot files
275 in PNG format. BNC is offline. All results are saved on disk.
27624. Shell Script \'24\_RinexConcat.sh\'\
277 Purpose: Equals configuration file example \'RinexConcat.bnc\',
278 concatenates several RINEX Version 3 files to produce one compiled
279 file and edit the marker name in the file header. The sampling
280 interval is set to 30 seconds. BNC is offline.
28125. Shell Script \'25\_RinexEph.sh\'\
282 Purpose: Equals configuration file example \'RinexEph.bnc\',
283 converts a RTCM stream with navigation messages to RINEX Navigation
284 files. The configuration pulls a RTCM Version 3 stream with
285 Broadcast Ephemeris coming from the real-time EUREF and IGS networks
286 and saves hourly RINEX Version 4 Navigation files. BNC runs online
287 until it\'s terminated after 10 seconds. See
288 <https://igs.bkg.bund.de/ntrip/#rtcm-eph> for further real-time
289 Broadcast Ephemeris resources.
29026. Shell Script \'26\_ScanLate.sh\'\
291 Purpose: Scan an observation stream for contained RTCM message
292 types, print observation latencies. The output is saved in a
293 logfile. Latencies are reported every 10 seconds. BNC runs online
294 until it\'s terminated after 20 seconds.
29527. Shell Script \'27\_RinexObs.sh\'\
296 Purpose: Equals configuration file example \'RinexObs.bnc\',
297 converts RTCM streams to RINEX Observation files. The configuration
298 pulls streams from two Ntrip Broadcasters using Ntrip Version 2 to
299 generate 15min 1Hz RINEX Version 4 Observation files. See
300 <https://igs.bkg.bund.de/ntrip/#rtcm-obs> for observation stream
301 resources. BNC runs online until it\'s terminated after 30 seconds.
302
303**(C) Command Line configuration options overwriting Configuration File
304options**\
305\
306For specific applications you may like to use your own set of standard
307configuration options from a configuration file and update some of its
308content via command line. When using a configuration file together with
309command line configuration options in one BNC call, the command line
310configuration options will always overrule options contained in the
311configuration file.
312
31328. Shell Script \'28\_CompareSp3.sh\'\
314 Purpose: Equals configuration file example \'21\_CompareSp3.bnc\',
315 compares two SP3 files to calculate RMS values for orbit and clock
316 differences. However, instead of excluding GLONASS satellite R08 from
317 the comparison as specified in \'21\_CompareSp3.bnc\', GPS
318 satellite G06 and all GLONASS satellites are
319 excluded via command line option. BNC runs offline. Comparison
320 results are saved in a logfile.
Note: See TracBrowser for help on using the repository browser.