Migrating from Cumulus 1 to MX: Difference between revisions

Migrating from Cumulus 1 to MX (view source)

Revision as of 09:43, 31 July 2020

4,350 bytes added , 09:43, 31 July 2020

m

→‎Files to copy from Cumulus 1 into where you are installing MX

Sfws

5,838

edits

@@ Line 285: / Line 285: @@
 == Files to copy from Cumulus 1 into where you are installing MX==
-MX requires all files from "data" and "Reports" folder created by Cumulus 1. You also need "strings.ini" (if you use that), and "Cumulus.ini", plus any other tailoring set-up files, batch processes etc. you might use.
+There are three approaches to installing MX:
+#Install MX OVER your Cumulus 1 installation (this only works if you want to run MX on same PC as you have been running Cumulus 1)
+#*This means that all your existing files will be available to MX
+#*This is simplest approach for those who want a simple install
+#*You may need to edit a few files, please see references to files that might need editing later
+#*Because you have Cumulus 1 and MX executables in same location, you would expect it is easy to run either, but as already explained some files can  not be read by Cumulus 1 after MX has changed their content
+#Take a copy of your Cumulus 1 installation and store that copy where you can use it if you want to return to Cumulus 1
+#*In original Cumulus 1 location, delete Cumulus.exe (or whatever your Cumulus 1 executable was called)
+#*Now follow the instructions for first approach, installing MX over the existing files (but ignore the point about running both executables)
+#Install MX in a NEW location (this might be on your PC that was running Cumulus 1 or onto another device such as a Pi)
+#*This approach requires you to manually copy various files from old folders to new location
+#*MX requires all files from "data" and "Reports" folder created by Cumulus 1.
+#*You also need "strings.ini" (if you use that), and "Cumulus.ini", plus any other tailoring set-up files, batch processes etc. you might use.
+#*This approach is generally easier if you want to be able to go back to running Cumulus 1
-You may be installing MX on a different device to the Windows PC that Cumulus 1 ran on, in that case follow first alternative below.
+=== 1: SIMPLE OVERWRITE APPROACH===
-If you are installing MX on a PC that has been running Cumulus 1, then there are actually 2 alternatives to choose between:
+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.
-#    Just create a new directory (recommended name CumulusMX) and unzip the contents into it. Then copy over your existing data files and your Cumulus.ini file, and any other configuration files that you may have created (e.g. strings.ini, twitter.txt etc). In this case you will need to edit that copied across "Cumulus.ini" so any lines that referenced the old folder are changed to reference the new folder, and you may need to edit a few other items either now, or via the settings functionality in MX user interface. The big advantage of this approach is that anytime you are not running MX you can go back to Cumulus 1 and let it run from where it left off (subject to availability of past data in your weather station).
+Your [[Category:Log Files|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 the page in that log file link, as you might need to edit some items in the '''.ini''' files.  For the '''.txt''' files, you need to check that all lines are consistent in using the same character to separate the 3 parts of the date, and the same character is used throughout to separate the items in list of fields.
-#    Alternatively, to run Cumulus MX with your existing Cumulus data, take a back up copy of your existing Cumulus directory, and then unzip Cumulus MX into the original Cumulus folder. This saves you from copying Cumulus 1 files, and removes the need to edit any reference to folders. However, using same folder stops you going back easily to Cumulus 1 if you have an issue, because MX changes the date formats in some files, so that Cumulus 1 can no longer understand them.
+*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
+* MX will only accept the character defined in your locale (for a Windows pc that is actually set in Control Panel which Windows does not make easy to access preferring you to use its Settings app.
+*There is a Clock and Region section in Control Panel and in the Region window you '''define the separator MX will use in the Short date item''', most easily by clicking additional settings).
+*Now ensure that is same character as used in al lines of your .txt log files.
+** If you have some lines using say "/" and some using "." or "-" as date separator, then there are many editors available that offer a global replace.
+***As an example, Notepad++ has a '''Replace All in All Opened Documents''', so you can open multiple documents and do a global replace of "/" into "-"  very easily. Notepad++ saves the file in the same encoding as it was before, but you can also check it is UTF-8 with no Byte Order Mark via the menus.
+***Note that you cannot easily replace "." or "-" globally in dates, because those appear as valid characters in fields. To edit those, you would need to open the files in a spreadsheet editor like '''Libre Office''', you need to ensure that the dates column is treated as text, then select that column and do a replace in just the date column, and then save as a CSV format file changing the extension to .txt. There is more information on this in relevant log file articles.
+**The basic Microsoft Notepad that comes with Windows has a Replace option in its Edit menu, but some versions of this editor (check '''Save As''' options) don't allow you to pick "UTF-8" encoding (if that is not already shown) when saving to ensure MX can read the output.
+**Also be aware when using Google editors that they may save the file in the wrong format unless you can choose a UTF-8 no BOM option.
+=== 2: COPY C1 AND OVERWRITE ORIGINAL WITH MX APPROACH ===
+Alternatively, to run Cumulus MX with your existing Cumulus data, take a back up copy of your existing Cumulus directory, and then unzip Cumulus MX into the original Cumulus folder. This saves you from copying Cumulus 1 files, and removes the need to edit any reference to folders. However, using same folder stops you going back easily to Cumulus 1 if you have an issue, because MX changes the date formats in some files, so that Cumulus 1 can no longer understand them.
+Other issues as described in previous sub-section apply.
+=== 3: NEW LOCATION APPROACH===
+These notes apply whether you are installing in a new location on your PC or installing MX on a different device.
+#First create a new directory (recommended name CumulusMX) and unzip the contents into it.
+#*For a pi, the instruction might be <tt>unzip -o CumulusMXDist3'''nnn'''.zip</tt> where  '''nnn''' is the last 3 digits of the build number.
+#Then copy (or file transfer over)
+#* your existing data folder contents into the new data folder created by unzipping,
+#*your  and your Cumulus.ini file, and any other configuration files that you may have created (e.g. strings.ini, twitter.txt etc). In this case you will need to edit that copied across "Cumulus.ini" so any lines that referenced the old folder are changed to reference the new folder, and you may need to edit a few other items either now, or via the settings functionality in MX user interface. The big advantage of this approach is that anytime you are not running MX you can go back to Cumulus 1 and let it run from where it left off (subject to availability of past data in your weather station).
 === Editing files===