Year.ini

Category:Ini Files
 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.
= Introduction =
The log file "year.ini" (introduced by 1.9.1 beta builds) is where Cumulus software tracks the extremes for this year. 
= Format of the file =
This is as described at :Category:Ini_Files, where some differences between the legacy Cumulus and MX are noted. Therefore if you use decimal commas and are migrating this year.ini file from Cumulus 1 to MX, you need to do an edit so all the values entries are converted to use a full stop as decimal separator. 
You may find it useful to read the month.ini page, which goes into slightly more detail as much of that applies to this file too.
For more information on this file see in the Cumulus 1 help file, in the section “Data log file format”. MX has changed to an ISO date format for each new time-stamp, but otherwise the file works the same way.
The sections (after the first [General]) can be in any order, Cumulus will maintain whatever order the sections are currently in. 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.
== Content ==
This log file holds the information that feeds the Webtags#Yearly for the 'thisyearT.htm' web template. So you won't find the yearly rainfall total in this file, that is not in that template.
== Differences between Cumulus versions for this log file ==
This year extreme record functionality is not present prior to Cumulus 1.9.1 (build 958 - Mon 01 Nov 2010), so this file only exists for that and later builds of Cumulus 1, and all MX builds.
Some of the notes about problems with month.ini in particular builds apply equally to year.ini. An editor for this file is not available in MX until version 3.2.5 build 3061.
The sections that are included in this file vary by version. There are more for MX than there were for Cumulus 1. The sections are same as for month.ini.
Some Cumulus 1 builds did not store correct values for those using 9am/10am rollover, see alltime.ini for some examples.
Any date/time entries are in different formats for Cumulus 1 and Cumulus MX as illustrated for month.ini. That page also tells you that MX can read the Cumulus 1 date/time formats, so if you move a "year.ini" from Cumulus 1 you do not need to edit the date/time entries, MX will update them when its hits the first new extreme to record for the year.
If you do move "year.ini" from Cumulus 1 to Cumulus MX and were using a comma as your decimal separator (e.g. 12,1) you will need to edit your file and change each (e.g. 12,1) to use a full stop before MX can read it (e.g. 12.1).
= Dealing with errors =
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. 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.
The stored values can be corrected using the functionality available in both Cumulus 1 and MX for editing this year's records.
These lows and highs and their timestamps can be seen by picking the Highs and Lows - This year screen from the View menu (Cumulus 1 only - see picture on this page).
If you cannot find the file when using Microsoft Windows see this FAQ.