Reports folder: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
1,830 bytes added ,  16:35, 22 March 2021
m
Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)"
m (→‎Introduction: add appeal for contributor)
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)")
(6 intermediate revisions by the same user not shown)
Line 13: Line 13:
== A brief history of these reports ==
== A brief history of these reports ==


Cumulus 1, 2, and MX, generate climatological reports for both Monthly and Yearly periods. The reports were first added to Cumulus 2 after someone asked for this feature in enhancement request 44. They were based on Weatherlink reports, that in turn were based on climatological reports issued by The US National Oceanic and Atmospheric Administration's National Weather Service (the reason for using NOAA in the naming of the reports). Ken True implemented the Weatherlink reports in his Saragota suite, and Steve Loft took that as his starting point. Although they were first only in Cumulus 2, they were added to Cumulus 1 in version 1.9.2 (build 1004) released in July 2011, after the abandonment of Cumulus 2.
Cumulus 1, 2, and MX, generate climatological reports for both Monthly and Yearly periods.  
 
The reports were first added to Cumulus 2 after someone asked, in enhancement request 44, if Cumulus software could copy what a rival weather software package ('''Weatherlink''') did and output some climatological reports.
 
Steve Loft did some investigation, and found that Ken True had implemented the Weatherlink reports in his Saratoga suite, so Steve Loft took that as his starting point (see [https://cumulus.hosiene.co.uk/viewtopic.php?f=20&t=5689 Steve's post on the Cumulus Support Forum] for more details). 
 
These Saratoga reports were based on climatological reports ([https://forecast.weather.gov/product.php?site=CRH&product=CLA&issuedby=AST annnual report] and [https://forecast.weather.gov/product.php?site=CRH&product=CLM&issuedby=AST monthly report]), issued by The US National Oceanic and Atmospheric Administration's National Weather Service (the reason why Steve Loft decided to use NOAA in the naming of the reports).
 
Steve Loft had abandoned work on Cumulus 1 at the time he worked on this enhancement request, so the first implementation was in Cumulus 2 as Steve was developing that at the time.
 
Subsequently, Steve Loft abandoned Cumulus 2, so his NOAA report design was added to Cumulus 1, this was in version 1.9.2 (build 1004) released in July 2011.
 
When Steve Loft first started work on [[Cumulus 3 (MX) beta documentation|Cumulus 3 (MX) beta]], he initially did NOT include this climate report functionality, but it was added subsequently to Cumulus MX.
 
 
=Additional Information for NOAA reports =
 
Be aware that a regenerated report might not be quite as accurate as original report which when generated is using figures actually being processed by end of day for the current day.
 
'''NOAA Report Notes:'''
* for obsolete versions up to 1.9.4 build 1085 only: The average wind speed used for NOAA reports and 'This period' type screens was, by a bug, based on midnight to midnight days regardless of rollover time in use. (It is calculated on generation of report or screen from standard log file entries).
*From build 1086, the calculation is based on the rollover time being used.
* For all Cumulus 1 versions, and the MX versions below 3.4.4: the yearly average temperature is calculated from summing monthly maximum and monthly minimum values and dividing by number of values in calculation.
* From version 3.4.4 the annual average temperature is calculated using the integrated method based on every temperature reading processed (it is actually the average calculated from all daily means stored in daily summary log for this year).


When Steve Loft started work on [[Cumulus 3 (MX) beta documentation|Cumulus 3 (MX) beta]], he initially did NOT include this climate report functionality, but it was added subsequently to Cumulus MX.


= NOAA style Report Naming =
= NOAA style Report Naming =
Line 21: Line 43:
== The format used for naming reports==
== The format used for naming reports==


The monthly reports have a name in this format '''"NOAAMO"...".txt"'''.  The yearly reports have a name in this format '''"NOAAYR"...".txt"'''. This format with 4 double quotes in all cases is used both in the NOAA settings screen and in the [[Cumulus.ini#Section:_NOAA|[NOAA] section of Cumulus.ini]].
The monthly reports have a name in this format '''"NOAAMO"...".txt"'''.  The yearly reports have a name in this format '''"NOAAYR"...".txt"'''. This format with 4 double quotes in all cases is used both in the NOAA settings screen and in the [[Cumulus.ini_(Cumulus_1)#Section:_NOAA|[NOAA] section of Cumulus.ini_(Cumulus_1)]].


It is between the double quotes where I have placed '...' that Cumulus expects us to use the date output modifiers described. Note that the double quotes must be used at each of the places where they are shown when you define your report naming in the NOAA Settings screen of either Cumulus 1 or MX.  The default selected by Steve Loft is '''MMyyyy''' and '''yyyy''' respectively (expressed in a way that suits both Cumulus 1 and MX) so the inserted part is all numerical. Here is a table showing the main alternative options, for more details about these selectors see the [[Webtags#List_of_allowed_modifiers|table below]]  as there are obviously a lot more options.
It is between the double quotes where I have placed '...' that Cumulus expects us to use the date output modifiers described. Note that the double quotes must be used at each of the places where they are shown when you define your report naming in the NOAA Settings screen of either Cumulus 1 or MX.  The default selected by Steve Loft is '''MMyyyy''' and '''yyyy''' respectively (expressed in a way that suits both Cumulus 1 and MX) so the inserted part is all numerical. Here is a table showing the main alternative options, for more details about these selectors see the [[Webtags#List_of_allowed_modifiers|table below]]  as there are obviously a lot more options.
Line 129: Line 151:
   
   
Remember, most modern web pages (including the standard web templates provided with both flavours of Cumulus) use UTF-8 encoding.  The only problem is MX not defaulting to this for NOAA reports.
Remember, most modern web pages (including the standard web templates provided with both flavours of Cumulus) use UTF-8 encoding.  The only problem is MX not defaulting to this for NOAA reports.
[[Category:Cumulus MX]][[Category:Cumulus Files]]
5,838

edits

Navigation menu