1,738
edits
CumulusUtils: Difference between revisions
From Cumulus Wiki
Jump to navigationJump to search
m
no edit summary
mNo edit summary |
mNo edit summary |
||
|
This is the first page of the CumulusUtils Wiki. From here you should be able to find everything you need to know for this tool.
== Prerequisites ==
This paragraph describes what is required to use CumuluUtils (To be modified/extended by user experience).
#A working CumulusMX environment on Windows, Linux (RPi) or MacOS
##On Linux (and probably MacOS too) Mono 6 and up is required
##NOTE: no experience by the author on MacOS exists so be prepared to communicate
#At least 32 days of data
#For the ''[[Charts_-_Misc_charts|Miscellaneous Charts]]'' more data is required
#A consistent date format in the logfiles
##Mixed data formats in logfiles are not accepted by CumulusUtils
##If a date format in a logfile is used which is not implemented, just request it
== Goals ==
The goal of ''CumulusUtils'' (abbr: ''Cutils'' or ''CUtils'') is to facilitate website creation for users of CumulusMX without exposure to coding in e.g. PHP or javascript. Having a meteo-website should not be privileged to users with great IT-skills. Making charts should not be demanding for programming skills in SQL or making it otherwise impossible to create charts without diving deep into the technique involved in CumulusMX (which actually is also the case with SQL). Note that this does not mean you can't use IT skills: the user configurable menu offers an opening to expand as far as you wish.
''CumulusUtils'' positions itself as a configurable application for which the understanding of how to run it and how to configure it is the most important thing to know. For configuration ''CumulusUtils'' uses [[Cumulusutils.ini|''cumulusutils.ini'']] file which resides in the CumulusMX directory. If that file does not exist, it will be created. All other files related to ''CumulusUtils'' are in the utils directory.
The charts are created using [https://www.highcharts.com/ HighCharts] using their [https://shop.highsoft.com/highsoft/form/noncommercialform non-commercial license]. If you want to use the charts or the [[Website Generator]] of ''CumulusUtils'', please make yourself acquainted with this license.
== Assumptions ==
The user is assumed to have basic computer skills and knowledge about the Operating System and directory structure. The user must also be aware of the directory infrastructure of CumulusMX and needs to be aware of the meaning of the terms ''webroot'' and ''FTProot'' and ''Working Directory''. The user should be able to understand and edit the ini files (both from ''CumulusMX'' and ''CumulusUtils''). The user should understand the basic functioning of ''CumulusMX'' which means the correct availability of ''CumulusMX'' is a precondition for using ''CumulusUtils''.
Some output files can be used with ''Cumulus 1'' but the charting possibilities rely on the availability of the JSON datafiles of ''CumulusMX''. Therefore the use of ''CumulusUtils'' in combination with ''Cumulus 1'' is limited. The [[Website Generator|website generator]] in combination with ''Cumulus 1'' is not advised.
== Output ==
| |||
