Add FAQ entry about --headers values
[weather.git] / FAQ
1 ======================================================
2  Frequently Asked Questions About the Weather Utility
3 ======================================================
4
5 :Copyright: (c) 2006-2017 Jeremy Stanley <fungi@yuggoth.org>. Permission
6             to use, copy, modify, and distribute this software is
7             granted under terms provided in the LICENSE file distributed
8             with this software.
9
10 .. contents::
11
12 1. Can I help?
13 --------------
14 Sure! Bug reports and feature suggestions are always welcome, but fixes
15 and patches are of course preferred. Contact fungi@yuggoth.org if
16 desired, but please read this FAQ and the included manuals for
17 weather(1) and weatherrc(5) before asking questions that might be
18 answered therein.
19
20 2. How do I figure out my local METAR station ID?
21 -------------------------------------------------
22 The list of stations included in the "stations" file is comprised of
23 thousands of entries, so if you're within the USA it's recommended to
24 use weather's built-in Census place name and ZCTA (postal ZIP code)
25 searching capabilities. Otherwise, using its latitude,longitude
26 coordinate search feature is probably your best bet. See the weather(1)
27 manual for examples.
28
29 3. How do I figure out my local city name and state abbreviation?
30 -----------------------------------------------------------------
31 As of the 2.0 release, this is no longer necessary. In Spring of 2011
32 the NWS switched away from city-named forecast zone IDs to the numeric
33 state zone IDs also used for alerts. As a result, weather now comes with
34 pregenerated correlations between airports/stations and zones along with
35 USA Census (FIPS and ZCTA/ZIP code) and global latitude,longitude
36 coordinates and can search among them in a flexible and intuitive
37 manner. See the weather(1) manual for examples.
38
39 4. I live outside the USA--can this be made to work for me anyway?
40 ------------------------------------------------------------------
41 ICAO codes for METAR stations can be found for cities and airports
42 worldwide, but forecast and alert data is harder to come by. If you have
43 any recommendations of plaintext data for other countries available in a
44 format like NOAA's, I will be happy to start incorporating it into the
45 weather utility. If the data is published in a non-English language,
46 I'll require some additional input from speakers of that language for
47 how to handle filtering and formatting of the text.
48
49 5. Why do I get the wrong forecast when specifying -i or --id?
50 --------------------------------------------------------------
51 As of the 2.0 release, this question is no longer relevant.
52
53 6. Where can I get a list of the NWS advisory zones for alerts?
54 ---------------------------------------------------------------
55 As of the 2.0 release, this is no longer necessary. See FAQ entries #2
56 and #3 for more detail.
57
58 7. What values are valid for a --headers list?
59 ----------------------------------------------
60 The default set it uses if you don't override it yourself on the command
61 line or in configuration is as follows::
62
63   heat_index
64   precipitation_last_hour
65   relative_humidity
66   sky_conditions
67   temperature
68   weather
69   wind
70   windchill
71
72 These are a case-insensitive match against the start of lines in a
73 decoded METAR up to the first colon (:) with underscores (_) replaced by
74 spaces. You can see the full METAR for a given condition report by
75 passing --verbose or by observing one directly (perhaps by looking in
76 your *datacache* directory). Unfortunately I haven't found any proper
77 specification for the decoded METAR format used by the NWS so know of no
78 comprehensive list of what lines might appear.