Month.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
2,972 bytes added ,  12:10, 27 July 2020
m
(12 intermediate revisions by the same user not shown)
Line 1: Line 1:
== Introduction ==
== Introduction ==
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 []. The sections (after the first [General]) can be in any order, Cumulus will maintain whatever order the sections are currently in.  Each section has a number of parameters listed below it. Each parameter is in the format "attribute=value". For readability you can insert blank lines into this file, Cumulus will not mind. Do not however introduce any punctuation nor change the format of any parameter line.
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 []''.  
 
The sections (after the first '''[General]''') can be in any order, Cumulus will maintain whatever order the sections are currently in.   
 
Each section has a number of parameters listed below it. Each parameter is in the format "attribute=value". For readability you can insert blank lines into this file, Cumulus will not mind.  
 
'''Do not''' introduce any ''punctuation'' into this file.  '''Do not''' change the ''format of any parameter'' line.


This log file holds the information that feeds the [[Webtags#Monthly]] for the 'thismonthT.htm' web template. So you won't find the monthly rainfall total in this file, that is not in that template.
This log file holds the information that feeds the [[Webtags#Monthly]] for the 'thismonthT.htm' web template. So you won't find the monthly rainfall total in this file, that is not in that template.
=== Prior to Cumulus 1.9.2 (build 1002 - 5 July 2011) ==
 
There was no monthly functionality in Cumulus.
==DEPENDENCY ON BUILDS ==
 
=== Prior to Cumulus 1.9.2 (build 1002 - 5 July 2011) ===
 
There was no monthly functionality in Cumulus. This monthly log ini file did not exist.
 
===Cumulus builds 1041 to 1088===
 
Month.ini is one of the files that is included in the back up made each time there is a roll-over at the end of a meteorological day. All the files stored reflect the position as the day ended, not always the position as the new day starts. For example, Cumulus stores the '''Month.ini''' for the month just finishing when it does end of month roll-over.
 
=== 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 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!
 
=== Prior to Cumulus 1.9.3 beta build 1053 ===
=== Prior to Cumulus 1.9.3 beta build 1053 ===
Before this release, Cumulus did not update and save this log file correctly if Cumulus restarted between midnight and 0900/1000 on 1st of month. Put simply, earlier builds started a new month on first day of each month even if the new meteorological month had not started.
 
Before to the release of build 1053,
#If your rollover time was NOT midnight
#If you restarted Cumulus 1 on the first day of a calendar month, before your rollover time on that day
#Cumulus created a new meteorological month early, and updated the month.ini as if it had started at midnight, losing everything in the month.ini for the previous month, and corrupting the month.ini for the meteorological month that correctly starts only after rollover.
 
=== Cumulus version 1.9.4: From build 1089 to final Cumulus 1 build ===
 
On the end of month roll-over back-up folder, Cumulus stores the '''month.ini''' after it has been initialised for the new month. No copy is retained of the month.ini at the end of the month.
 
=== Cumulus MX version 3.0.0 onwards ===
 
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.
 
==Cumulus 1==
=== Viewing month.ini in Cumulus 1 ===
 
[[File:Cumulus_1_View_menu.png]]
 
These lows and highs and their timestamps can be seen (in Cumulus 1) by picking the ''Highs and Lows - This month'' screen from the '''View''' menu, see screenshot above. Like [[alltime.ini]] the file has section headings with lists of properties (attribute = value). For more information on this file see in the Cumulus help file, in the section “Data log file format”.
 
===Editing in Cumulus 1===
 
This monthly ini log file can be edited in Cumulus 1 using '''Edit''' menu ''This month's records'' screen.
 
==Viewing and Editing in MX==
 
There is limited viewing functionality prior to version 3.2.2 build 3058. From then onwards there is a monthly records viewer (that also works as editor) in the admin interface for each month in all years, consequently in first year of operation this effectively allowed editing of any single month. An editor specifically for this file for the current month is not available in MX until version 3.2.5 build 3061.
 
[[Category:Log Files]]


== Differences between Cumulus 1 and MX versions of file ==
== Differences between Cumulus 1 and MX versions of file ==
Any date/time entries are in different formats as this example from the wind section shows. Also note that Cumulus 1 will use a comma for representing the decimal point if that is how a decimal point is defined for the locale defined in your device, but Cumulus MX always expects periods/full stops in .ini files regardless of the locale in use. Thus if you want to swap from Cumulus 1 to Cumulus MX during a month, you will copy your existing Cumulus 1 "data" folder to within your MX installation, but you will also need to manually edit your '''month.ini''' file so all the date/time entries are converted to the format shown for MX in the table below. (Note that as Cumulus 1 and MX cannot be run together accessing the same weather station, the dates in the two columns do not match).
 
Any date/time entries are in different formats as this example from the wind section shows.
 
More importantly, note that Cumulus 1 will use a comma for representing the decimal point if that is how a decimal point is defined for the locale defined in your device, but Cumulus MX always expects periods/full stops in .ini files regardless of the locale in use. Thus if you want to swap from Cumulus 1 to Cumulus MX during a month, you will first copy your existing Cumulus 1 "data" folder to within your MX installation, but then you will also need to manually edit your '''month.ini''' file if you had a "," used as decimal separator to change those to ".". (While Steve Loft was working on MX he did say he was trying to find a way to get MX to accept ",").


The wind speed and gust speed may be shown as integers if that is how your weather station outputs them, and you have not asked Cumulus to calculate them in different units.
The wind speed and gust speed may be shown as integers if that is how your weather station outputs them, and you have not asked Cumulus to calculate them in different units.
Line 30: Line 83:
| WindrunTime=11/03/2019 23:59:01 || WindrunTime=2019-03-10T19:54:00
| WindrunTime=11/03/2019 23:59:01 || WindrunTime=2019-03-10T19:54:00
|}
|}
From version 3.6.0, an additional [FeelLike] section is added to this log file.


== Retaining month.ini after month changes ==
== Retaining month.ini after month changes ==
Line 54: Line 109:




The diagnostic logs in the 'diags' sub-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. The stored values can be corrected (in Cumulus 1, there is no editor in Cumulus MX) using the ''This month's records'' screen on the '''Edit''' menu. Date, Time and Decimal formatting is as per your regional settings on the PC running Cumulus. If you cannot find the file [[FAQ#I_can.E2.80.99t_find_my_data_files.21|see this FAQ]].  With MX, you would need to use an external text editor that does not add any additional control characters (see forum for suggestions).
The diagnostic logs in the 'diags' sub-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. 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.


== Viewing in Cumulus 1 ==
If you cannot find the file [[FAQ#I_can.E2.80.99t_find_my_data_files.21|see this FAQ]].
[[File:Cumulus_1_View_menu.png]]
 
These lows and highs and their timestamps can be seen (in Cumulus 1) by picking the ''Highs and Lows - This month'' screen from the '''View''' menu, see screenshot above. Like [[alltime.ini]] the file has section headings with lists of properties (attribute = value). For more information on this file see in the Cumulus help file, in the section “Data log file format”.
 
[[Category:Log Files]]
5,838

edits

Navigation menu