Month.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
2,102 bytes added ,  8 April 2022
m
Minor clarifications, to better cover C1 and MX differences
m (Minor clarifications, to better cover C1 and MX differences)
 
(2 intermediate revisions by the same user not shown)
{{Template:Version badge Mx}}{{Version badge 1}}This page applies to both flavours.
<div style="background: LemonChiffon;padding:5px; margin:2px;">
= Format of the file =
[[File:Crystal Clear info.png|40px]] This page was written for the (legacy) Cumulus 1 software. It has been partially updated to cover MX, but that was for a MX release that is no longer latest!
 
{{TOCright}}
Please can a contributor redesign this page and update content, so it is more friendly for those using latest release, while still helping those using older MX releases and the legacy Cumulus software.
</div>
 
This is as described at [[:Category:Ini_Files]], where some differences between the legacy Cumulus and MX are noted.
 
 
== Introduction ==
 
{{TOCright}}
The log file "month.ini" is where Cumulus software tracks the extremes for this month, the file is divided into a number of sections ''headed by a name in square brackets []''.
 
== Cumulus 1.9.2 ==
 
PleaseThe Cumulus 1.9.2 beta releases were the first appearance of monthly (and yearly) extreme record tracking. The release announcement when 1.9.2 came out of beta (see https://cumulus.hosiene.co.uk/viewtopic.php?p=51829#p51829) forstarts detailsby aboutexplaining how to use the new high/low editing screen for initialising the extra extreme records addedincluded toin the new file '''month.ini''' inthat formed part of this release.
 
 
=== PriorBugs present prior to Cumulus 1.9.3 beta build 1048 ===
 
Month.ini contains the highest daily value for certain derivatives in the month, those daily values are supposed to be accumulated over a meteorological day, so the accumulation resets at rollover time. Due to a programming bug, some were reset at midnight irrespective of actual rollover time. Prior to build 1048 this meant that for those using 9am/10am rollover, wind run (for example) accumulated between midnight and rollover was assigned to the following day. Equally, some values where peaks at a particular time were tracked in this file, the date logged was adjusted to the correct calendar day, but between midnight and rollover it should be assigned to meteorological date (the previous calendar date) to ensure peaks were not assigned to wrong month. The full description of bugs was not recorded as it was assumed everyone updated to fixed build, and people did not care about past records (Cumulus 1 at this stage discarded records for past months). It was subsequently discovered that the bugs were not fixed completely in build 1048!
 
Without getting too technical, some of the time-stamps in this file are in a specific to Cumulus time-zone, that for 9am/10am rollover, differs from the time-zone of the host computer. In this internal processing time-zone, the date part is a [[Meteorological day|meteorological date]] and the time part is zero (00:00) at rollover, so that a time part shown as 03:00 actually represents noon on the computer clock with Cumulus 1 set to rollover at 09:00 on the computer clock. Against that background, some values where peaks at a particular time were tracked in this file. Cumulus was supposed to convert the internal time-stamps to computer clock equivalents for outputs in web tags (the date logged was adjusted to the correct calendar day, the time adjusted to correct time within that day). Unfortunately, this meant for extremes timed between midnight and rollover on the first day of a new month, Cumulus was assigning them to the new month, instead of the old month, because the conversion from internal meteorological date (the previous calendar date) in the previous month to calendar (computer clock) date happened too early in the processing sequence!
== Prior to Cumulus 1.9.3 beta build 1053 ==
 
The full description of bugs was not recorded as it was assumed everyone updated to any build claimed to be fixing bugs, and people did not care about past records (Cumulus 1 at this stage discarded records for past months). It was subsequently discovered that the bugs were not fixed completely in build 1048!
 
=== PriorBugs remaining prior to Cumulus 1.9.3 beta build 1053 ===
 
Before to the release of build 1053,
 
== Cumulus MX version 3.0.0 onwards ==
 
<div style="background: LemonChiffon;padding:5px; margin:2px;">
[[File:Crystal Clear info.png|40px]] This page was written for the (legacy) Cumulus 1 software. It has been partially updated to cover MX, but that was for a MX release that is no longer latest!
 
Please can a contributor redesign this page and update content, so it is more friendly for those using latest release, while still helping those using older MX releases and the legacy Cumulus software.
</div>
 
 
MX uses the same '''month.ini''' file to record extreme records for current month. At start of each meteorological day, MX backs up the current file as in its [[Data folder|/data]], so when the month changes, this backs up the (empty) file for new month. The content is essentially same as other flavours except that when new extremes occur the date format used has year first as shown in example in table below. 3.6.x releases of MX add Canadian Humidity Index and Feels Like Temperatures to what is stored.
 
From build 3035 onwards, MX archives the month.ini and year.ini file at the end of the month/year as monthYYYYMM.ini and yearYYYY.ini. This means that although the file saved in the back up daily folder contains the month.ini for the new month and so does not back up the end of month position, the old monthly log ini file is preserved for true end of month state in the data folder with a new name.
 
 
From version 3.6.0, an additional [FeelsLike] section is added to this log file.
 
== Retaining month.ini after month changes ==
 
[[File:Badge vMx.png]]InAs mentioned [[#Cumulus MX, version 3.0.0 onwards|at end of this section]] Cumulus MX retains the file at the end of each month,. the The final ''month.ini'' for that month is renamed '''monthYYYYMM.ini''' (where YYYY denotes the year using 4 digits and MM denotes the month using two digits) e.g. ''month201703.ini'', thus ensuring that statistics for all past months remain accessible.
 
[[File:Badge v1.png]]ThereAlthough isCumulus no1 obviousresets facility''month.ini'' at the end of each month, without saving the file [[#Cumulus version 1.9.4: From build 1089 to achievefinal aCumulus similar1 retentionbuild|see automaticallyhere]], it is possible to view old months using [[Cumulus_Screenshots#View_data|screen]] provided in Cumulus 1,; althoughthat allgenerates thea informationsimilar can(but not identical extreme records) set of bemonthly generatedderivatives by doing calculations from the relevant lines in dayfile.txt. If you want such information on a web page, then some JavaScript code (as explained in support forum posts) can parse a copy of [[Dayfile.txt]] uploaded to your web server, and do the equivalent calculations. If the daily summary is available in a database table, then those calculations are very easy to code in SQL. ifFor thethose dailytechnically summaryable, there is availablean easy work-around to save month.in on a databasemonthly basis using the "extra files" feature. However,It thereworks because you can include "<currentlogfile>" in a remote path. Please note that this is an inefficient process (because there is no facility within Cumulus 1 to perform an action only when month ends, and this technique therefore adds an action each time Cumulus does an update) work-aroundprocess, usingbut theit "extrais files"easy featureto that you can include "<currentlogfile>"implement:
ExtraLocal25=data\month.ini
ExtraRemote25=data\month<currentlogfile>.ini
ExtraFTP25=0
 
This will save a file with a name like '''monthMar19log.txt.ini''' in your data folder. Note that there might be changes to month.ini after the last time the above work-around copies it, because the copy happens one update interval before the end of the month rollover and so will not pick up any extremes recorded in closing seconds of the month.
 
= Meaning of the different parameters =
 
You have probably worked out that the attribute ''Speed'' in the examples in the above table is the maximum wind speed, that ''Gust'' is the maximum gust speed in the month and that ''Windrun'' is the maximum daily wind run. Those are the three rows that appear in the wind section of the table in the '''thismonth.htm''' web page. But you might be puzzled that the web page only shows a date for the maximum daily wind run, yet the month.ini entry includes a time. All that means is there was no wind after that time on that day, in Cumulus 1 if you edit your template '''thismonthT.htm''' and specify ''<#MonthWindRunHD format=HH:nn>'' you will see the time appear instead of the date. Put simply, the date/time entry is when Cumulus last updated that figure. In this particular case its calculated wind run never exceeded that figure in this month, so the entry has not been updated. Similarly, highest daily rainfall tracking includes a time, representing the final updating of the total on the date reported.
 
In the [Temp] section, some of Steve's attribute names might be slightly less obvious. '''Low=''' is obviously the lowest temperature in the month and '''High=''' the highest. Comparing entries against the web page; Highest Minimum is obviously '''HighMin=''' and '''HighRange=''' the ''Highest Daily Range''. All the rest are easy to work out. For the date/time entries High is frequently (not in 'HighRange' example) abbreviated to 'H', Low to 'L' and the characters 'Time' are appended.
For full details see [[Correcting Extremes]] page.
 
The diagnostic logs (for cumulus 1 in [[Diags folder]]) record before and after values for updates to highs and lows for monthly and annual extreme records, and can help if this file is corrupted by a false extreme. TheMX storeddiagnostics valuesdo canreport bewhen corrected"month.ini" inis Cumulusupdated, 1but usingthey the 'don'Thist month's(at records''time screenof ontyping thethis) '''Edit'''record menu.what Inwas MXupdated, theso equivalent editorthere is accessedno viabefore theand user interface you see in aafter browsertracking.
 
The stored values can be corrected in Cumulus 1 using the ''This month's records'' screen on the '''Edit''' menu. In MX the equivalent editor is accessed via the user interface you see in a browser.
 
If you cannot find the file when using Microsoft Windows [[FAQ#I_can.E2.80.99t_find_my_data_files.21|see this FAQ]].
 
 
[[Category:LogIni Files]]
5,838

edits

Navigation menu