Standard log files: Difference between revisions

14,483 bytes removed ,  09:41, 30 January 2021
no edit summary
m (Text replacement - "[[Diags" to "[[Diags_folder")
No edit summary
Line 1: Line 1:
= Introduction =
= Introduction =


This article is about the standard logging file that stores the full set of current (read and derived) values at whatever interval you have set for Cumulus to keep detailed logging. The default time between data logging lines is every 10 minutes, but you can change this:
Cumulus has ability to create a number of data logs, most ('''[[Speciallog.txt]]''' , [[Extra_Sensor_Files]], and [[Air_Link_Log.txt]]) are optional, in that settings determine whether they are created or not. However, thi page documents the data logs that are not optional (hence termed "standard"). These store the full set of current (read and derived) values at whatever interval you have set for Cumulus to keep detailed logging. The default time interval between adding data logging lines is every 10 minutes, but you can change this:
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Data log interval''' box on extreme RH side.
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Data log interval''' box on extreme RH side.
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Log interval''' after the ''Ecowitt GW1000 Settings'' section.
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Log interval''' after the ''Ecowitt GW1000 Settings'' section.
Line 11: Line 11:
There is an equivalent logging file for [[Extra_Sensor_Files|extra sensor]] values.  In fact, in Cumulus MX, the processing of this extra sensor logging file shares a lot of the code with the processing of the standard logging file, as they both are updated at same interval, and they both take values processed following a read from your weather station. The applications programming interface (api) that sends values between the MX engine and the MX admin interface is also identical (with a parameter "Extra" that swaps between true and false depending on the log file involved).
There is an equivalent logging file for [[Extra_Sensor_Files|extra sensor]] values.  In fact, in Cumulus MX, the processing of this extra sensor logging file shares a lot of the code with the processing of the standard logging file, as they both are updated at same interval, and they both take values processed following a read from your weather station. The applications programming interface (api) that sends values between the MX engine and the MX admin interface is also identical (with a parameter "Extra" that swaps between true and false depending on the log file involved).


There is another logging file, [[speciallog.txt]], for detailed logging of internal temperature and humidity, but it is not split into separate files for each month.  Although this exists in Cumulus 1, it appears this functionality is missing from MX.
There is another logging file, [[speciallog.txt]], for detailed logging of internal temperature and humidity, but it is not split into separate files for each month.  Although this exists in Cumulus 1, it appears this functionality will remain missing from MX.
 
Finally, MX development has added another data log, this stores the output from [[Air Link Log.txt|air link]] sensors.


{{TOCright}}
{{TOCright}}
This article is based on text written before MX was available. Although it has been updated to cover MX 3.0.0, only selected parts of this article (like the list of fields) have been updated for later MX versions.  Check for edits by developer.


= File content =
= File content =
Line 24: Line 24:
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Units''' box is just below the centre of that screen.
*Cumulus 1: From Configuration menu, select the [[Cumulus_Screenshots#Station|station settings screen]], '''Units''' box is just below the centre of that screen.
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Units''' section at the start of that screen.
*Cumulus MX: From settings tab, select the '''Station settings''' screen, and find '''Units''' section at the start of that screen.


