Category:Cumulus MX: Difference between revisions

From Cumulus Wiki
Jump to navigationJump to search
m (Minor rewording)
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Documentation for MX =
This category lists at the bottom of the page all the pages that refer to this category, therefore it is a useful entry point should you wish to explore all pages that are relevant to MX.
<div style="padding-left: 20px; width: 95%; border:solid; border-width: thin; padding:10px; margin-bottom:20px; padding-bottom:20px; background-color:#FFFFCC"><big>'''It's your Wiki......'''</big><br> <br>We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do. 


== Cross reference to pages on [[Compare C1 and MX|Comparing legacy original Cumulus with MX]] and [[Migrating_from_Cumulus_1_to_MX|How to migrate]]  ==
Every page, linked from this page, was written in the past, newer MX releases may therefore require these pages to be updated, can you help to do that?  You will see messages on various pages warning that they are out of date, and asking for your help to add content under some headings.


If you are still using the original Cumulus software; the articles linked in the heading should help you decide whether to migrate to MX, and how to do it.
As a starting point, we suggest you read [[Help:Contents/Editing|How to Edit]] which was written specifically for this Wiki. [[How_you_can_contribute]] is full of suggestions on where your help would be appreciated.


== Cross-reference to [[What to do when I have a problem with MX]] ==
'''Are you willing to help us rewrite this Wiki to document MX''', as that has been evolving rapidly since Mark Crossley took over development, so there is still lots to document. In particular, '''can you help make it more friendly for those whose first encounter with Cumulus is a MX release? '''
*If you plan on '''CONTRIBUTING''' to the Wiki, then you will need a userid.
**Please use the [[Special:RequestAccount|Request Account]] form to apply for a userid  (you may have to wait some time for a response),  or
**If you already have a userid, then just [[Special:UserLogin|Login here]] (link also available on top right of any page).


Although you may end up asking for advice on the Cumulus Support Forum, read the article linked in the heading first, as it will help you to provide the information that is needed for others to quickly help you.
'''''When requesting a Wiki account, it would be helpful if you can use the same user name as on the Cumulus forum (but use a different password!), it makes it easier for the admins to identify genuine account requests from spammers.'''''


== Cross reference to page on [[Raspberry_Pi_Image|Setting up Raspberry Pi using a pre-built Image]] for Cumulus ==
</div>
QUICK GUIDE TO KEY INFORMATIVE PAGES:
You may be tempted to install MX on a Raspberry Pi, operating in headless mode (instead of connecting a screen and keyboard to it, you do all access to the Pi from another computer on same network). The developer has made life easy for you by combining the '''Raspberry Pi Lite Operating System''' with a pre-installation copy of MX. Find out more about using this pre-built Raspberry Pi image file to create a basic headless server in the article linked in the heading.
*[[What to do when I have a problem with MX]] - read this before you seek advice in the Cumulus Support Forum
 
*[[MX Basic info]] page -  contains details like the library functions used by MX beta, and how the end of day process works.
== Cross reference to page on [[Setting up Raspberry Pi|Running MX on Linux]] for Cumulus ==
*[[Compare C1 and MX|Comparing legacy original Cumulus with MX]] and [[Migrating_from_Cumulus_1_to_MX|How to migrate]]  - If you are still using the original Cumulus software; these should help you decide whether to migrate to MX, and how to do it.
*[[Raspberry_Pi_Image|Setting up Raspberry Pi using a pre-built Image]] - for those tempted to install MX on a Raspberry Pi, operating in headless mode (instead of connecting a screen and keyboard to it, you do all access to the Pi from another computer on same network). The developer has made life easy for you by combining the '''Raspberry Pi Lite Operating System''' with a pre-installation copy of MX.
Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a Raspberry Pi. A Raspberry Pi computer (and similar devices from other manufacturers) is much simpler than a normal computer, but it can still run various operating systems that allow you to use it perhaps for both running MX and a web server. Find out more in the article linked in the heading.
* [[Raspberry Pi computer page]] A Raspberry Pi computer (and similar devices from other manufacturers) is much simpler than a normal computer, but it can still run various operating systems that allow you to use it perhaps for both running MX and a web server
 
* [[MX_on_Linux|MX on Linux]] - really easy to install, and run, MX on any simple computer running Linux or a derivative, this page tells you all you need to know 
==Cross reference to page on [[MX_on_Windows_OS|Running MX on Windows]]==
*[[MX_on_Windows_OS|MX on Windows]] - you may be tempted to install MX on a Windows PC, laptop, or similar computer, this page tells you all you need to know
 
