-
Notifications
You must be signed in to change notification settings - Fork 15
/
HOWTO.txt
183 lines (140 loc) · 5.57 KB
/
HOWTO.txt
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
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
\page HOWTO HOWTO
\section HOWTOIWantTo I want to...
\subsection HOWTOGettingStarted Getting Started
\li See the detailed documentation...
1. Make sure Doxygen is installed on your build system by running "doxygen -v"
2. In the top level directory of the toolkit (where the Doxyfile resides), run doxygen.
3. In a web browser, open $TKROOT/gnsstk_doc_dir/html/index.html
\li Build the toolkit...
1. Refer to \ref INSTALL
\subsection HOWTOApps Applications
\li Convert time between different formats...
1. Use the \ref timeconvert application. Running timeconvert without command-line arguments will show the current time (UTC) in a variety of formats.
2. Use \ref timeconvert with one of the myriad command-line arguments to specify a time in one of the supported formats (ANSI, civil, RINEX, etc.)
3. Use \ref timeconvert with the -F command-line argument to use a specific output format. Refer to printTime() for documentation on the supported format tokens. Example: <br/><tt> timeconvert -F "%4Y-%02m-%02dT%02H:%02M:%02SZ" </tt><br/> will display the current UTC time in ISO-8601 format.
4. Use \ref timeconvert with the \c --input-format and \c --input-time arguments to specify a time in a format not explicitly supported by the existing options. Refer to printTime() for documentation on the supported format tokens. Example: <br/><tt> timeconvert --input-format="%Y %j %H:%M:%S" --input-time="2020 20 20:20:20" </tt><br/> processes time from a "Year day-of-year hour:minute:second" format.
\li Manipulate RINEX files...
1. Use the RinEdit application to perform a wide variety of tweaks to RINEX OBS data files.
2. Use the RinDump application to generate a space-separated table of data from a RINEX input file.
3. Use the RinSum application to generate a table of counts of observables from a RINEX OBS file.
\li See a GPS calendar with week number and day of year
1. \ref calgps with no arguments will show a calendar for the current month and year.
2. \ref calgps with the \c -y argument will produce a calendar for the current year.
3. \ref calgps with the \c -Y \c YEAR argument will produce a calendar for YEAR.
- \subpage usingwheresat
\subsection HOWTOCode Library Use
\li Use time data in my code...
1. Refer to \ref TimeHandlingGuide for guidance.
2. Refer to the classes in the \ref TimeHandling module for reference documentation.
\li Generate correlation codes...
1. Refer to the \ref CodeGen module for reference documentation.
\li Decode as-broadcast navigation messages...
1. Refer to the classes in the \ref GNSSEph module for reference documentation.
\subsection HOWTOContribute Contribute Code
\li Contribute code...
1. Follow the style guide, if we ever add it from the wiki to the code base.
2. Document your code using doxygen as described in \ref DoxygenGuide
\internal
Defining some pages here so that they will appear after all of the
super-important stuff that we want at the top of the navigation bar,
but before the other pages.
\endinternal
\page apps Application Documentation
- \subpage appsbyname
- \subpage appsbyfunc
\page appsbyname By Name
- \subpage bc2sp3
- \subpage calgps
- \subpage convertSSEph
- \subpage DDBase
- \subpage dfix
- \subpage DiscFix
- \subpage findMoreThan12
- \subpage lsfilt
- \subpage mergeRinMet
- \subpage mergeRinNav
- \subpage mergeSRI
- \subpage navdump
- \subpage poscvt
- \subpage PRSolve
- \subpage rfw
- \subpage RinDump
- \subpage RinEdit
- \subpage rineditnav
- \subpage rinexelvstrip
- \subpage rinheaddiff
- \subpage RinSum
- \subpage rmwcheck
- \subpage rmwdiff
- \subpage rnwcheck
- \subpage rnwdiff
- \subpage rowcheck
- \subpage rowdiff
- \subpage rstats
- \subpage smdscheck
- \subpage sp3version
- \subpage timeconvert
- \subpage timediff
- \subpage tkalm
- \subpage wheresat
\page appsbyfunc By Function
- \subpage apps_check
- \subpage apps_diff
- \subpage apps_file
- \subpage apps_merge
- \subpage apps_positioning
- \subpage apps_RINEX
- \subpage apps_time
- \subpage apps_visibility
\page apps_check File Format Check Tools
These tools are for validating data files for format compliance.
- \subpage rmwcheck
- \subpage rnwcheck
- \subpage rowcheck
- \subpage smdscheck
\page apps_diff File Differencing Tools
These tools are for comparing specific data file formats in an intelligent way.
- \subpage rinheaddiff
- \subpage rmwdiff
- \subpage rnwdiff
- \subpage rowdiff
\page apps_file File Processing Tools
These tools are for processing GNSS data files that don't neatly fit
into the other categories.
- \subpage bc2sp3
- \subpage navdump
\page apps_merge File Merging Tools
These tools are for merging the contents of two or more data files
into a single output file.
- \subpage mergeRinMet
- \subpage mergeRinNav
\page apps_positioning Position Tools
These tools are for computing or manipulation position information.
- \subpage poscvt
- \subpage PRSolve
\page apps_RINEX RINEX Tools
These tools are for manipulating or processing RINEX data files.
- \subpage mergeRinMet
- \subpage mergeRinNav
- \subpage RinDump
- \subpage RinEdit
- \subpage rineditnav
- \subpage rinexelvstrip
- \subpage rinheaddiff
- \subpage RinSum
- \subpage rmwcheck
- \subpage rmwdiff
- \subpage rnwcheck
- \subpage rnwdiff
- \subpage rowcheck
- \subpage rowdiff
\page apps_time Time Tools
These tools are for manipulating or displaying time information.
- \subpage calgps
- \subpage timeconvert
- \subpage timediff
\page apps_visibility Visibility Tools
These applications involve determining if satellites are visible to
GNSS receivers or vice versa.
- \subpage findMoreThan12
- \subpage wheresat