Cumulus.ini: Difference between revisions

| * (Either) Program Settings → (First tick box)

* File Section is [NOAA]

| AutoCopy=0

| NOAA Reports Settings → FTP Options

| Auto Copy NOAA report files

| Simple tick or not

* 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]]

| AutoFTP=0

| First with Cumulus 2

| Simple tick or not

* 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)

* Don't tick (value shown as 0 in Cumulus.ini) to disable any file transfer process

| AutoSave=1

| First with Cumulus 2

| NOAA Reports Settings → Create NOAA files after daily rollover

|0

| Simple tick or not

* Tick (value shown as 1 in Cumulus.ini) if you want MX to use the (optional) Reports functionality

* Don't tick (value shown as 0 in Cumulus.ini) if MX Reports functionality not required

| City=

| First with Cumulus 2

| NOAA Reports Settings → Site Details

| (empty)

| Enter here your hamlet, village, town, or city, name

| CoolingThreshold=22

| First with Cumulus 2

| NOAA Reports Settings → Thresholds

| [[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 ^oCelsius 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=

| Release 3.12.0

| NOAA Reports Settings → Report Format Options

| (empty)

| The folder on the web server you host to which reports are to be copied

| FTPDirectory=

| First with Cumulus 2

| NOAA Reports Settings → FTP Options

| FTP directory

| (empty)

| Where you want MX to use as destination folder on your FTP server

* 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.

| HeatingThreshold=15.5

| First with Cumulus 2

| NOAA Reports Settings &rarr; Thresholds

| 65^o F or 18.3^oC

|[[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 ^oCelsius 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.

| MaxTempComp1=22

| Max temp comparison 1

| (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

| MaxTempComp2=0

| First with Cumulus 2

| NOAA Reports Settings &rarr; Thresholds

| Max temp comparison 2

| (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

| MinTempComp1=15.5

| First with Cumulus 2

| (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 heating degree day  threshold in Celsius. Express in Fahrenheit if that is your chosen unit

| MinTempComp2=0

| NOAA Reports Settings &rarr; Thresholds

| Min temp comparison 2

| (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

| MonthFileFormat='NOAAMO'MMyy'.txt'

| First with Cumulus 2

| NOAA Reports Settings &rarr; Output Files

| 'NOAAMO'MMyy'.txt' (note quotes round 'NOAAMO' and round '.txt')

| Here you specify the filename template for MX to use when reading, or writing, monthly 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.  e.g. "NOAAMO"MMMyyyy".txt" would also be valid.

| Name=Personal Weather Station

| First with Cumulus 2

| NOAA Reports Settings &rarr; Site Details

| Site Name

| (empty)

| What you would like to see in report title for your station name

| NOAUseUTF8=1

| NOAA Reports Settings &rarr; Report Format Options

| Use UTF-8 encoding

| Please see [[Reports_folder#Encoding]]

* 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 ^o degree symbol

* If unticked (0 appears in file), then iso-8859-1 encoding is used, this has a more restricted range of characters, and the ^o degree symbol is coded differently

| RainComp1=0.5

| First with Cumulus 2

| NOAA Reports Settings &rarr; Thresholds

| 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=

| First with Cumulus 2

| NOAA Reports Settings &rarr; Thresholds

| Rain comparison 2

| (empty)

| The report will count the number of days when the daily rainfall exceeds this threshold.

| RainComp3=

| First with Cumulus 2

| Rain comparison 3  

| (empty)

| The report will count the number of days when the daily rainfall exceeds this threshold.

| State=

| First with Cumulus 2

| NOAA Reports Settings &rarr; Site Details

| State

| (empty)

| Enter here your local authority area or region (state in USA)

| UseDotDecimal=0

| Release 3.9.5 - b3100

| 0 (disable)

| Formatting real numbers for when NOAA report parsed by a script

 

* 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

| Release 3.12.0

| 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’

| First with Cumulus 2

| '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

| ???

|Time format

|0 (24 hour)  

| How times are output on reports

* 24 Hour (value shown as 0 in Cumulus.ini)

* 12 Hour (value shown as 1 in Cumulus.ini)

* The parameters run from ‘’’NOAATempNormJan=’’’ to ‘’’NOAATempNormDec=’’

* There is one box labelled for each month on the settings screens

* 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