Modules

From Cumulus Wiki
Revision as of 09:16, 14 April 2021 by HansR (talk | contribs) (Initial edit)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Introduction

Modules are the basic building blocks of CumulusUtils. Identifying modules on the commandline they become synonym with commands to CumulusUtils.

The list of modules

CumulusUtils offers the following modules (which can be used as commands):

  1. SysInfo
  2. Forecast
  3. StationMap
  4. UserReports
  5. pwsFWI
  6. Top10
  7. Graphs
  8. Yadr
  9. Records
  10. NOAA
  11. DayRecords
  12. AirQuality

The multiple module commands

In addition to the true modules which are equivalent to commands, there are commands which are strictly spoken not modules because they do not comprise a single functionality:

  1. Website => generates the website which consists of all modules, the inclusion of the libraries is embedded in website's index.html.
  2. All => generates all modules without the context of the website, the inclusion of the libraries is embedded in the generated files.
  3. UserAskedData => a specific command used for generating JSON datafiles when required by other modules (Compiler and/or AirQuality)
  4. CompileOnly => a command which activates the compiler only. This is a very specific command with more than one effect. Please check out its own page.