Changeset 7723 in ntrip

Timestamp:

Feb 8, 2016, 11:31:22 PM (9 years ago)

Author:

weber

Message:

Documentation completed

File:

• trunk/BNC/Example_Configs/00_Readme.txt (modified) (17 diffs)

trunk/BNC/Example_Configs/00_Readme.txt

@@ -69 +69 @@
 name or IP and port number in the 'Network' panel.
 
-You should be able to run all configuration examples without changing their 
-options. However, configurations 'Upload.bnc' and 'UploadPPP.bnc' are 
+You should be able to run all configuration file examples without changing 
+contained options. However, configurations 'Upload.bnc' and 'UploadPPP.bnc' are 
 exceptions because they require an input stream from a connected network engine. 
 
-1. File 'RinexObs.bnc'
+1. Configuration File 'RinexObs.bnc'
 Purpose: Convert RTCM streams to RINEX Observation files. The configuration 
 pulls streams from Ntrip Broadcasters using Ntrip Version 1 to generate 15min 
@@ -79 +79 @@
 http://igs.bkg.bund.de/ntrip/observations for observation stream resources.
 
-2. File 'RinexEph.bnc'
+2. Configuration File 'RinexEph.bnc'
 Purpose: Convert a RTCM stream with navigation messages to RINEX Navigation 
 files. The configuration pulls a RTCM Version 3 stream with Broadcast Ephemeris 
@@ -86 +86 @@
 real-time Broadcast Ephemeris resources.
 
-3. File 'BrdcCorr.bnc'
+3. Configuration File 'BrdcCorr.bnc'
 Purpose: Save Broadcast Corrections from RTCM SSR messages in hourly plain 
 ASCII files. See http://igs.bkg.bund.de/ntrip/orbits for various real-time IGS 
 or EUREF orbit/clock correction products.
 
-4. File 'RinexConcat.bnc'
+4. Configuration File 'RinexConcat.bnc'
 Purpose: Concatenate several RINEX Version 3 files to produce one compiled file 
 and edit the marker name in the file header. The sampling interval is set to 30 
@@ -98 +98 @@
 concatenation and quality check.
 
-5. File 'RinexQC.bnc'
+5. Configuration File 'RinexQC.bnc'
 Purpose: Check the quality of a RINEX Version 3 file by means of a multipath 
 analysis. Results are saved on disk in terms of a plot in PNG format. See 
@@ -105 +105 @@
 and quality check.
 
-6. File 'RTK.bnc'
+6. Configuration File 'RTK.bnc'
 Purpose: Feed a serial connected receiver with observations from a nearby 
 reference station for conventional RTK. The stream is scanned for RTCM 
@@ -111 +111 @@
 reported in BNC's logfile.
 
-7. File 'FeedEngine.bnc'
+7. Configuration File 'FeedEngine.bnc'
 Purpose: Feed a real-time GNSS engine with observations from remote reference 
 stations. The configuration pulls a single stream from an Ntrip Broadcaster. 
@@ -119 +119 @@
 about outages.
 
-8. File 'PPP.bnc'
+8. Configuration File 'PPP.bnc'
 Purpose: Precise Point Positioning from observations of a rover receiver. The 
 configuration reads RTCM Version 3 observations, a Broadcast Ephemeris stream 
 and a stream with Broadcast Corrections. Positions are saved in the logfile.
 
-9. File 'PPPNet.bnc'
+9. Configuration File 'PPPNet.bnc'
 Purpose: Precise Point Positioning for several rovers or receivers from an 
 entire network of reference stations in one BNC job. The possible maximum 
@@ -132 +132 @@
 PPP Results for the two stations are saved in PPP logfiles.
 
-10. File 'PPPQuickStart.bnc'
+10. Configuration File 'PPPQuickStart.bnc'
 Purpose: Precise Point Positioning in Quick-Start mode from observations of a 
 static receiver with precisely known position. The configuration reads RTCM 
@@ -140 +140 @@
 in the logfile.
 
