1,122
edits
Software: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
→Latest build distribution download
| (19 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX. | [[Category:Cumulus MX]] This Wiki page has been created for those who use Cumulus MX. It lists all standard utilities as well as MX itself. | ||
= What is Cumulus MX? = | = What is Cumulus MX? = | ||
: a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X. | : a cross platform version of Cumulus software that runs on Microsoft Windows, all varieties of UNIX and Linux (including the Raspberry Pi Operating System), and Mac OS X. | ||
| Line 29: | Line 27: | ||
If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance. | If you cannot answer your questions from information in this Wiki (and MX changes so quickly any information here can be very out of date), then use the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] and the developer or Cumulus community will offer assistance. | ||
== Current Release == | |||
There are inter-dependencies between different files in the MX release distribution: | There are ''inter-dependencies between different files'' in the MX release distribution: | ||
* ''Therefore you must always install into your MX folders, every file included in the download zip''. | * ''Therefore you must always install into your MX folders, every file included in the download zip''. | ||
* If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder | * If you customise any file that is in the distribution, either give the new file a new name (perhaps add a prefix of "_" in front of files you edit) or place your tailored version in a different folder | ||
** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in | ** Either approach will ensure your tailored files are not overwritten by files from the download, and let you compare your tailored file with the new file in any future download to see if you need to tweak your tailored file | ||
* | * When upgrading, it is strongly recommended that you install all files in the download for a new release of MX directly over your existing installation. | ||
** You can take a back-up of any existing installation before you copy in any new files, that will provide you with the ability to regress to the earlier release, if the new release does cause you an issue | |||
** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files | ** You may end up with some files no longer needed by the new release, left over from older release, but this is better than risking missing some vital files | ||
** You need a good understanding of the use of each file, before considering deleting any file that you think might be obsolete, because not all files that Cumulus uses are contained within the release zip, some are created as it runs. | |||
===Latest build distribution download=== | ===Latest build distribution download=== | ||
~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/ | ~ Download [https://github.com/cumulusmx/CumulusMX/releases/download/b3215/CumulusMXDist3215.zip Cumulus MX v3.22.4 build 3215, 20-November-2022] | ||
===Latest MX Source Code=== | ===Latest MX Source Code=== | ||
| Line 70: | Line 52: | ||
===Raspberry Pi Image=== | ===Raspberry Pi Image=== | ||
~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3. | ~ Download [//{{SERVERNAME}}/Downloads/rpi-CumulusMX-lite-3.22.0.zip Raspberry Pi Image for Cumulus MX 3.22.0] | ||
As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux. | As at April 2022, the image includes Raspberry Pi. O. S. 11 "Bullseye" version of Linux. | ||
| Line 85: | Line 67: | ||
: Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono). | : Please note, this image may not always contain latest MX release, but once you have installed a release of MX on your Raspberry Pi, [[Updating MX to new version|upgrading]] is done using main software download link, as none of the other components in the image need to be upgraded (unless the release announcement states that the new release needs a specific version of Mono). | ||
==Upgrading== | |||
: There is an [[Updating_MX_to_new_version#Installer_Option|installer utility]] available to help with upgrading. | |||
We strongly advise [[Updating_MX_to_new_version#Introduction_to_upgrading_MX|upgrading]] to the latest release: | |||
* The main developer can most easily offer support if you are using the most familiar recently released build. | |||
* You may wish to wait a few days after a new release comes out, just in case a new release has some bugs | |||
** MX is extremely complex, the developers work on MX edits in their spare time, have settings that suit them, and do not have the full set of sensors that MX can support, so pre-release testing is never perfect | |||
* By switching to latest release, you gain any extra functionality it may offer (although it may not be useful to you), but more importantly you gain fixes of bugs your existing release may have | |||
*Important, please read all of the release notes (in the [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 appropriate forum announcement] threads) for the builds since the version you are upgrading from, especially noting when there are references to necessary once-off actions. | |||
*If you have never upgraded before, or you are currently running a fairly old release of MX, you are advised to read the [[Updating MX to new version]] page in this Wiki, | |||
** you may be recommended to upgrade in stages, as certain releases do essential one off actions that are missed if you skip that release; e.g. rewriting [[Cumulus.ini]] or changes to columns in database tables | |||
** overwriting an existing installation will add any new files, but it won't remove obsolete files, and sometimes [[MX_Basic_info#Library_software|replacement files]] have different names to their predecessors so don't overwrite the old files | |||
*If you are upgrading from a previous version of the legacy Cumulus 1, then you might want to read [[Migrating from Cumulus 1 to MX]] page; and if you need more justification read [[Compare_C1_and_MX|Compare legacy Cumulus and MX]] page | |||
** However, it is likely that information on those pages was written for earlier MX releases, and might be out of date, so like many other people you might want to ask in the [https://cumulus.hosiene.co.uk/viewforum.php?f=40 correct MX support forum] to see if others have more up-to-date advice. | |||
Note by Steve Loft: you may find that anti-virus software flag a new release of Cumulus as a ‘threat’, for a few days or weeks after a new version has been released, even though it does not actually contain a virus of any kind. This is due to a system they call ‘reputation’ where they automatically block any versions of software that have recently been released. You may want to consider complaining to the provider of your anti-virus software about this ridiculous system, or better still, use some better anti-virus software. | |||
==Older releases== | ==Older releases== | ||
| Line 98: | Line 99: | ||
==By Mark Crossley== | ==By Mark Crossley== | ||
The | The utilities listed here are only for use with MX, they may be included in the [[#Latest build distribution download|MX release zip]], but links to latest releases without the ''*.dll'' files ("software libraries") needed to run the respective utility, are provided below. | ||
The "software libraries" are provided in the MX release zip that is stated alongside download link. The different utilities vary with regard to which software libraries they require, and those with technical understanding can check the code sources. | |||
If you are using | If you are using an earlier MX release than that stated beside a utility download below, upgrade MX to bring in the new "*.dll" files needed, because the utility will not work with the versions of "software libraries" included with earlier MX releases. | ||
= | If you are using a later MX release than that stated, check [https://cumulus.hosiene.co.uk/viewtopic.php?t=17887 the MX release announcements] for all releases since that stated below to see if the "software libraries" have been upgraded, if they have then the respective utility because it has been compiled with older versions of the respective .dll files will probably not work. (Sometimes the names of new .dll files are different to the names of the old .dll files, so an upgrade of MX done by copying files over an existing installation will leave the old files there, in that case the utility might still work by picking up old names). | ||
=== Create Missing === | === Create Missing === | ||
~ The CreateMissing.exe ''v1. | ~ The CreateMissing.exe ''v1.3.0'' download dated 18 August 2022 (works with MX release of 3.20.0 onwards) [https://github.com/cumulusmx/CreateMissing/releases/download/v1.3.0/CreateMissing-v1.3.0.zip is here]. | ||
Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe". | Check compatibility with the MX release you have running as per notes above. (Although earlier releases of "Create Missing" exist on "github.com/cumulusmx/CreateMissing/releases", their software bugs imply they should not be used). Install into same directory as "CumulusMX.exe". | ||
| Line 119: | Line 116: | ||
# It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file. | # It will create a new [[dayfile.txt|daily summary (dayfile.txt)]]. If you already have a "dayfile.txt", that is renamed, the new file should include individual fields, and lines, missing from your old file. | ||
# It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files. | # It will read, and where appropriate update, your [[Standard log files|month by month (MMMyylog.txt)]] files. | ||
#* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add | #* The utility reads the [[Calculate_Missing_Values#Source_value|source values]] in as input values. This utility has the ability to calculate many of the [[Calculate_Missing_Values#Derived_value|derived fields]], so will add any missing derived values to your month by month files as it proceeds. | ||
#* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]). | #* Therefore the utility should be used to add the [[Standard_log_files#Number_of_fields_per_line_varies_by_release|extra fields]] for those months where the input file was produced by Cumulus 1 or an earlier release of MX (which might have populated fewer fields or used a [[Feels_Like#How_to_express_Feels_Like_for_highest_temperatures|different calculation]]). | ||
| Line 128: | Line 125: | ||
* Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight. | * Check in the support forum for information about status of bugs in this utility, at time of last updating this paragraph there was an outstanding issue concerning storing the line in dayfile.txt for the first of some months if your rollover time is not midnight. | ||
* For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page. | * For full information about solving problems with your '''dayfile.txt''' file read the [[Amending dayfile|amending daily summary file]] page. | ||
=== Create Records === | |||
This utility is not yet available. | |||
A utility to create, or recreate, missing [[Correcting_Extremes|extreme records]] from Cumulus MX by parsing your [[dayfile.txt|daily summary (dayfile.txt)]]. | |||
=== Export ''To'' MySQL === | === Export ''To'' MySQL === | ||
~ The ExportToMySQL.exe ''v1. | ~ The ExportToMySQL.exe ''v1.6.1'' download dated 02 September 2022 (works with release of MX 3.21.0) [https://github.com/cumulusmx/ExportToMySQL/releases/download/v1.6.1/ExportToMySQL-v1.6.1.zip is here.] | ||
Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the table to be updated. | Check compatibility with the MX release you have running as per notes above. Note that compatibility is needed both with the .dll files and with the columns present in the database table to be updated. | ||
If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns. | If you are not using the MX release named above, then other release zips (and source code) for this utility are available at [https://github.com/cumulusmx/ExportToMySQL/releases ExportToMySQL/releases] and each release there is labelled as to which MX release creates default tables with correct columns. | ||
This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting a [[Your Own Server|MySQL, or MariaDB, database server]]: | This utility reads [[MySqlConnect|Settings]] that are also used by "CumulusMX.exe". Parameters supplied to this utility enable it to do ''one of the following actions'' affecting rows not already present on a [[Your Own Server|MySQL, or MariaDB, database server]]: | ||
# The parameter used is "dayfile", will | # The parameter used is "dayfile", will insert missing rows into a database table that is called "dayfile" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of [[dayfile.txt|daily summary (dayfile.txt)]] file | ||
# | # Insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) from the contents of the single file of [[Standard log files|month by month (MMMyylog.txt)]] whose relative path "data/..." is named in the parameter | ||
# The parameter used is " | # The parameter used is "monthly", will insert missing rows into a database table that is called "Monthly" (by default, the user can change the name of that table) that (as minimum) has columns named as per the MX default for that table (at CumulusMX.exe release quoted for which the download applies) reading data from the contents of all files of type [[Standard log files|month by month (MMMyylog.txt)]] found in the [[Data folder|data sub-folder]]. | ||
Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.] | Installation and usage information by the author of the utility can be [https://github.com/cumulusmx/ExportToMySQL/blob/main/README.md found here.] | ||
| Line 157: | Line 160: | ||
=== Weather Display Converter === | === Weather Display Converter === | ||
This utility was provided by Steve to convert '''Weather Display''' log files to Cumulus 1 format, download [https://cumuluswiki.org/a/File:WDconverter.zip here] | This utility was provided by Steve to convert '''Weather Display''' log files to legacy Cumulus 1 format, download it [https://cumuluswiki.org/a/File:WDconverter.zip here]. | ||
There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here]. | Please carefully read the '''readme''' file in the zip. There is a [https://cumulus.hosiene.co.uk/viewtopic.php?f=4&t=10118 forum thread about using this converter with the legacy Cumulus here]. | ||
Remember this utility will not support all fields used by MX. It is advised you use [[#Create Missing]] (see above) after using this utility to populate the other fields. If you do find this utility does not work with your MX release, you may need to manually recreate records, etc. using Cumulus 1 formats, and then [[Migrating from Cumulus 1 to MX|Migrate all your files from Cumulus 1 to MX]]. | |||
=== WeatherLink Converter === | === WeatherLink Converter === | ||
This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download [https://cumuluswiki.org/a/File:WLconverter.zip here]. | This utility was provided by Steve to convert Davis '''WeatherLink''' log files to Cumulus format, download it [https://cumuluswiki.org/a/File:WLconverter.zip here]. Please carefully read the '''readme''' file in the zip to understand how to use this utility. | ||
NOTE: this has nothing to do with Davis ''Weather Link Live'' despite confusing similarity in name. | |||
Basically, this converter utility reads '''.wlk''' files, it creates a folder called '''converted''' into which it places [[Standard log files]] and [[dayfile.txt]] files as used by Cumulus software. You need to be able to manually merge (using a text file editor) the newly created files with any files of same name in your Cumulus [[data folder|'''data''' folder]]. You might also want to read (although not directly related to this converter utility) [[Amending_dayfile#Importing_data_not_recorded_by_Cumulus|Importing_data_not_recorded_by_Cumulus]]. | |||
* | A search on the support forum will reveal various posts on use of this converter. The key topics are: | ||
* | * [https://cumulus.hosiene.co.uk/viewtopic.php?f=6&t=20017 forum topic about using this converter with MX here] | ||
* [https://cumulus.hosiene.co.uk/viewtopic.php?t=11349 forum topic about using this converter with the legacy Cumulus here]. | |||
== Third Party Contributions by other Cumulus Users == | == Third Party Contributions by other Cumulus Users == | ||
| Line 212: | Line 212: | ||
== Cumulus 1 == | == Cumulus 1 == | ||
Cumulus 1 software was popular, when it went public in | Cumulus 1 software was popular, when it went public in 2004, and its [[Cumulus_Users|usage]] grew very rapidly in the subsequent decade until final 2014 release. Even now (in mid-2022) some people are still using the final release version (and a quite substantial number of public viewable weather sites are still driven by earlier builds). | ||
Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]]. | Be aware, the longer you wait before swapping from legacy to Cumulus MX software; the more that MX will have developed away from the legacy. MX's development has effectively abandoned its former focus on compatibility, so you might encounter more difficulty with [[Migrating from Cumulus 1 to MX|transferring your data files when you migrate]]. | ||
