Refresh correlation data
[weather.git] / NEWS
1 =================================================
2  New Version Information for the Weather Utility
3 =================================================
4
5 :Copyright: (c) 2006-2020 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.4 Release
13 -----------
14 This is planned to be the last release supporting Python 2; starting
15 with the 3.0.0 release, this software will only be usable with Python
16 3.5 and later.
17
18 Refreshed correlation sets and data sources including updating to 2019
19 US Census locations and incorporating public domain airport information
20 from the wonderful ourairports.com community, stopped using the long
21 defunct metar.tbl and zonecatalog.curr.tar files, switched to HTTPS
22 protocol since all the URLs had started redirecting from HTTP to HTTPS
23 anyway, added functionality for fetching forecasts from HTML pages where
24 they're wrapped in preformat tags and included a new forecast zone for
25 the Hong Kong Observatory using this, fixed a few bugs when running
26 under recent Python 3 versions.
27
28 2.3 Release
29 -----------
30 Fixed a regression in the correlate function which reintroduced the
31 wrong (old) URLs for zone-specific data sources, and corrected the
32 entries in the zones file accordingly.
33
34 2.2 Release
35 -----------
36 Fixed a bug where the setpath search order was effectively being
37 reversed.
38
39 Updated correlation data is included based on newer 2015 Census data and
40 2016 NWS station and zone lists.
41
42 2.1 Release
43 -----------
44 The old http://weather.noaa.gov/pub site was deprecated and as of August
45 23 subsequently removed from service. Correlation data files have been
46 updated to use the working http://tgftp.nws.noaa.gov URL instead.
47
48 Updated correlation data is included based on newer 2014 Census data.
49
50 The correlation data rebuilding process has been improved and more
51 thoroughly documented.
52
53 Radian floats in correlation data are now truncated to 7 decimal places,
54 significantly reducing rounding error fuzz against future data file
55 updates.
56
57 The /etc/weather/weatherrc file mentioned in documentation is now
58 properly read.
59
60 2.0 Release
61 -----------
62 The 2.0 release involves a major rewrite of the underlying code and
63 addition of large volumes of previously-unneeded location correlation
64 data. In the Spring of 2011 the USA NOAA/NWS made significant changes to
65 the way they organized and published forecast data such that it could
66 no longer be supported by design assumptions inherent within this
67 utility. Attempts were made to preserve backward compatability with 1.x
68 command-line usage and configuration file formats where possible, but
69 some regressions are unfortunately unavoidable. The aurl, city, flines,
70 furl, id, murl, st and zones options have been removed. Minimal logic
71 was retained to recognize and continue supporting limited use of city,
72 id and st in configuration files, though these are deprecated for
73 eventual removal in a future release.
74
75 On a positive note, this provided an opportunity to design out
76 some reported bugs and add in numerous requested features. Highlights
77 include:
78
79  * Because NOAA/NWS now treats forecast data in the same way as alerts,
80    the alert reporting features are now much better integrated and no
81    longer considered a beta test.
82
83  * The lack of memorable alert/forecast zone coding in the new scheme
84    drove development of intelligent search functionality, allowing users
85    to find stations and zones through a variety of methods like place
86    names, IATA/FAA/ICAO/FIPS/ZIP codes and even raw coordinates.
87
88  * To reduce unnecessary load on NOAA/NWS servers, the utility now
89    caches retrieved data for a configurable period of time.
90
91  * Airport code lists are no longer maintained in configuration (though
92    they are still easily overridden through configuration), and are
93    instead now separately managed in a manner similar to the other
94    pregenerated correlation data.
95
96 Worth noting, however, is that the new forecast data publication format
97 (now essentially identical to the alert format) is all-caps freeform
98 prose, and not easily parsed as a result. Due to the lengthy nature of
99 this output, piping it through a pager is highly recommended.