-11. File 'PPPPostProc.bnc'
+11. Configuration File 'PPPPostProc.bnc'
 Purpose: Precise Point Positioning in post processing mode. BNC reads RINEX 
 Version 3 Observation and 3 Navigation files and a Broadcast Correction file. 
@@ -147 +147 @@
 over time following the implemented PPP filter algorithm.
 
-12. File 'PPPGoogleMaps.bnc'
+12. Configuration File 'PPPGoogleMaps.bnc'
 Purpose: Track BNC's point positioning solutions using Google Maps or 
 OpenStreetMap as background. BNC reads a RINEX Observation file and a RINEX 
@@ -156 +156 @@
 positions on top of GM/OSM maps.
 
-13. File 'SPPQuickStartGal.bnc'
+13. Configuration File 'SPPQuickStartGal.bnc'
 Purpose: Single Point Positioning in Quick-Start mode from observations of a 
 static receiver with quite precisely known position. The configuration uses 
 GPS, GLONASS and Galileo observations and a Broadcast Ephemeris stream.
 
-14. File 'SaveSp3.bnc'
+14. Configuration File 'SaveSp3.bnc'
 Purpose: Produces SP3 files from a Broadcast Ephemeris stream and a Broadcast 
 Correction stream. The Broadcast Correction stream is formally introduced in 
@@ -167 +167 @@
 file because SP3 file content should be referred to CoM.
 
-15. File 'Sp3ETRF2000PPP.bnc'
+15. Configuration File 'Sp3ETRF2000PPP.bnc'
 Purpose: Produce SP3 files from a Broadcast Ephemeris stream and a stream 
 carrying ETRF2000 Broadcast Corrections. The Broadcast Correction stream is 
@@ -176 +176 @@
 reference coordinate.
 
-16. File 'Upload.bnc'
+16. Configuration File 'Upload.bnc'
 Purpose: Upload orbits and clocks from a real-time GNSS engine to an Ntrip 
 Broadcaster. For that the configuration reads precise orbits and clocks in 
@@ -186 +186 @@
 are saved in Clock RINEX format.
 
-17. File 'Combi.bnc'
+17. Configuration File 'Combi.bnc'
 Purpose: Pull several streams carrying Broadcast Corrections and a Broadcast 
 Ephemeris from an Ntrip Broadcaster to produce a combined Broadcast Correction 
@@ -195 +195 @@
 (referred to CoM) and clocks in Clock RINEX format.
 
-18. File 'CombiPPP.bnc'
+18. Configuration File 'CombiPPP.bnc'
 Purpose: This configuration equals the 'Combi.bnc' configuration. However, the 
 combined Broadcast Corrections are in addition used for an 'INTERNAL' PPP 
@@ -202 +202 @@
 product through observing coordinate displacements.
 
-19. File 'UploadEph.bnc'
+19. Configuration File 'UploadEph.bnc'
 Purpose: Pull a number of streams from reference stations to get hold of 
 contained Broadcast Ephemeris messages. They are encoded to RTCM Version 3 
@@ -208 +208 @@
 with an update rate of 5 seconds.
 
-20. File 'CompareSp3.bnc'
+20. Configuration File 'CompareSp3.bnc'
 Purpose: Compare two SP3 files to calculate RMS values for orbit and clock 
 differences. GPS satellite G05 and GLONASS satellite R18 are excluded from this 
 comparison. Comparison results are saved in a logfile.
 
-21. File 'Empty.bnc'
+21. Configuration File 'Empty.bnc'
 Purpose: Provide an empty example configuration file for BNC which only 
 contains the default settings.
+
+The following configuration examples make use of BNC's 'Command Line Interface' 
+(CLI). Configuration options are exclusively specified via command line. No 
+configuration file is used. Examples are provided as shell scripts for a Linux
+system. They call BNC in 'no window' batch mode (command line option -nw). 
+
+22. Shell Script 'RinexQC.cli'
+Purpose: Equals configuration file example 'RinexQC.bnc', checks the quality of
+a RINEX Version 3 file by means of a multipath analysis. Virtual X-Server 
+'Xvfb' is operated while producing plot files in PNG format. BNC is offline. 
+All results are saved on disk. 
 
 Georg Weber, BKG