Cumulus.ini: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search

Cumulus.ini (view source)

Revision as of 05:09, 14 June 2021

559 bytes added ,  14 June 2021
m
NOAA
m (edit message at top)
m (NOAA)
|-
|EnableAccessibility=0
| * (Either) Program Settings &raararr; (First tick box)
* (Or) Station Settings → (First tick box)
|Enable accessibility features
==NOAA Settings==
 
* File Section is [NOAA]
===Create NOAA files after daily rollover===
 
{| class="wikitable" border="1"
|-
!style="width:30px" | Parameter Line Entry
!style="width:100px" | Introduced
!style="width:100px" | MX Section
!style="width:60px" | Label on Settings page
!style="width:20px" | Default
!style="width:300px" | Description
|-
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| AutoSaveAutoCopy=10
| Release 3.12.0
| Create NOAA files after daily rollover
| NOAA Reports Settings → FTP Options
|0
| Auto Copy NOAA report files
| *0= do not use Reports functionality
| Simple tick or not
*1= do use Reports functionality
* Tick (value shown as 1 in Cumulus.ini) if your report is to be copied to copy directory during the [[MX_Basic_info#MX_End_of_Day_Process|End of Day process]]
* Don't tick (value shown as 0 in Cumulus.ini) for no copy action
|-
| UseDotDecimalAutoFTP=0
| First with Cumulus 2
|
| NOAA Reports Settings → FTP Options
| Auto FTP NOAA report files
| 0 (disable)
| Simple tick or not
| (Introduced 3.9.5 - b3100) Formatting real numbers for when NOAA report parsed by a script
* Tick (value shown as 1 in Cumulus.ini) to enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
* 0= NOAA reports use the integer/decimal separator specified by locale
* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process
* 1= NOAA reports used decimal point even if locale says use decimal comma
|}
 
===Site Details===
 
{| class="wikitable" border="1"
|-
| AutoSave=1
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings → Create NOAA files after daily rollover
!style="width:20px" | Default
|0
!style="width:300px" | Description
| Simple tick or not
|-
* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality
|style="background:lightgray;"|[NOAA]
* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| City=
|Name=Personal Weather Station
| First with Cumulus 2
|Site Name
| NOAA Reports Settings → Site Details
|(empty)
| City
|What you would like to see in report title for your station name
| (empty)
| Enter here your hamlet, village, town, or city, name
|-
| CoolingThreshold=22
|City=
| First with Cumulus 2
|City
| NOAA Reports Settings → Thresholds
|(empty)
| Cooling threshold
|Enter here your hamlet, village, town, or city, name
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
| [[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. An international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
|-
| CopyDirectory=
|State=
| Release 3.12.0
|State
| NOAA Reports Settings &rarr; Report Format Options
|(empty)
| Copy Directory
|Enter here your local authority area or region (state in USA)
| (empty)
|}
| The folder on the web server you host to which reports are to be copied
 
===Output Files===
 
{| class="wikitable" border="1"
|-
| FTPDirectory=
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings &rarr; FTP Options
!style="width:20px" | Default
| FTP directory
!style="width:300px" | Description
| (empty)
|-
| Where you want MX to use as destination folder on your FTP server
|style="background:lightgray;"|[NOAA]
*Leave blank and MX will use wherever has been specified in main internet settings (this fits how the default web site is designed to work)
|
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (if you use any files from default web site, then you will need to amend the JavaScript file:
|
<code>let rptPath = ''; // Your path should have a trailing "/", eg. 'Reports/'</code> by putting your folder name in, an example is given for the case when “/Reports” is a sub folder off the main upload destination, note how you don’t include a leading slash, but you must add a trailing one.
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| HeatingThreshold=15.5
|MonthFileFormat='NOAAMO'MMyy'.txt'
| First with Cumulus 2
|Monthly filename format
| NOAA Reports Settings &rarr; Thresholds
|'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt')
| Heating threshold
|Here you specify the filename template for MX to use when reading, or writing, monthly reports
| 65<sup>o</sup> F or 18.3<sup>o</sup>C
 
|[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. An international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
|-
| MaxTempComp1=22
|YearFileFormat='NOAAYR'yyyy'.txt’
| First with Cumulus 2
|Yearly filename format
| NOAA Reports Settings &rarr; Thresholds
|'NOAAYR'yyyy'.txt'
| Max temp comparison 1
|Here you specify the filename template for MX to use when reading, or writing, yearly reports
| (empty)
 
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension.
|}
 
 
===Report Format Options===
 
{| class="wikitable" border="1"
|-
| MaxTempComp2=0
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings &rarr; Thresholds
!style="width:20px" | Default
| Max temp comparison 2
!style="width:300px" | Description
| (empty)
|-
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| MinTempComp1=15.5
|12hourformat=0
| First with Cumulus 2
|Time format
| NOAA Reports Settings &rarr; Thresholds
|0 (24 hour)
| Min temp comparison 1
| How times are output on reports
| (empty)
* 24 Hour
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold in Celsius. Express in Fahrenheit if that is your chosen unit
* 12 Hour
|-
| MinTempComp2=0
|NOAUseUTF8=1
| First with Cumulus 2
|Use UTF-8 encoding
| NOAA Reports Settings &rarr; Thresholds
|Please see [[Reports_folder#Encoding]]
| Min temp comparison 2
*Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol
| (empty)
*If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently
| The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius). Express in Fahrenheit if that is your chosen unit
|-
| MonthFileFormat='NOAAMO'MMyy'.txt'
|UseDotDecimal=0
| First with Cumulus 2
|Use a 'dot' decimal point
| NOAA Reports Settings &rarr; Output Files
|0 (locale)
| Monthly filename format
| Should dot or comma decimal be used?
| 'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt')
*0= as defined in your locale
| Here you specify the filename template for MX to use when reading, or writing, monthly reports
*1= dot decimal place, regardless of what in locale
(The reason for this is that some people instead of looking at reports, have a script that parses the report and outputs in a different way)
|}
 
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension. e.g. "NOAAMO"MMMyyyy".txt" would also be valid.
 
===FTP Options===
 
{| class="wikitable" border="1"
|-
| Name=Personal Weather Station
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings &rarr; Site Details
!style="width:20px" | Default
| Site Name
!style="width:300px" | Description
| (empty)
|-
| What you would like to see in report title for your station name
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| NOAUseUTF8=1
|AutoFTP=0
| First with Cumulus 2
|Auto FTP NOAA report files
| NOAA Reports Settings &rarr; Report Format Options
|0 (disable)
| Use UTF-8 encoding
|Assuming you have selected (in earlier sub-section) that MX is to create reports
| Please see [[Reports_folder#Encoding]]
*0= Disable any further action with filename
* Tick (value shown as 1 in Cumulus.ini) for default, modern files use UTF-8 encoding, this can display an extended range of characters, including the <sup>o</sup> degree symbol
*1= Enable the file transfer process you have defined for MX, to upload the file for you (at first update time after rollover has completed)
* If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the <sup>o</sup> degree symbol is coded differently
|-
| RainComp1=0.5
|FTPDirectory=
| First with Cumulus 2
|FTP directory
| NOAA Reports Settings &rarr; Thresholds
|(empty)
| Rain comparison 1
|Where you want MX to use as destination folder on your FTP server
| (empty)
*Leave blank and MX will use wherever has been specified in main internet settings (this fits how the default web site is designed to work)
| The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold
* Specify a folder relative to FTP root, and MX will upload reports to that folder instead (if you use any files from default web site, then you will need to amend the JavaScript file:
<code>let rptPath = ''; // Your path should have a trailing "/", eg. 'Reports/'</code> by putting your folder name in, an example is given for the case when “/Reports” is a sub folder off the main upload destination, note how you don’t include a leading slash, but you must add a trailing one.
|}
 
===Thresholds===
 
‘’Please note any temperatures you specify in these settings must use the same units as you have asked MX to report temperature in. Equally any rainfall amounts you specify here must use the same units as you have asked MX to report rainfall in.’’
 
{| class="wikitable" border="1"
|-
| RainComp2=
!style="width:30px" | Parameter Line Entry
| First with Cumulus 2
!style="width:60px" | Label on Settings page
| NOAA Reports Settings &rarr; Thresholds
!style="width:20px" | Default
| Rain comparison 2
!style="width:300px" | Description
| (empty)
|-
| The report will count the number of days when the daily rainfall exceeds this threshold.
|style="background:lightgray;"|[NOAA]
|
|
|style="background:lightgray;"|Section name - the following parameters appear in NOAA section
|-
| RainComp3=
|HeatingThreshold=15.5
| First with Cumulus 2
|Heating threshold
| NOAA Reports Settings &rarr; Thresholds
|65<sup>o</sup> F or 18.3<sup>o</sup>C
| Rain comparison 3
|[[Heat/cold_degree_days_and_Chill_hours#Heat_Degree_Days| Heating Degree Days]] are a measure of the need for heating, based on time below, and temperature difference below, a threshold temperature. The international standard says 15.5 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| (empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
| State=
|CoolingThreshold=22
| First with Cumulus 2
|Cooling threshold
| NOAA Reports Settings &rarr; Site Details
|65<sup>o</sup> F or 18.3<sup>o</sup>C
| State
|[[Heat/cold_degree_days_and_Chill_hours#Cold_Degree_Days|Cold Degree Days]] are a measure of the need to cool the air to make it more comfortable, based on time above, and temperature difference above, a threshold temperature. The international standard says 22 <sup>o</sup>Celsius is a suitable threshold to ensure comfort. For historical consistency, the default used by MX is based on the threshold used when Steve Loft first implemented this in [[Reports_folder#A_brief_history_of_these_reports|Cumulus 2 (enhancement request 44)]], and that was done to match some early look up tables.
| (empty)
| Enter here your local authority area or region (state in USA)
|-
| UseDotDecimal=0
|MaxTempComp1=22
| Release 3.9.5 - b3100
|Max temp comparison 1
| NOAA Reports Settings &rarr; Report Format Options
|(empty)
| Use a 'dot' decimal point
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the cooling degree day threshold
| 0 (disable)
| Formatting real numbers for when NOAA report parsed by a script
 
Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want NOAA reports to use decimal point even if locale says use decimal comma
* Don't tick (value shown as 0 in Cumulus.ini) if NOAA reports use the integer/decimal separator specified by locale
|-
| UseMinMaxAvg=0
|MaxTempComp2=0
| Release 3.12.0
|Max temp comparison 2
| NOAA Reports Settings &rarr; Report Format Options
|(empty)
| Use WHO average or Intregated average
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius)
| 0 (integrated average)
| Simple tick or not
* Tick (value shown as 1 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use WHO approach: (min + max)/2
* Don't tick (value shown as 0 in Cumulus.ini) if you want temperature averages quoted in NOAA reports to use integrated calculation: Sum of all temperature measurements divided by count of measurements
|-
| YearFileFormat='NOAAYR'yyyy'.txt’
|MinTempComp1=15.5
| First with Cumulus 2
|Min temp comparison 1
| NOAA Reports Settings &rarr; Output Files
|(empty)
| Yearly filename format
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the first comparison has been set to agree with the heating degree day threshold
| 'NOAAYR'yyyy'.txt'
| Here you specify the filename template for MX to use when reading, or writing, yearly reports
 
There is a prefix text in quotes,then comes a way to specify months (see [[Reports_folder#NOAA_style_Report_Naming]]), and finally comes the mandatory text extension.
|-
|12hourformat=0
|MinTempComp2=0
| ???
|Min temp comparison 2
|Time format
|(empty)
|0 (24 hour)
|The report will count the number of days when this threshold is exceeded. In the parameter I have quoted, the second comparison has been set to agree with feezing point (I’m using Celsius)
| How times are output on reports
|-
* 24 Hour (value shown as 0 in Cumulus.ini)
|RainComp1=0.5
* 12 Hour (value shown as 1 in Cumulus.ini)
|Rain comparison 1
|(empty)
| The report will count the number of days when the daily rainfall exceeds this threshold. In the parameter I have quoted, the first comparison has been set to the same as I have set else where as my significant rain threshold
|-
|RainComp2=
|Rain comparison 2
|(empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|-
|RainComp3=
|Rain comparison 3
|(empty)
| The report will count the number of days when the daily rainfall exceeds this threshold.
|}
 
 
 
===Normal Mean Temperatures===
 
* File Section is [NOAA]
*The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’
*There is one box labelled for each month on the settings screens
* There is one box labelled for each month on the settings screens
*All the defaults are (blank)
* All the defaults are (blank)
*What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements
* What you enter is the mean temperature, long-term averages (say over 10 or 30 years if available) say is expected that month, often taken from local climate statistics, or your own past measurements
 
===Normal Precipitation===
 
* File Section is [NOAA]
Rainfall equivalents of mean temperature described above
 
 
==Program Start-up Options==
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/9215"

Navigation menu