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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
int usage(int retval, bool brief) {
if (brief)
( retval ? std::cerr : std::cout ) << "Usage:\n"
" MagneticField [ -n name ] [ -d dir ] [ -N Nmax ] [ -M Mmax ] [ -t time\n"
" | -c time lat h ] [ -r ] [ -w ] [ -T tguard ] [ -H hguard ] [ -p prec ]\n"
" [ -v ] [ --comment-delimiter commentdelim ] [ --version | -h | --help ]\n"
" [ --input-file infile | --input-string instring ] [ --line-separator\n"
" linesep ] [ --output-file outfile ]\n"
"\n"
"For full documentation type:\n"
" MagneticField --help\n"
"or visit:\n"
" https://geographiclib.sourceforge.io/C++/2.6/MagneticField.1.html\n";
else
( retval ? std::cerr : std::cout ) << "Man page:\n"
"\n"
"SYNOPSIS\n"
" MagneticField [ -n name ] [ -d dir ] [ -N Nmax ] [ -M Mmax ] [ -t time\n"
" | -c time lat h ] [ -r ] [ -w ] [ -T tguard ] [ -H hguard ] [ -p prec ]\n"
" [ -v ] [ --comment-delimiter commentdelim ] [ --version | -h | --help ]\n"
" [ --input-file infile | --input-string instring ] [ --line-separator\n"
" linesep ] [ --output-file outfile ]\n"
"\n"
"DESCRIPTION\n"
" MagneticField reads in times and positions on standard input and prints\n"
" out the geomagnetic field on standard output and, optionally, its rate\n"
" of change.\n"
"\n"
" The input line is of the form time lat lon h. time is a date of the\n"
" form 2012-11-25 (yyyy-mm-dd or yyyy-mm), a fractional year such as\n"
" 2012.9, or the string \"now\". lat and lon are the latitude and\n"
" longitude expressed as decimal degrees or degrees, minutes, and\n"
" seconds; for details on the allowed formats for latitude and longitude,\n"
" see the \"GEOGRAPHIC COORDINATES\" section of GeoConvert(1). h is the\n"
" height above the ellipsoid in meters; this is optional and defaults to\n"
" zero. Alternatively, time can be given on the command line as the\n"
" argument to the -t option, in which case it should not be included on\n"
" the input lines. Finally, the magnetic field can be computed at\n"
" various points on a circle of latitude (constant time, lat, and h) via\n"
" the -c option; in this case only the longitude should be given on the\n"
" input lines.\n"
"\n"
" The output consists of the following 7 items:\n"
"\n"
" the declination (the direction of the horizontal component of\n"
" the magnetic field measured clockwise from north) in degrees,\n"
" the inclination (the direction of the magnetic field measured\n"
" down from the horizontal) in degrees,\n"
" the horizontal field in nanotesla (nT),\n"
" the north component of the field in nT,\n"
" the east component of the field in nT,\n"
" the vertical component of the field in nT (down is positive),\n"
" the total field in nT.\n"
"\n"
" If the -r option is given, a second line is printed giving the rates of\n"
" change of these quantities in degrees/yr and nT/yr.\n"
"\n"
" The WGS84 ellipsoid is used, a = 6378137 m, f = 1/298.257223563.\n"
"\n"
"OPTIONS\n"
" -n name\n"
" use magnetic field model name instead of the default \"wmm2025\".\n"
" See \"MODELS\".\n"
"\n"
" -d dir\n"
" read magnetic models from dir instead of the default. See\n"
" \"MODELS\".\n"
"\n"
" -N Nmax\n"
" limit the degree of the model to Nmax.\n"
"\n"
" -M Mmax\n"
" limit the order of the model to Mmax.\n"
"\n"
" -t time\n"
" evaluate the field at time instead of reading the time from the\n"
" input lines.\n"
"\n"
" -c time lat h\n"
" evaluate the field on a circle of latitude given by time, lat, h\n"
" instead of reading these quantities from the input lines. In this\n"
" case, MagneticField can calculate the field considerably more\n"
" quickly.\n"
"\n"
" -r toggle whether to report the rates of change of the field.\n"
"\n"
" -w toggle the longitude first flag (it starts off); if the flag is on,\n"
" then on input and output, longitude precedes latitude (except that,\n"
" on input, this can be overridden by a hemisphere designator, N, S,\n"
" E, W).\n"
"\n"
" -T tguard\n"
" signal an error if time lies tguard years (default 50 yr) beyond\n"
" the range for the model.\n"
"\n"
" -H hguard\n"
" signal an error if h lies hguard meters (default 500000 m) beyond\n"
" the range for the model.\n"
"\n"
" -p prec\n"
" set the output precision to prec (default 1). Fields are printed\n"
" with precision with prec decimal places; angles use prec + 1\n"
" places.\n"
"\n"
" -v print information about the magnetic model on standard error before\n"
" processing the input.\n"
"\n"
" --comment-delimiter commentdelim\n"
" set the comment delimiter to commentdelim (e.g., \"#\" or \"//\"). If\n"
" set, the input lines will be scanned for this delimiter and, if\n"
" found, the delimiter and the rest of the line will be removed prior\n"
" to processing and subsequently appended to the output line\n"
" (separated by a space).\n"
"\n"
" --version\n"
" print version and exit.\n"
"\n"
" -h print usage, the default magnetic path and name, and exit.\n"
"\n"
" --help\n"
" print full documentation and exit.\n"
"\n"
" --input-file infile\n"
" read input from the file infile instead of from standard input; a\n"
" file name of \"-\" stands for standard input.\n"
"\n"
" --input-string instring\n"
" read input from the string instring instead of from standard input.\n"
" All occurrences of the line separator character (default is a\n"
" semicolon) in instring are converted to newlines before the reading\n"
" begins.\n"
"\n"
" --line-separator linesep\n"
" set the line separator character to linesep. By default this is a\n"
" semicolon.\n"
"\n"
" --output-file outfile\n"
" write output to the file outfile instead of to standard output; a\n"
" file name of \"-\" stands for standard output.\n"
"\n"
"MODELS\n"
" MagneticField computes the geomagnetic field using one of the following\n"
" models\n"
"\n"
" wmm2010, the World Magnetic Model 2010, which approximates the\n"
" main magnetic field for the period 2010-2015. See\n"
" https://ngdc.noaa.gov/geomag/WMM/DoDWMM.shtml\n"
" wmm2015v2, the World Magnetic Model 2015, which approximates the\n"
" main magnetic field for the period 2015-2020. See\n"
" https://ngdc.noaa.gov/geomag/WMM/DoDWMM.shtml\n"
" wmm2015, a deprecated version of wmm2015v2\n"
" wmm2020, the World Magnetic Model 2020, which approximates the\n"
" main magnetic field for the period 2020-2025. See\n"
" https://ngdc.noaa.gov/geomag/WMM/DoDWMM.shtml\n"
" wmm2025, the World Magnetic Model 2025, which approximates the\n"
" main magnetic field for the period 2025-2030. See\n"
" https://www.ncei.noaa.gov/products/world-magnetic-model\n"
" wmmhr2025, the World Magnetic Model High Resolution 2025, a high\n"
" resolution version of wmm2025. See\n"
" https://www.ncei.noaa.gov/products/world-magnetic-model-high-resolution\n"
" igrf11, the International Geomagnetic Reference Field (11th\n"
" generation), which approximates the main magnetic field for\n"
" the period 1900-2015. See\n"
" https://ngdc.noaa.gov/IAGA/vmod/igrf.html\n"
" igrf12, the International Geomagnetic Reference Field (12th\n"
" generation), which approximates the main magnetic field for\n"
" the period 1900-2020. See\n"
" https://ngdc.noaa.gov/IAGA/vmod/igrf.html\n"
" igrf13, the International Geomagnetic Reference Field (13th\n"
" generation), which approximates the main magnetic field for\n"
" the period 1900-2025. See\n"
" https://ngdc.noaa.gov/IAGA/vmod/igrf.html\n"
" igrf14, the International Geomagnetic Reference Field (14th\n"
" generation), which approximates the main magnetic field for\n"
" the period 1900-2030. See\n"
" https://www.ncei.noaa.gov/products/international-geomagnetic-reference-field\n"
" emm2010, the Enhanced Magnetic Model 2010, which approximates\n"
" the main and crustal magnetic fields for the period 2010-2015.\n"
" See https://ngdc.noaa.gov/geomag/EMM/index.html\n"
" emm2015, the Enhanced Magnetic Model 2015, which approximates\n"
" the main and crustal magnetic fields for the period 2000-2020.\n"
" See https://ngdc.noaa.gov/geomag/EMM/index.html\n"
" emm2017, the Enhanced Magnetic Model 2017, which approximates\n"
" the main and crustal magnetic fields for the period 2000-2022.\n"
" See https://ngdc.noaa.gov/geomag/EMM/index.html\n"
"\n"
" These models approximate the magnetic field due to the earth's core and\n"
" (in the case of emm20xx) its crust. They neglect magnetic fields due\n"
" to the ionosphere, the magnetosphere, nearby magnetized materials,\n"
" electrical machinery, etc.\n"
"\n"
" By default, the \"wmm2025\" magnetic model is used. This may changed by\n"
" setting the environment variable \"GEOGRAPHICLIB_MAGNETIC_NAME\" or with\n"
" the -n option.\n"
"\n"
" The magnetic models will be loaded from a directory specified at\n"
" compile time. This may changed by setting the environment variables\n"
" \"GEOGRAPHICLIB_MAGNETIC_PATH\" or \"GEOGRAPHICLIB_DATA\", or with the -d\n"
" option. The -h option prints the default magnetic path and name. Use\n"
" the -v option to ascertain the full path name of the data file.\n"
"\n"
" Instructions for downloading and installing magnetic models are\n"
" available at\n"
" <https://geographiclib.sourceforge.io/C++/doc/magnetic.html#magneticinst>.\n"
"\n"
"ENVIRONMENT\n"
" GEOGRAPHICLIB_MAGNETIC_NAME\n"
" Override the compile-time default magnetic name of \"wmm2025\". The\n"
" -h option reports the value of GEOGRAPHICLIB_MAGNETIC_NAME, if\n"
" defined, otherwise it reports the compile-time value. If the -n\n"
" name option is used, then name takes precedence.\n"
"\n"
" GEOGRAPHICLIB_MAGNETIC_PATH\n"
" Override the compile-time default magnetic path. This is typically\n"
" \"/usr/local/share/GeographicLib/magnetic\" on Unix-like systems and\n"
" \"C:/ProgramData/GeographicLib/magnetic\" on Windows systems. The -h\n"
" option reports the value of GEOGRAPHICLIB_MAGNETIC_PATH, if\n"
" defined, otherwise it reports the compile-time value. If the -d\n"
" dir option is used, then dir takes precedence.\n"
"\n"
" GEOGRAPHICLIB_DATA\n"
" Another way of overriding the compile-time default magnetic path.\n"
" If it is set (and if GEOGRAPHICLIB_MAGNETIC_PATH is not set), then\n"
" $GEOGRAPHICLIB_DATA/magnetic is used.\n"
"\n"
"ERRORS\n"
" An illegal line of input will print an error message to standard output\n"
" beginning with \"ERROR:\" and causes MagneticField to return an exit code\n"
" of 1. However, an error does not cause MagneticField to terminate;\n"
" following lines will be converted. If time or h are outside the\n"
" recommended ranges for the model (but inside the ranges increase by\n"
" tguard and hguard), a warning is printed on standard error and the\n"
" field (which may be inaccurate) is returned in the normal way.\n"
"\n"
"EXAMPLES\n"
" The magnetic field from WMM2025 in Timbuktu on 2025-01-01\n"
"\n"
" echo 2025-01-01 16:46:33N 3:00:34W 300 | MagneticField -r\n"
" => -1.04 12.00 34015.6 34010.0 -618.0 7232.0 34775.9\n"
" 0.11 0.01 4.2 5.4 63.7 5.4 5.3\n"
"\n"
" The first two numbers returned are the declination and inclination of\n"
" the field. The second line gives the annual change.\n"
"\n"
"SEE ALSO\n"
" GeoConvert(1), geographiclib-get-magnetic(8).\n"
"\n"
"AUTHOR\n"
" MagneticField was written by Charles Karney.\n"
"\n"
"HISTORY\n"
;
return retval;
}
|
