5,838
edits
Setup: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)"
m (→Installation of Software: Minor clarification) |
m (Text replacement - "Cumulus.ini" to "Cumulus.ini_(Cumulus_1)") |
||
| (14 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
[ | {{Version badge 1}} | ||
'''IMPORTANT: Cumulus 1 is no longer supported, its source code is not available, and its development environment is obsolete. Consequently, the installation package is hidden away on an obsolete page in this Wiki ([https://cumuluswiki.org/Downloads/CumulusSetup.exe Downloads/CumulusSetup.exe]). After installing that version you need to apply a patch available on [[Software#Cumulus_1|Software page]]. It is not very user friendly now! These instructions remain to simply have a record of how it used to work.''' | |||
The Setup process for Cumulus is briefly mentioned in the 'readme.txt', and of course '''you''' did read that when it was displayed as shown here during the ''Cumulus installation process''. For those who did not read that, this article briefly covers installation and some key setting-up issues. | |||
[[File:Install_read.me_screen.JPG]] | |||
== Installation of Software == | == Installation of Software == | ||
As the picture shows, in ReadMe.txt it is suggested that Cumulus is installed directly below the root on your C drive, but if you have more than one drive available, installing it below the root of a drive other than that containing the operating system allows you to either upgrade the operating system or do system restores without affecting Cumulus. | As the picture shows, in ReadMe.txt it is suggested that Cumulus is installed directly below the root on your C drive, but if you have more than one drive available, installing it below the root of a drive other than that containing the operating system allows you to either upgrade the operating system or do system restores without affecting Cumulus. | ||
There is a handy installation guide [ | The Microsoft Windows Installation set up file creates a folder structure as shown here. [[File:Cumulus folder structure.PNG|right|500px]] | ||
There is a handy installation guide [https://cumuluswiki.org/Downloads/Cumulus%20basic%20installation%20guide.pdf here] that describes how the requirements vary for each make of weather station. | |||
=== Upgrading to a new release === | |||
The executable file in the release is the windows installer for the new version.''' Your data and settings are not affected, but it is still best if you back up your data (sub-folder 'data') and any settings files (e.g. cumulus.ini and strings.ini) before you run the installer. | |||
You can install the new version where you like, but the Cumulus 1 installer will offer the same place as the previous version as the default. | |||
''Occasionally, there may be actions you need to perform before or after the upgrade.'' Required actions usually appear in the announcement of the build you are installing, and for Cumulus 1 may be documented in the readme.txt file that will appear as you run the installer. Read such announcements for every release since your existing build in case any of the in-between changes affect you. | |||
The Cumulus 1 installer will always upgrade the following files (replacing them, ignoring whether same or different to existing versions): | |||
# "cumulus.exe"; - the latest build executable (do not confuse with the installer, CumulusSetup.exe) | |||
# "unins000.exe"; | |||
# "libeay32.dll"; | |||
# "ssleay32.dll"; | |||
# "readme.txt"; - advice for you to follow at installation time | |||
# "licence.txt"; - reminder about restrictions on use | |||
# "alert.wav"; - default alarm sound | |||
# "web\originals\*.*"; - Cumulus will always install the HTML template files here | |||
# "webfiles\*.*"; e.g. weatherstyle.css, wz_jsgraphics.js | |||
# "webfiles\images\picture.jpg"; | |||
# "Help\Cumulus.chm"; - the latest help including lists of log files and web tags | |||
There may be extra files automatically upgraded by particular builds - see announcement for whichever builds are between your current one and the one you are trying to install. | |||
During the install, you will see a '''Select Components''' screen , if you tick the ''HTML templates'' (the default) it will also upgrade the HTML template files in the web folder. | |||
*So tick this option, if you have a standard Cumulus implementation and then you can be sure to upgrade the standard templates. | |||
*Untick this option if you have [[Customised_templates#Creating_Your_Own_Templates|customised the existing pages]], so that if your customised versions are in "web\*.*" they don't get overwritten. It is recommended that you store any customised pages in a directory outside the Cumulus folder, as you can specify up to 10 such files on the local side of the files tab in the Configuration menu Internet settings screen and (if you are not using standard files) untick ''Include Standard Files'' on the same screen. (100 such files can be specified in [[Cumulus.ini_(Cumulus_1)]]). | |||
=== Dates (and separator requirements) === | === Dates (and separator requirements) === | ||
Cumulus does require your '''computer System Short Date''' to use a format with a separator between day, month (in digits) and year. This separator will be used in the [[:Category:Log_Files|log files]]. | Cumulus does require your '''computer System Short Date''' to use a format with a separator between day, month (in digits) and year. This separator will be used in the [[:Category:Log_Files|log files]]. | ||
| Line 12: | Line 50: | ||
Some characters (like space or comma) will cause problems, and not just in Cumulus. Slashes, full stops, and dashes are the ones usually used. e.g. 'dd/MM/yy', 'dd-MM-yy', 'MM/dd/yy' and 'dd.MM.yy' are acceptable, but 'ddMMyy' or 'dd MM yy' are not suitable as a short date format with Cumulus. Any change to your short date format later (e.g. by [[Moving_cumulus]] to a different machine) is likely to give problems. | Some characters (like space or comma) will cause problems, and not just in Cumulus. Slashes, full stops, and dashes are the ones usually used. e.g. 'dd/MM/yy', 'dd-MM-yy', 'MM/dd/yy' and 'dd.MM.yy' are acceptable, but 'ddMMyy' or 'dd MM yy' are not suitable as a short date format with Cumulus. Any change to your short date format later (e.g. by [[Moving_cumulus]] to a different machine) is likely to give problems. | ||
'''Note for USA:''' | '''Note for USA:''' | ||
Cumulus uses the Windows date formats in most places where it displays a date. This means that it can handle 'MM/dd/yy' as system short date. However (as at version 1.9.3), in the [[:Category:Log_Files|log files]] the date always appears with day before month, and consequently any screen showing timestamps taken from those log files will show dates in that format. Also on the main screen where the month appears in full, it is always between day of month and 4-digit year. On your web pages, the date format in all timestamps can be configured to your preference using 'format=mm/dd' [note: dates are in 'recent', 'month', 'year' and 'monthly' timestamp webtags, but not included for 'today' and 'yesterday' observation timestamps (as these only contain time use '<#today format=mm/dd/yyyy>', '<#metdate format=mm/dd/yyyy>' '<#yesterday format=mm/dd/yyyy>', '<#metdateyesterday format=mm/dd/yyyy>' where the '/yyyy' is optional in all cases)]. | |||
== Configuration: Settings == | == Configuration: Settings == | ||
| Line 34: | Line 74: | ||
#Finally apply rounding. | #Finally apply rounding. | ||
So devising suitable conversion tactics and applying to all old observations could require hours of work. See discussions in support forum e.g. [ | So devising suitable conversion tactics and applying to all old observations could require hours of work. See discussions in support forum e.g. [https://cumulus.hosiene.co.uk/viewtopic.php?f=13&t=10216&start=0 this Fine Offset rainfall thread], [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=10327&sid=653dc1eceb1c5a0591512b84578680bd this Vantage Vue wind speed thread] or search (specify ''station make'' or ''units you wish to change'') forum. | ||
'''If you do need to change a unit''', here is a suggested approach: | '''If you do need to change a unit''', here is a suggested approach: | ||
#Changing just after a new month has started simplifies the process | #Changing just after a new month has started simplifies the process | ||
#Exit Cumulus | #Exit Cumulus | ||
#Amend the appropriate parameter line in [[Cumulus. | #Amend the appropriate parameter line in [[Cumulus.ini_(Cumulus_1)#Section:_Station]] to a value representing the new units. | ||
#Apply conversion tactics (see above) to figures that need to be in the new units in [[yesterday.ini]], [[today.ini]], [[month.ini]], [[year.ini]], [[monthlyalltime.ini]] and [[alltime.ini]]. | #Apply conversion tactics (see above) to figures that need to be in the new units in [[yesterday.ini]], [[today.ini]], [[month.ini]], [[year.ini]], [[monthlyalltime.ini]] and [[alltime.ini]]. | ||
#Apply conversion tactics to figures in the (preferably) just started [[ | #Apply conversion tactics to figures in the (preferably) just started [[Standard_log_files|current Standard log]]. | ||
#Restart Cumulus | #Restart Cumulus | ||
#This procedure has ensured that all lows and highs can continue to be tracked by Cumulus, while preserving history of past extremes without being affected by change of units (e.g. a new observation of 31 kph is not higher than a past observation of 30 mph). | #This procedure has ensured that all lows and highs can continue to be tracked by Cumulus, while preserving history of past extremes without being affected by change of units (e.g. a new observation of 31 kph is not higher than a past observation of 30 mph). | ||
| Line 50: | Line 90: | ||
You may find the [[Cumulus_Screenshots]] help you to find what can be edited where, although note the screens may relate to a different software version/build to that you are using. Most of the settings are fully explained in the help for each screen in the various different menu. Not all settings can be set using screens in '''Configuration''' menu, you may need to use a screen in the '''Edit''', or '''View''', menu or to directly edit the appropriate [[:Category:Cumulus Files|configuration file]]. | You may find the [[Cumulus_Screenshots]] help you to find what can be edited where, although note the screens may relate to a different software version/build to that you are using. Most of the settings are fully explained in the help for each screen in the various different menu. Not all settings can be set using screens in '''Configuration''' menu, you may need to use a screen in the '''Edit''', or '''View''', menu or to directly edit the appropriate [[:Category:Cumulus Files|configuration file]]. | ||
The information in [[cumulus.ini]] describes the configuration settings for the latest live Cumulus release, whether set via screens or directly by editing that file. If there are extra settings for a beta build, these will be covered in the build announcement, but once established should appear in [[Cumulus.ini_(Beta)]]. | The information in [[cumulus.ini]] describes the configuration settings for the latest live Cumulus release, whether set via screens or directly by editing that file. If there are extra settings for a beta build, these will be covered in the build announcement, but once established should appear in [[Cumulus.ini_(Cumulus_1)_(Beta)]]. | ||
#Some settings affect how information is read from your weather station; in general changing these may cause a discontinuity in your observations, as the changes only affect subsequent readings, and have no retrospective consequence. The exception is a change to units of measurement as this directly affects updating extremes see instructions above. | #Some settings affect how information is read from your weather station; in general changing these may cause a discontinuity in your observations, as the changes only affect subsequent readings, and have no retrospective consequence. The exception is a change to units of measurement as this directly affects updating extremes see instructions above. | ||
