Cumulus Wiki

Cumulus.ini (preserving history): Difference between revisions

Cumulus.ini (preserving history) (view source)

Revision as of 20:28, 3 February 2021

209 bytes added ,  20:28, 3 February 2021
m
→‎Is this documentation definitive?: Rewrite for clarity
m (→‎Introduction: Restructure completion)
Line 16: Line 16:




==Is this documentation definitive?==  
==Is this documentation definitive?==
 
<big>Anybody with a log-in for this Wiki can edit this page, and your contribution to improving this article is welcomed.</big> 
 
The only rules are to follow existing table layout where possible,
*If a table is sub-divided between read-only and read-write, add any new parameters to the correct sub-section
*If a table is sub-divided between "both flavours", "Cumulus 1 only", and "MX only",
  add any new parameters to the correct sub-section
* the default value should be shown in first column,
* the explanation should be in second column
** use bullets where there is a choice of values
** say what release introduces any new parameter
 


Later on this page there is a table showing parameters that may be in the configuration file, the default value for each attribute is mentioned, and it is made clear whether that parameter can be set through the settings screen in the software or must be manually added to the file.  
Later on this page there is a table showing parameters that may be in the configuration file, the default value for each attribute is mentioned, and it is made clear whether that parameter can be set through the settings screen in the software or must be manually added to the file.  
Line 29: Line 41:
*In larger tables, parameters may be grouped by whether they apply to both Cumulus 1 and MX, or apply to one flavour only
*In larger tables, parameters may be grouped by whether they apply to both Cumulus 1 and MX, or apply to one flavour only
**There are no references to which parameters apply to Cumulus 2, as that flavour of the software is not available now
**There are no references to which parameters apply to Cumulus 2, as that flavour of the software is not available now
If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.


===Completeness for original Cumulus software===
===Completeness for original Cumulus software===
Line 36: Line 51:


''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.''
''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.''
*There have been over a thousand builds of Cumulus version 1
* Steve Loft (as developer) did make some entries that are retained on this page (those should be correct)
*Steve Loft also described in his posts on the forum a number of parameters and how they are used (hopefully all those have been copied into this page, but on 2 June 2008, Steve Loft swapped to new forum software and did not retain any posts prior to then, so there is no way to check the relevant posts between 2003 when the software was first released and May 2008)
*Each contributor may also add/edit entries because of a personal experience of using a particular parameter


The read-write parameters are correct, as they have been checked against [[Cumulus Screenshots|Configuration screens]]. There is no source available for Cumulus 1, so nobody can check what read-only parameters are available against what is documented below.   
The read-write parameters are correct, as they have been checked against [[Cumulus Screenshots|Configuration screens]]. There is no source available for Cumulus 1, so nobody can check what read-only parameters are available against what is documented below.   
Line 50: Line 70:
It is intended that any additions made to the list will indicate which release made that extra parameter available. Therefore this page should help you whatever MX release you are running.
It is intended that any additions made to the list will indicate which release made that extra parameter available. Therefore this page should help you whatever MX release you are running.


If you spot a parameter that is missing from this list (check you are looking in the right section, and under the correct sub-heading where a section is sub-divided for ease of using this article), then please add it to this Wiki article. None of the authors who have contributed so far can claim completeness.  Sometimes a search on the forum for something else reveals a mention of an additional parameter that can be added to the file but has not been previously added to this list.
Originally, there was a separate page [[Cumulus.ini (Beta)]] used for MX, when Steve Loft was developing MX and kept it in Beta.
 
There have been over a thousand builds of Cumulus version 1 and much of this article has been written based on experience in using Cumulus, it may not reflect every parameter that can be manually added to the file, although it does reflect all those linked with settings made on various screens.
The majority of the parameters are also used by Cumulus MX, which can edit in its settings screens some that Cumulus 1 cannot edit. There are also extra parameters that only apply to MX, plus some extra values available for some attributes like weather station make.  '''The configuration parameters available in MX are often changed by a new release'''.  Any new read-write parameters introduced by a new release will be added to "Cumulus.ini" when you close MX, but unless someone manually adds them to this article they will not be documented here.  However, the default for those read-write parameters might not agree with your preference. Any new read-only parameters added by a MX release will neither be added to your "Cumulus.ini", nor be added to this article, unless manual action is taken.
 
 
Anybody with a log-in for this Wiki can edit this page, and your contribution to improving this article is welcomed.  The only rules are to follow existing table layout where possible, so the default value is shown in first column, to make it clear whether it is available in Cumulus 1 or not (ideally say from which version), to make it clear what version of MX introduces it (if available in MX).
 
 
If you are using an older Cumulus 1 version, then ''checking the release information may be advisable'' to identify the sections applicable to your build (because not all authors editing this article do that for you), and to identify if the parameters allowed within those sections may be a subset of those listed below as available in latest release of Cumulus 1.


Similarly, the parameters available may vary between different versions/builds of MX, again ''checking the release information may be advisable'' to identify the sections applicable to your build, and to identify if the parameters allowed within those sections may be a subset of those listed below (although authors contributing to this article are expected to give some version information).
When Mark Crossley took over MX development he brought it out of Beta, and from then onwards this page has tried to cover MX as well as the original Cumulus software, because the two flavours don't use the same parameters, there are a lot of complications in trying to ensure this page does completely cover MX.  


'''The configuration parameters available in MX are often changed by a new release'''.
*Any new read-write parameters introduced by a new release will be added to "Cumulus.ini" when you close MX, but unless someone manually adds them to this article they will not be documented here.  However, the default for those read-write parameters might not agree with your preference.
*Any new read-only parameters added by a MX release will neither be added to your "Cumulus.ini", nor be added to this article, unless someone checks this page is updated for each release.
**Hopefully, new parameters are listed in a release announcement, but sometimes you may need to look in a topic with contributions from both users and the developer.


== Beta builds ==
== Beta builds ==
Sfws
5,838

edits

Retrieved from "https://www.cumuluswiki.org/a/Special:MobileDiff/7774"