5,838
edits
Migrating from Cumulus 1 to MX: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
Migrating from Cumulus 1 to MX (view source)
Revision as of 10:04, 11 June 2021
, 10:04, 11 June 2021Update category
m (Update category) |
|||
| (6 intermediate revisions by the same user not shown) | |||
| Line 3: | Line 3: | ||
This page was inspired by this [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17749 update from Cumulus 1] forum topic. That post was made in January 2020, and therefore the bulk of the text on this page relates to Version 3.3.0, which was the MX release that was in use at the time. | This page was inspired by this [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17749 update from Cumulus 1] forum topic. That post was made in January 2020, and therefore the bulk of the text on this page relates to Version 3.3.0, which was the MX release that was in use at the time. | ||
<div style="background: LemonChiffon;padding:5px; margin:2px;"> | |||
[[File:Crystal Clear info.png|40px]] This page was last partially updated for the MX release in July 2020; that is no longer latest! | |||
Appeal to contributors: Please work through all MX release announcements and work out all the many updates needed for this page, it may even need a redesign for more recent releases! | |||
</div> | </div> | ||
You might want to read the related page at [[My_migration_from_C1_to_MX]] which describes how this worked in practice for release version 3.4.5 (build 3069). | |||
==Should I migrate to MX or not?== | ==Should I migrate to MX or not?== | ||
| Line 60: | Line 65: | ||
When you run the original Cumulus software it displays a screen (see [[Cumulus_Screenshots#Main_Screen]], and from there you navigate to other screens to view data or change settings. | When you run the original Cumulus software it displays a screen (see [[Cumulus_Screenshots#Main_Screen]], and from there you navigate to other screens to view data or change settings. | ||
MX is different, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/terminal/console application which has no user interface. It does write diagnostic information to a [[ | MX is different, it consists of a stand-alone 'engine' which performs the reading and logging of data, uploading to a web site etc. This 'engine' is a command-line/terminal/console application which has no user interface. It does write diagnostic information to a [[MXdiags_folder|diagnostic log]], but many people run MX on a device that has no monitor and so the terminal output (if any) is not monitored. | ||
When you successfully start MX, the engine is running, and it continues, until it is terminated by control C (or its equivalent in a Mac environment). | When you successfully start MX, the engine is running, and it continues, until it is terminated by control C (or its equivalent in a Mac environment). | ||
| Line 120: | Line 125: | ||
From release 3.10.1, there appear to be other new parameters, not yet documented. | From release 3.10.1, there appear to be other new parameters, not yet documented. | ||
==Strings.ini== | |||
This is another configuration file, but it is an optional one. If you have not created a [[Strings.ini|strings.ini]] file in your (leagacy) Cumulus top level folder, then you have no file to move to your MX installation, and you should skip the rest of this sub-section. | |||
The contents of the [[Samplestring.ini|samplestring.ini]] file you get in your MX release distribution varies depending on the release you have downloaded. Check your existing '''strings.ini''' file against the ''samplestring.ini'' file in the MX distribution you have. If the attribute names (left hand side of the equals sign) match for the parameters you selected to include in your '''strings.ini''', then you can reuse your existing file. If your file includes attributes that are no longer in the MX ''samplesting.ini'' file, then you will need to edit your '''strings.ini''' file that is placed in the folder containing CumulusMX.exe. | |||
Please remember that the Microsoft Windows Operating System is case insensitive for file names, if you install MX on a Windows PC, then "Strings.ini", "STRINGS.INI", and "strings.ini" are all treated as the same file by MX. If you install MX on another operating system, then the file system is case sensitive, in this case MX will only recognise "strings.ini". | |||
For those of you who are more technical: | |||
*Note that files created in Microsoft's Windows Operating System use two characters (carriage return and line feed) to end each line, while all other operating systems use a single character (line feed in most Unix derived systems like all Linux variants including Raspberry Pi Operating System). Apple Mac are again different in using just Carriage Return. | |||
*This should not cause any problems for your "strings.ini" file as MX does not care if there appear to be some extra blank lines (because the carriage return may be treated as end one line and the line feed as ending a separate blank line on non-Windows devices). | |||
==NOAA style reports== | ==NOAA style reports== | ||
The generation of reports is an optional feature, if you have never used it your (legacy) Cumulus Reports folder will be empty, then you have no files to move to your MX installation, and you should skip the rest of this sub-section. | |||
Please see [[Reports_folder]] for full information. Cumulus software creates reports, it does not edit existing reports, so migration is simple. Just copy the contents of the '''Reports''' folder in your original Cumulus installation into the folder in the new installation. | Please see [[Reports_folder]] for full information. Cumulus software creates reports, it does not edit existing reports, so migration is simple. Just copy the contents of the '''Reports''' folder in your original Cumulus installation into the folder in the new installation. | ||
| Line 128: | Line 147: | ||
* files created in Microsoft's Windows Operating System use two characters (carriage return and line feed) to end each line, while all other operating systems use a single character (line feed in most Unix derived systems). Apple Mac are again different in using just Carriage Return. This should not cause any problems. | * files created in Microsoft's Windows Operating System use two characters (carriage return and line feed) to end each line, while all other operating systems use a single character (line feed in most Unix derived systems). Apple Mac are again different in using just Carriage Return. This should not cause any problems. | ||
* files can be encoded (how individual characters are represented by binary codes) in different ways. There is more about encoding at [[Reports_folder#Encoding]], the relevance here is that if your MX settings and Cumulus 1 settings use different encodings you may find some characters (e.g. degree symbol) do not appear correctly when viewing some of your reports. | * files can be encoded (how individual characters are represented by binary codes) in different ways. There is more about encoding at [[Reports_folder#Encoding]], the relevance here is that if your MX settings and Cumulus 1 settings use different encodings you may find some characters (e.g. degree symbol) do not appear correctly when viewing some of your reports. | ||
=="data" folder== | =="data" folder== | ||
| Line 252: | Line 270: | ||
Unzip the MX download (from [[Software]] for latest version or from https://github.com/cumulusmx/CumulusMX/releases if you want an earlier release version) so the folder '''CumulusMX''' is the same folder as that which has "Cumulus.ini" in it. The unzip ensures all the files that need to be in sub-folders go into correct sub-folders. | Unzip the MX download (from [[Software]] for latest version or from https://github.com/cumulusmx/CumulusMX/releases if you want an earlier release version) so the folder '''CumulusMX''' is the same folder as that which has "Cumulus.ini" in it. The unzip ensures all the files that need to be in sub-folders go into correct sub-folders. | ||
Your | Your log files in the [[data folder]] and any NOAA reports you may (they are optional) have created in [[Reports folder]] are available to MX. | ||
You should read [[:Category:Ini Files]] page, as you might need to edit some items in the '''.ini''' files. | |||
For the [[:Category:MX txt Files|'''.txt''' files]], you need to check that all lines are consistent in using the same character to separate the 3 parts of the date (see , and the same character is used throughout to separate the items in list of fields. | |||
*Cumulus 1 will accept any character (except space, a digit, or the character used to separate fields in a list) as a separator for the date parts | *Cumulus 1 will accept any character (except space, a digit, or the character used to separate fields in a list) as a separator for the date parts | ||