Each line has a number of fields separated by whatever symbol is defined as the list separator on your device, typically a comma (,) or a semi-colon (;).  
Each line has a number of fields separated by whatever symbol is defined as the list separator on your device, typically a comma (,) or a semi-colon (;).  
Line 32: Line 31:
***Note that it is perfectly possible to have two successive lines in a standard log file with same time, although this should not happen in normal running, it can result from a hiccup or other interference on your device. If you are asking MX to upload the contents of this file, a second line with same time is ignored, only the first line with a particular date and time is uploaded.
***Note that it is perfectly possible to have two successive lines in a standard log file with same time, although this should not happen in normal running, it can result from a hiccup or other interference on your device. If you are asking MX to upload the contents of this file, a second line with same time is ignored, only the first line with a particular date and time is uploaded.
** All Remaining fields are spot values, either what has just been read from your station, or a derived value calculated from a set of values read from your station. For these value fields, Cumulus may have converted from the unit used by your weather station to the unit that you have requested to use, and there will be some inaccuracy inevitable in such conversions. Where the value to be stored is a real number with decimal places, Cumulus will use a decimal comma or decimal point depending on which is defined in your locale, do be careful not to change that locale if you need to change your device or update it, as Cumulus can only read files where the same decimal separator is used everywhere.
** All Remaining fields are spot values, either what has just been read from your station, or a derived value calculated from a set of values read from your station. For these value fields, Cumulus may have converted from the unit used by your weather station to the unit that you have requested to use, and there will be some inaccuracy inevitable in such conversions. Where the value to be stored is a real number with decimal places, Cumulus will use a decimal comma or decimal point depending on which is defined in your locale, do be careful not to change that locale if you need to change your device or update it, as Cumulus can only read files where the same decimal separator is used everywhere.


