Update release notes and docs for 2.2 release
[weather.git] / NEWS
1 =================================================
2  New Version Information for the Weather Utility
3 =================================================
4
5 :Copyright: (c) 2006-2016 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 2.2 Release
13 -----------
14 Fixed a bug where the setpath search order was effectively being
15 reversed.
16
17 Updated correlation data is included based on newer 2015 Census data and
18 2016 NWS station and zone lists.
19
20 2.1 Release
21 -----------
22 The old http://weather.noaa.gov/pub site was deprecated and as of August
23 23 subsequently removed from service. Correlation data files have been
24 updated to use the working http://tgftp.nws.noaa.gov URL instead.
25
26 Updated correlation data is included based on newer 2014 Census data.
27
28 The correlation data rebuilding process has been improved and more
29 thoroughly documented.
30
31 Radian floats in correlation data are now truncated to 7 decimal places,
32 significantly reducing rounding error fuzz against future data file
33 updates.
34
35 The /etc/weather/weatherrc file mentioned in documentation is now
36 properly read.
37
38 2.0 Release
39 -----------
40 The 2.0 release involves a major rewrite of the underlying code and
41 addition of large volumes of previously-unneeded location correlation
42 data. In the Spring of 2011 the USA NOAA/NWS made significant changes to
43 the way they organized and published forecast data such that it could
44 no longer be supported by design assumptions inherent within this
45 utility. Attempts were made to preserve backward compatability with 1.x
46 command-line usage and configuration file formats where possible, but
47 some regressions are unfortunately unavoidable. The aurl, city, flines,
48 furl, id, murl, st and zones options have been removed. Minimal logic
49 was retained to recognize and continue supporting limited use of city,
50 id and st in configuration files, though these are deprecated for
51 eventual removal in a future release.
52
53 On a positive note, this provided an opportunity to design out
54 some reported bugs and add in numerous requested features. Highlights
55 include:
56
57  * Because NOAA/NWS now treats forecast data in the same way as alerts,
58    the alert reporting features are now much better integrated and no
59    longer considered a beta test.
60
61  * The lack of memorable alert/forecast zone coding in the new scheme
62    drove development of intelligent search functionality, allowing users
63    to find stations and zones through a variety of methods like place
64    names, IATA/FAA/ICAO/FIPS/ZIP codes and even raw coordinates.
65
66  * To reduce unnecessary load on NOAA/NWS servers, the utility now
67    caches retrieved data for a configurable period of time.
68
69  * Airport code lists are no longer maintained in configuration (though
70    they are still easily overridden through configuration), and are
71    instead now separately managed in a manner similar to the other
72    pregenerated correlation data.
73
74 Worth noting, however, is that the new forecast data publication format
75 (now essentially identical to the alert format) is all-caps freeform
76 prose, and not easily parsed as a result. Due to the lengthy nature of
77 this output, piping it through a pager is highly recommended.