Correlation set update
[weather.git] / NEWS
1 =================================================
2  New Version Information for the Weather Utility
3 =================================================
4
5 :Copyright: (c) 2006-2012 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.0 Release
13 -----------
14 The 2.0 release involves a major rewrite of the underlying code and
15 addition of large volumes of previously-unneeded location correlation
16 data. In the Spring of 2011 the USA NOAA/NWS made significant changes to
17 the way they organized and published forecast data such that it could
18 no longer be supported by design assumptions inherent within this
19 utility. Attempts were made to preserve backward compatability with 1.x
20 command-line usage and configuration file formats where possible, but
21 some regressions are unfortunately unavoidable. The aurl, city, flines,
22 furl, id, murl, st and zones options have been removed. Minimal logic
23 was retained to recognize and continue supporting limited use of city,
24 id and st in configuration files, though these are deprecated for
25 eventual removal in a future release.
26
27 On a positive note, this provided an opportunity to design out
28 some reported bugs and add in numerous requested features. Highlights
29 include:
30
31  * Because NOAA/NWS now treats forecast data in the same way as alerts,
32    the alert reporting features are now much better integrated and no
33    longer considered a beta test.
34
35  * The lack of memorable alert/forecast zone coding in the new scheme
36    drove development of intelligent search functionality, allowing users
37    to find stations and zones through a variety of methods like place
38    names, IATA/FAA/ICAO/FIPS/ZIP codes and even raw coordinates.
39
40  * To reduce unnecessary load on NOAA/NWS servers, the utility now
41    caches retrieved data for a configurable period of time.
42
43  * Airport code lists are no longer maintained in configuration (though
44    they are still easily overridden through configuration), and are
45    instead now separately managed in a manner similar to the other
46    pregenerated correlation data.
47
48 Worth noting, however, is that the new forecast data publication format
49 (now essentially identical to the alert format) is all-caps freeform
50 prose, and not easily parsed as a result. Due to the lengthy nature of
51 this output, piping it through a pager is highly recommended.