*[[Updating MX to new version|How to upgrade to new MX release]] - whether you have not updated for a long time, or simply wonder whether you are updating the easiest way
Whether you have been using Cumulus 1, or are new to Cumulus, you may be tempted to install MX on a Windows PC, laptop, or similar computer
*[[Cumulus MX FAQ]] - A new FAQ for MX has been started at [[Cumulus_MX_FAQ|another page]]. As I add the link here, the Cumulus MX FAQ is in a mess, but hopefully someone will have time to sort it out.
*[[MX Issues|Cumulus MX Known Issues]] page was based on [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=12943 Steve Loft's forum post] so based on an early beta version of MX, and there has been minimal attempt to update the contents as MX has been developed further and come out of the original beta. <big>Anyone willing to check the linked article and do a further update?</big>
== Cross reference to page on [[Updating MX to new version]] ==
*[[MX Administrative Interface|Administrative Interface]]- all about the pages used for settings, correcting log files, and viewing your weather derivatives locally
 
*[[Cumulus_MX_Local_API|MX application programming local interface]] has been fully documented by the developer
Whether you have not updated for a long time, or simply wonder whether you are updating the easiest way, follow the link in the heading for this section, to an article that contains advice '''both''' for those updating each time there is a new release available '''and''' how to upgrade from an old version in a series of steps, skipping some in-between versions.  So read the article linked in the section heading whether you are still using Steve Loft's beta version of MX or an old Mark Crossley release.
 
== Cross reference to [[Cumulus MX FAQ]] ==
 
A new FAQ for MX has been started at [[Cumulus_MX_FAQ|another page]]. As I add the link here, the Cumulus MX FAQ is in a mess, but hopefully someone will have time to sort it out.
 
== Cross reference to [[MX Issues]] ==
 
The [[MX Issues|Cumulus MX Known Issues]] article was based on [https://cumulus.hosiene.co.uk/viewtopic.php?f=39&t=12943 Steve Loft's forum post] so based on an early beta version of MX, and there has been minimal attempt to update the contents as MX has been developed further and come out of the original beta. <big>Anyone willing to check the linked article and do a further update?</big>
 
== Cross reference to page on [[MX Administrative Interface|Administrative Interface]] ==
 
This requires a whole page to itself, reached from link in heading for this section.
 
== Cross reference to the application programming interface (api) used by MX ==
 
The MX application programming local interface has been fully documented by the developer in [[Cumulus_MX_Local_API|this article]].
 
There is also some older information [[MX_Administrative_Interface#The_API_interface|here]] which explains how the api is used in the administrative interface.

Revision as of 12:27, 8 June 2021

This category lists at the bottom of the page all the pages that refer to this category, therefore it is a useful entry point should you wish to explore all pages that are relevant to MX.

It's your Wiki......

We always welcome contributions from the Cumulus Community and if you feel you can contribute, please do.

Every page, linked from this page, was written in the past, newer MX releases may therefore require these pages to be updated, can you help to do that? You will see messages on various pages warning that they are out of date, and asking for your help to add content under some headings.

As a starting point, we suggest you read How to Edit which was written specifically for this Wiki. How_you_can_contribute is full of suggestions on where your help would be appreciated.

Are you willing to help us rewrite this Wiki to document MX, as that has been evolving rapidly since Mark Crossley took over development, so there is still lots to document. In particular, can you help make it more friendly for those whose first encounter with Cumulus is a MX release?

  • If you plan on CONTRIBUTING to the Wiki, then you will need a userid.
    • Please use the Request Account form to apply for a userid (you may have to wait some time for a response), or
    • If you already have a userid, then just Login here (link also available on top right of any page).

When requesting a Wiki account, it would be helpful if you can use the same user name as on the Cumulus forum (but use a different password!), it makes it easier for the admins to identify genuine account requests from spammers.

QUICK GUIDE TO KEY INFORMATIVE PAGES:

  • What to do when I have a problem with MX - read this before you seek advice in the Cumulus Support Forum
  • MX Basic info page - contains details like the library functions used by MX beta, and how the end of day process works.
  • Comparing legacy original Cumulus with MX and How to migrate - If you are still using the original Cumulus software; these should help you decide whether to migrate to MX, and how to do it.
  • Setting up Raspberry Pi using a pre-built Image - for those tempted to install MX on a Raspberry Pi, operating in headless mode (instead of connecting a screen and keyboard to it, you do all access to the Pi from another computer on same network). The developer has made life easy for you by combining the Raspberry Pi Lite Operating System with a pre-installation copy of MX.
  • Raspberry Pi computer page A Raspberry Pi computer (and similar devices from other manufacturers) is much simpler than a normal computer, but it can still run various operating systems that allow you to use it perhaps for both running MX and a web server
  • MX on Linux - really easy to install, and run, MX on any simple computer running Linux or a derivative, this page tells you all you need to know
  • MX on Windows - you may be tempted to install MX on a Windows PC, laptop, or similar computer, this page tells you all you need to know
  • How to upgrade to new MX release - whether you have not updated for a long time, or simply wonder whether you are updating the easiest way
  • Cumulus MX FAQ - A new FAQ for MX has been started at another page. As I add the link here, the Cumulus MX FAQ is in a mess, but hopefully someone will have time to sort it out.
  • Cumulus MX Known Issues page was based on Steve Loft's forum post so based on an early beta version of MX, and there has been minimal attempt to update the contents as MX has been developed further and come out of the original beta. Anyone willing to check the linked article and do a further update?
  • Administrative Interface- all about the pages used for settings, correcting log files, and viewing your weather derivatives locally
  • MX application programming local interface has been fully documented by the developer

Subcategories

This category has the following 5 subcategories, out of 5 total.