For ''more information'' on these files see in the '''Cumulus help''' file, in the section “The Data log file”. This is installed with Cumulus 1, but can be read with Windows after downloading from [[Software#Resources]] page in this Wiki.
For ''more information'' on these files see in the '''Cumulus help''' file, in the section “The Data log file”. This is installed with Cumulus 1, but can be read with Windows after downloading from [[Software#Resources]] page in this Wiki.


= Accessing the Standard Log File =
= Accessing the Standard Log File =
Please see [[Calculate Missing Values]] and [[Correcting Extremes]] for full details on relevant functionality in Cumulus software.


== Access to current log by other processes ==
== Access to current log by other processes ==


As the log file for the current month will be updated frequently by Cumulus (when it is running), Cumulus 1 applies an exclusive lock, and (as explained further below) conflicts can happen if another process seeks to access this file. Consequently don't let your antivirus scans access this file, nor try to edit it outside Cumulus while Cumulus is running.  
As the log file for the current month will be updated frequently by Cumulus (when it is running), Cumulus 1 applies an exclusive lock, and [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=12721 conflicts] can happen if another process seeks to access this file. Consequently don't let your antivirus scans access this file, nor try to edit it outside Cumulus while Cumulus is running. Whilst MX does not apply such locks, it would be unwise to externally edit a file that is being frequently updated while MX is running.
   
   
Also note these log files do not include a header line, and should not be edited to include it.
Also note these log files do not include a header line, and should not be edited to include it.
The appropriate header file for the standard data logs can be found for any installed version of Cumulus by looking for "monthlyfileheader.txt", in the directory above the 'data' directory containing the standard log. The viewing screens for the two flavours, as described next, automatically include the header line above the tables they show.
A full discussion of the problems with conflicts of access to the standard log file can be found [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=12721 in this support forum topic].
== Viewing the standard log file in Cumulus 1 ==
In the '''View''' menu of Cumulus 1, select ''Data logs'', click '''Load...'''. 
The standard Windows File Select dialogue is displayed for the 'data' subdirectory of the Cumulus installation directory.
Select the required month for which to display the standard log, click '''Open''' and you will see the contents in a neat table with column headings, rows striped, and the date/time on a lighter background. This is a text viewer, and works best when at full screen, but even then you are likely to need to scroll both horizontally and vertically to look at all the figures. If you click on an individual figure the cell will be highlighted, but you cannot edit the figures on a view screen.  Cumulus 1 does not provide an editing facility for this file.
=== Problems in Cumulus 1 ===
If no logs seen, see  [[FAQ#I_can.E2.80.99t_find_my_data_files.21|FAQ: I can't find my data files]]. Also note, this '''Data logs''' viewer is only for viewing standard log files (not any other files in the same ''data'' directory), the column headings for standard (monthly) log files will always be shown at the top of the screen.
=== Editing for Cumulus 1 users ===
Cumulus 1 allows you to view any standard log file, but not to edit the contents. Consequently for Cumulus 1, you need to edit standard log files outside Cumulus 1, subject to the following rules:
* You can't edit the current log file while Cumulus 1 is running, because Cumulus needs exclusive write access. You can edit the log file for a past month, unless you are looking at past months using Cumulus  editors.
* You can't edit any log file with a word processor, as they add control characters and other information that Cumulus cannot understand.
* You can use either a specialised comma separated value file editor or a text editor.
* Text editors designed for programmers will allow you to select the encoding (Cumulus will be confused by any Byte Order Mark, so select the encoding type without BOM).
* If you choose to use a spreadsheet, ensure that all columns are treated as normal text, do not let (don't accept Excel default) the spreadsheet recognise the first field contains a date as it will convert that column into a number (e.g. days since 1900 or days since 1970). For example in Libre Office make sure that "Detect special numbers" is not selected.  Many spreadsheets will offer a CSV option for saving the file (in Libre Office tick "Edit Filter Settings" on "save as ...").
* If you amend a field, ensure that replacement is same format as original (same decimal separator if not integer).
* Ensure no blank lines, and if you have added in the column headings then remove that heading line when saving ready for Cumulus.
You can see [[#Manipulation outside Cumulus]] below for more information.
== The viewing and editing web page in admin interface of Cumulus MX ==
In the admin interface, there is a "Data Logs" tab, from it  select ''Data logs''.
*On this screen,you see a box for selecting the log you want to display. The default month and year (shown on loading the web page) is taken from yesterday's date. No log is loaded at start up. You can '''either''' type in a period (one or two digit representing month, then hyphen, then four digits representing year) '''or''' select year then month in the data picker (this is produced by the bootstrap software MX uses, it is not the date picker provided by your browser), when you click on the month the box is updated with selected period.
* Next to it is a "Load" button. Press it and the Cumulus MX engine will generate an application programming interface (api) table that will appear on the web page using dataTables software. There is a "Refresh" button, for when you want that api to refresh the table (without reloading the whole page).
=== No conflict ===
Because the dataTables version of the log seen on this web page in the admin interface, is not the actual log being used by the MX "engine", there can be no conflicts on access and this way of editing log files is just as safe for the current log as for past logs.


== Additional ideas for how any Standard Log File can be used within Cumulus ==
== Additional ideas for how any Standard Log File can be used within Cumulus ==
Line 110: Line 70:
#The second, which only uploads the line most recently added to the standard log file is found in the '''My SQL''' settings section of the admin interface. Find more information at [[Cumulus_MX#MySQL_settings|MySQL settings]]. In this option the default table name is "monthly", but it can be changed.
#The second, which only uploads the line most recently added to the standard log file is found in the '''My SQL''' settings section of the admin interface. Find more information at [[Cumulus_MX#MySQL_settings|MySQL settings]]. In this option the default table name is "monthly", but it can be changed.


===After you have edited (or created any missing) Standard log files, you can:===
===Additional Functionality in Cumulus===


* HOW TO CORRECT HIGHS AND LOWS IN CUMULUS 1
*Additional derived values in original Cumulus software
** update the highs and lows in [[Alltime.ini]] by choosing ''all time records'' from the '''Edit''' menu. See [[Alltimelog.txt]] for current and previous values.
** You can see '''[[Average_temperature | Mean temperatures]]''', '''[[Heat/cold_degree_days_and_Chill_hours | Air frosts]]''', '''[[Gale_Days |Gale days]]''', '''[[Rain_measurement#Precipitation_measurement_and_Cumulus | Rain days, Dry days]]''', and '''Total [[Windrun |Wind run]]''' using '''View''' menu displays for ''This month'', ''This period'', and ''This year'' (These  figures are not stored anywhere, nor available as [[Webtags|web tags]]), but Cumulus 1 can calculate these from what it finds in the standard log files and the daily summary log.
** update (if the created/edited standard log is within the current year) the highs and lows in [[year.ini]] by choosing ''This year's records'' from the '''Edit''' menu.
** You can use '''create missing''' button in the ''[[dayfile.txt]]'' selection in the '''Edit''' menu.
** update (if the created/edited standard log is for the current month) the highs and lows in [[month.ini]] by choosing ''This month's records'' from the '''Edit''' menu. See [[Diags_folder]] for current and previous values.
** update (from version 1.9.3) the highs and lows in [[monthlyalltime.ini]] by choosing ''Monthly records'' from the '''Edit''' menu. Click the ''Help'' button for specific instructions on using ''Reset'' and the two ''Copy'' column header buttons in this ''Monthly Records (Highs and Lows) Editor'' to action all rows.
  '' '''Note''' in each of above 4 editing screens you can:
# see the currently stored extremes, and optionally ''Reset'' (row by row) to pre-editing value and timestamp.
# load all standard log files, and dayfile.txt to view extremes calculated from those figures (as available) and
# optionally (in Cumulus 1 only) click ''Copy'' (row by row) to move the logged values (and associated date/time information) into the relevant .ini file.
#*In the MX editor, you need to manually type the numbers read in from the other logs into the output log column.
# (In cumulus 1 only) click the ''Help'' button for detailed instructions on using ''The Records (Highs and Lows) Editors''.
# In cumulus 1, store your revised figures by clicking ''OK'' (or abandon all your edits by clicking ''Cancel'').
#*In MX there are tick and cross options for same effect.
  (Each of these screens is a text editor, and works best when at full screen).''
 
*HOW TO USE CORRECTED INFORMATION
**  (In cumulus 1 only) see '''[[Average_temperature | Mean temperatures]]''', '''[[Heat/cold_degree_days_and_Chill_hours | Air frosts]]''', '''[[Gale_Days |Gale days]]''', '''[[Rain_measurement#Precipitation_measurement_and_Cumulus | Rain days, Dry days]]''', and '''Total [[Windrun |Wind run]]''' using '''View''' menu displays for ''This month'', ''This period'', and ''This year'' (These  figures are not stored anywhere, nor available as [[Webtags|web tags]]), but Cumulus 1 can calculate these from what it finds in the standard log files and the daily summary log.
** (In cumulus 1 only) use '''create missing''' button in the ''[[dayfile.txt]]'' selection in the '''Edit''' menu;  This is a text editor, and works best when at full screen. Cumulus will then look through all standard log files and create approximate records for any ''missing dates'' in the dayfile if those dates have observations stored in the relevant standard log. (It creates a file in the Cumulus folder called ''dayfileeditlog.txt'' which contains the entries it created).  Click the ''Help'' button for more information.  In past and current versions (including 1.9.3), ''create missing'' will not affect any records that are incomplete or contain some rogue values (see [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] below).
** obtain (in Cumulus 1 by [[Standard_log_files#Viewing_standard_log_files | viewing the created/edited log file]]) figures needed for manually correcting rogue figures in [[dayfile.txt]]. See for example [[FAQ#My_monthly_and.2For_annual_rainfall_totals_are_wrong | FAQ re correcting rainfall]].
** create the relevant monthly and/or annual '''NOAA style report''' by choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''.  
** create the relevant monthly and/or annual '''NOAA style report''' by choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''.  
***In Cumulus 1 do this from the '''View''' menu, then select the required period using the selectors.  Click the ''Update Display'' button to see various statistics (including [[Average_temperature|mean temperature]]) calculated.  Generation of complete NOAA reports takes most information from dayfile.txt (based on rollover to rollover meteorological days), except average wind speed and dominant wind direction (both of these it calculates from values read from the standard log files) for period in question. Finally press ''Save'' button to store the new or amended report.
***In Cumulus 1 do this from the '''View''' menu, then select the required period using the selectors.  Click the ''Update Display'' button to see various statistics (including [[Average_temperature|mean temperature]]) calculated.  Generation of complete NOAA reports takes most information from dayfile.txt (based on rollover to rollover meteorological days), except average wind speed and dominant wind direction (both of these it calculates from values read from the standard log files) for period in question. Finally press ''Save'' button to store the new or amended report.
***In Cumulus MX, use the '''Reports''' tab, then choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''. A date selector allows you to choose the exact report you want, click "Load" button next to it. You can alternatively click another button to generate a missing report, or to regenerate an existing report after any corrections you have made to any standard log file relevant to that report. 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).
==Correcting any logged data problems==
As already mentioned, it is only MX where the 'Data Logs' screen will allow editing of values in any standard log file, but in both flavours you can use their viewer to look and see if you are happy with what has been recorded.
The MX editor is in the admin interface where it has no access to the actual log file which is stored wherever the MX engine runs. When you ask to load a selected month in that editor, what happens is that the MX engine does a quick read of the log file and puts its contents into the format used by dataTables software. That is what you see on the web page. Subsequently you can select a line there, click the '''Edit a line''' button, and the AltEditor software will raise a pop up showing all the fields in the line. This is where you make the edits. When you click the '''Save edit''' button, the line is sent back to the MX engine. On arrival of an updated line, the MX engine reads the log file again, into a standard array, replaces the array element corresponding to the received line, writes the array back into log file (replacing previous contents) and regenerates the dataTables format to send back to web page.
Some Weather stations may occasionally supply corrupted or rogue values to Cumulus:
*Cumulus 1 provides via '''Configuration''' menu [[Cumulus.ini#Section:_Offsets|''Calibration'']] screen the ability to screen out spikes (i.e. abnormal differences between two successive readings from weather station) in data picked up from some weather stations, it does not work for all types. See Cumulus help screen if you decide to use that to cope with future spikes.
*Cumulus MX provides the same functionality, for the same restricted set of station types in its admin interface.
If a weather station for some reason does not make a new reading available for a particular parameter, then both flavours of Cumulus reuse the same value as before for up to 6 times of reading the other parameters successfully. After that, Cumulus may stop any further processing. By default, Cumulus (of any flavour) will stop any further processing if certain outdoor sensors stop sending information:
*pressure
*wind speed
*temperature
*humidity
Cumulus records in the standard log file various parameters that cannot be obtained from every weather station. Both flavours store zero if no value can be obtained for that parameter.
Some rogue values may be obviously invalid (e.g. a zero pressure), others (e.g. wind shake on a tipping bucket rain gauge on a fine day) may be within the accepted all-time range, but you know the value is not right for that particular time. 
You may choose to just edit the rogue value into a reasonable value, or (if you are unable to decide on a better value) to delete that particular entire row in the standard log.
In Cumulus MX you can do both of these in the data logs screen, in Cumulus 1 you will need to use an external editor.


As explained above once any monthly log has been corrected, new highs and lows in other logs are easily rectified.
*The last of these is also in MX
***In Cumulus MX, use the '''Reports''' tab, then choosing ''NOAA Monthly Report'' or ''NOAA Annual Report''. A date selector allows you to choose the exact report you want, click "Load" button next to it. You can alternatively click another button to generate a missing report, or to regenerate an existing report after any corrections you have made to any standard log file relevant to that report.  


=== Spotting rogue values ===
=Rules to follow if editing a standard data log=


Frequently, the graphical views ('''Charts''', ''Graphs'' or  ''Trends'') are the best way to spot many rogue values and to help you guess by interpolation a more reasonable value.
==Important Rules for Cumulus 1==
 
Another possibility is to examine the relevant values in previous versions of the log files stored in the ''backup'' or ''backup/daily'' subdirectories of where your cumulus executable is stored.
 
 
===Manipulation outside Cumulus===
 
Any log files for ''previous'' months can be edited (outside Cumulus) with Cumulus running, and after editing them, you can do further fetch edits within Cumulus as described above. The standard log file for the current month can also be edited outside Cumulus, but as it is being updated frequently you must stop Cumulus first (that explains why there was no edit option within Cumulus 1!).
 
'''Tips''' -- take a copy of the original log file before you work on it outside Cumulus (perhaps give the ''not to be touched copy''  a filename of "<Month><Year>log.csv").
Edit the original file using an editor that treats all fields as text [use either any text editor, a Comma Separated Value editor, or a spreadsheet program that can be instructed ''not'' to recognise special field (like date and time) types].  [[File:Open office (editing cumulus log files).png | left]] If you wish to use "Calc" in 'Apache Open Office', "Libre Office", or similar, select the field separator you use (in this illustration comma is selected, but your file might use semi-colons between fields, don't select commas if your real numbers use comma between integer and decimal parts) and leave "Detect Special Numbers" unselected (as normal default for this software). Best not to use 'Microsoft Excel' as that normally has opposite default, and may change without any warning the format of all dates so Cumulus can no longer recognise the first two fields:
 
====Important Rules for Cumulus 1====


*Each line must contain the fields in correct sequence (since new versions/builds can add to number of fields, Cumulus will accept different months having various row lengths i.e. older ones without the more recent fields at the end).
*Each line must contain the fields in correct sequence (since new versions/builds can add to number of fields, Cumulus will accept different months having various row lengths i.e. older ones without the more recent fields at the end).
Line 193: Line 93:
* Note that some fields (e.g. those related to evaporation, UV, solar data) will only contain valid data if your station has the appropriate sensor(s) (without the sensor they contain the default value of zero), but if they apply make sure you note which are stored as integers.
* Note that some fields (e.g. those related to evaporation, UV, solar data) will only contain valid data if your station has the appropriate sensor(s) (without the sensor they contain the default value of zero), but if they apply make sure you note which are stored as integers.


====Equivalent rules for MX ====
==Equivalent rules for MX ==


*All fields in all lines must contain the same character for separating one field from next and it must be consistent with whatever locale you use when you run MX (it might be set using a parameter to the command running MX, it might be set in Mono, or in Windows control panel).
*All fields in all lines must contain the same character for separating one field from next and it must be consistent with whatever locale you use when you run MX (it might be set using a parameter to the command running MX, it might be set in Mono, or in Windows control panel).
Line 203: Line 103:
* For MX the rules for fields containing values are different to those for Cumulus 1, which makes it difficult to successfully edit any pre MX log files. For MX if a field can take a decimal place, it must contain a decimal figure, and it must use the correct decimal separator as defined in locale. If the field only takes integers (see [[#List_of_fields_in_the_file]]) then you cannot edit in any decimal places.
* For MX the rules for fields containing values are different to those for Cumulus 1, which makes it difficult to successfully edit any pre MX log files. For MX if a field can take a decimal place, it must contain a decimal figure, and it must use the correct decimal separator as defined in locale. If the field only takes integers (see [[#List_of_fields_in_the_file]]) then you cannot edit in any decimal places.


===Importing pre-Cumulus data into Cumulus 1===


This section was written for Cumulus 1. MX works differently, and all of its processing checks that the value it is processing is after the "start date", so it is not so easy to bring in earlier data. This is discussed further later within this section.
==Importing pre-Cumulus data==


See [[FAQ#I.E2.80.99ve_just_installed_Cumulus.2C_and_it_didn.E2.80.99t_download_all_the_old_data_from_my_weather_station|FAQ: I've just installed Cumulus and it didn't download all the old data from my weather station]]
If you were recording weather data manually, or with different weather station software, you might create files, using the standard data log files format, holding that pre-Cumulus data. Cumulus can treat these files just like any where it created the data log entries, and therefore you can apply any of the techniques explained in [[Calculate Missing Values]] and [[Correcting Extremes]].
 
 
The original Cumulus 1 software takes no notice of the <#recordsbegandate> see [[Webtags#Records]], so it is quite happy to process standard data logs with lines with earlier dates. The same applies to '''ExportMySQL.exe'''. However, by default, '''CumulusMX.exe''' will ignore any data log lines dated before the [[Cumulus.ini#Section:_Station|start date]] it recorded in the configuration file.
 
===Potential issues when trying to match formats===


Given that standard log files are used as input for '''updating the all-time, month-by-month alltime (from version 1.9.3), and this year record extremes''', for '''creating missing dayfile.txt entries''', and for '''creating NOAA style reports''', you may have some observations from your weather station recorded manually or electronically for a period before you first starting using Cumulus 1 and want to create new standard log files to feed into Cumulus 1.


'''Here are some issues to consider.''' There are some postings in the Support Forum about importing past data. Essentially match the fields listed in [[Standard_log_files#List_of_fields_in_the_file|List of fields in the file]] below with the fields you have available in your source.
'''Here are some issues to consider.''' There are some postings in the Support Forum about importing past data. Essentially match the fields listed in [[Standard_log_files#List_of_fields_in_the_file|List of fields in the file]] below with the fields you have available in your source.
Line 217: Line 120:
* Wind speed fields may not directly match to weather station outputs.  See [[#Cumulus_Wind_Speed_Terminology]]
* Wind speed fields may not directly match to weather station outputs.  See [[#Cumulus_Wind_Speed_Terminology]]
* Temperature fields may not directly match to weather station outputs. Copy across the fields you can and set the others to -999.99 so they are obvious. See the [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] described below for a way of getting Cumulus to generate (from your newly created monthly logs) apparent temperature, wind chill and heat index to replace any -999.99 figures.
* Temperature fields may not directly match to weather station outputs. Copy across the fields you can and set the others to -999.99 so they are obvious. See the [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] described below for a way of getting Cumulus to generate (from your newly created monthly logs) apparent temperature, wind chill and heat index to replace any -999.99 figures.
* Rainfall fields may not directly match to weather station outputs. [[FAQ#How_is_my_rain_rate_calculated.3F | Rain rate]] in field 8 may be generated from the [[Standard_log_files#Using_Standard_logs_to_deal_with_shorter_.28or_incomplete.29_dayfile.txt_records_for_particular_dates | workaround]] if unavailable from your station. The daily total in field 9 is since rollover time, and available weather station outputs may need some processing in your spreadsheet to derive this. Some stations output a count of total rainfall, others the total annual rainfall, either of these may be used for field 11.  Rainfall processing issues are frequently discussed in the Support Forum, so you may find the solution there or ask there for assistance.
* Rainfall fields may not directly match to weather station outputs. [[FAQ#How_is_my_rain_rate_calculated.3F | Rain rate]] in field 8 may be generated by following advice in [[Calculate Missing Values]].
 
'''The date that Cumulus first started tracking all-time records''' (<#recordsbegandate> see [[Webtags#Records]]), '''does ''not'' need to be updated for Cumulus 1''' to recognise earlier monthly log files in its ''data'' subfolder and to use any monthly logs found in the various '''View''' and '''Edit''' options available from the Cumulus main screen. 
 
'''Cumulus MX is different''', it only reads monthly log files from the existing ''records began date'', so that needs to be edited (''StartDate='' line in [[cumulus.ini]] with MX stopped, because it is not on any settings screen) to allow any earlier data to be read. You will also need to update all the other log files that record extremes manually using the editors provided in MX.
 
As  <#recordsbegandate> is on the default Cumulus 1 or MX ''recordsT.htm'' template with the label "Records began on", inserting pre-Cumulus data implies you might want to amend that label wording on that template to indicate it is the date that Cumulus 1 was first operational, rather than the date of the earliest tracked highs and lows.


If you prefer to edit the start date and keep the ''recordsT.htm'' template label "Records began on" unchanged on the default in Cumulus 1 or MX, the method is to stop Cumulus 1, and amend the ''StartDate='' line in [[cumulus.ini]] within the main Cumulus folder before re-starting Cumulus, but (in case you make a mistake) back up everything first!
==== Cumulus Wind Speed Terminology ====


=== Cumulus Wind Speed Terminology ===
'''This section was written for the original Cumulus software'''. There are some differences in how MX reads information from weather stations, particularly those by Davis, but that should not affect content below.


How wind speeds relate to various weather stations is explained in FAQ. Basically there are 3 values processed by Cumulus:
How wind speeds relate to various weather stations is explained in FAQ. Basically there are 3 values processed by Cumulus:
Line 243: Line 140:
[[Windrun]] is also calculated from average wind speed measurements, in this case every minute if Cumulus is running, or from the values that are logged (at station logging interval) as average wind speed when Cumulus is restarted and catches up from the station logger. Again, if Cumulus is not left running the calculated value will be skewed.
[[Windrun]] is also calculated from average wind speed measurements, in this case every minute if Cumulus is running, or from the values that are logged (at station logging interval) as average wind speed when Cumulus is restarted and catches up from the station logger. Again, if Cumulus is not left running the calculated value will be skewed.


==List of fields in the file==
=List of fields in the file=


The table is split by Cumulus version for all changes since version 1.8.5; it shows:
The table is split by Cumulus version for all changes since version 1.8.5; it shows:
#The field number
#The field number
#*When this list was first produced, Cumulus 1 was all that was available and the decision then was to start with date in field zero to be consistent with index used for arrays in programming languages like JavaScript.
#*When this list was first produced, only the original Cumulus software was available and the decision then was to start with date in field zero to be consistent with index used for arrays in programming languages like JavaScript.
#*Now that Cumulus MX is the main product, it uses field zero for the line number, and therefore date moves to field 1.
#*In the data log editing page of the MX admin interface, and internally in its code, MX uses field zero for the line number, and therefore the table below has been edited so that date moves to field 1.
#* For each field the equivalent letter that would be seen in a spreadsheet like Libre Office, Open Office, Excel etc is also shown in first column.
#* For each field the equivalent letter that would be seen in a spreadsheet like Libre Office, Open Office, Excel etc is also shown in first column.
#As a quick guide to which fields can take signs and which can not accept decimal places, the second column indicates formatting rules.
#As a quick guide to which fields can take signs and which can not accept decimal places, the second column indicates formatting rules.
Line 255: Line 152:
#*Any item labelled unsigned will not accept a minus sign. Those labelled signed don't need '''+''' for positive, but do need '''-''' for negative.
#*Any item labelled unsigned will not accept a minus sign. Those labelled signed don't need '''+''' for positive, but do need '''-''' for negative.
#The third column shows an example of a value accepted by Cumulus 1
#The third column shows an example of a value accepted by Cumulus 1
#*The file content rules for MX changed in release 3.7.0, and it has not been verified that all Cumulus 1 examples are still accepted
#* For Cumulus 1, where decimals are allowed, the stored value might be an integer as this depends on a number of factors, including your station type.  
#* For Cumulus 1, where decimals are allowed, the stored value might be an integer as this depends on a number of factors, including your station type.  
#*If you are editing the values manually, you should use integers for humidity, wind bearings, and the two solar radiation figures, and floating point for the others (add a ".0" if necessary because MX must see decimal places where these are allowed).
#*If you are editing the values manually, you should use integers for humidity, wind bearings, and the two solar radiation figures
#* Note that the figure in a field varies depending on the units you select, and your weather station may not have all the sensors needed.
#* In Cumulus 1 it is optional to use floating point for the others
#*In Cumulus 1 any fields defined in the version you are using for sensors you do not have will always contain zero. Also, for Cumulus 1 any fields that are not defined at the version when the line was created can:
#* In Cumulus MX add a ".0" if necessary because MX must see decimal places where these are allowed
#* Note that the figure in a field varies depending on the units you select, and your weather station may not have all the sensors needed
#*In Cumulus 1 any fields defined in the version you are using for sensors you do not have will always contain zero.  
#*Also, for Cumulus 1 any fields that are not defined at the version when the line was created can:
#**Either be missing (no fields seen after the last field at your version)
#**Either be missing (no fields seen after the last field at your version)
#**Or can be null (field separators only are seen after the last field at your version)
#**Or can be null (field separators only are seen after the last field at your version)
#* MX since version 3.7.0 is more fussy, but less consistent, certain fields contain a single space when not used, others contain zero, and others can be left empty
#The final column describes the observation often with a link to where there is more information.
#The final column describes the observation often with a link to where there is more information.


5,838

edits