5,838
edits
Cumulus.ini (preserving history): Difference between revisions
Cumulus.ini (preserving history) (view source)
Revision as of 20:02, 3 February 2021
, 20:02, 3 February 2021→Introduction: Restructure completion
m (Paste) |
m (→Introduction: Restructure completion) |
||
| Line 20: | Line 20: | ||
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. | ||
Now this page has to cover both the original software, and the MX software where development continues, you will find that the table listing parameters available is divided in multiple ways: | |||
*Cumulus.ini uses '''sections''', thus the first way that the list is divided is by the relevant section where the parameter must be placed | |||
** Some sections can take a lot of parameters, and for these sub-sections may be added, that allow you to navigate directly to them from the table of contents | |||
** A parameter may be defined in multiple sub-sections, if its definition needs to be explained differently according to weather station types | |||
*As explained later, some parameters are read-only, and some are read-write | |||
**To make it easier to navigate larger tables, read-only and read-write parameters may be grouped under relevant sub-heading within the table | |||
***A parameter may be read-only in the original software, but read-write in MX, this means some parameters may not be where you first expect them to be | |||
*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 | |||
===Completeness for original Cumulus software=== | |||
'''There is no guarantee that all configuration parameters that can be used (if you are running the original software) are in this list''' | |||
''The problem is that Steve Loft lost some of his documentation and admitted he could not remember all parameters his code could process.'' | |||
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. | |||
This page was originally created when only Cumulus 1 was available. It was updated each time there was a major release, some updates mention the release that introduced that parameter. It can be assumed that all parameters marked as applicable to Cumulus 1, do apply to the final formal release. | |||
If you are still using an earlier version of Cumulus 1, it cannot be assumed that all parameters that do not apply to your version are identified. Since the final version of Cumulus 1 cleared most of the bugs present in earlier releases (not quite all, this is still a bug relating to reading pressure from Fine Offset stations), it is to your benefit to upgrade to final '''legacy release''' and apply the patch to the GUI. Both final version and patch can be [[Downloads|downloaded here]]. | |||
=== Completeness of this list for MX releases === | |||
'''Please note that this list is not updated by the developers when they change the software to react to a new attribute, therefore there is no guarantee that all attributes available appear in this documentation.''' | '''Please note that this list is not updated by the developers when they change the software to react to a new attribute, therefore there is no guarantee that all attributes available appear in this documentation.''' | ||
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. | 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. | ||
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. | 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). | |||
== Beta builds == | == Beta builds == | ||