### CloudbaseHowTo.txt ###
### silveracorn.nz Cloudbase Version MX_2.2.7 - 1-Jan-2024
### This version compatible with CumulusMXUI template and Saratoga template. ###
Weather Website PHP Scripts from Silver Acorn
These programs are distributed in the hope that they may be useful, but WITHOUT ANY WARRANTY;
 without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 See the GNU General Public License for more details.
!!! There is NO guaranteed support !!!

################################################################################

This CloudBase script has been adapted from Bashewa's original Ver 2.1 script.
The Original was for Weather Display, Virtual Weather Station and WUHU.
This version for Cumulus has been developed from the Original Bashewa script
   without reference to, or code from, any other Cloudbase script.

Both files in this option work with both MX and C1 without alteration.
There is no data file to upload from the CumulusXX/web folder.

################################################################################

We have been asked a number of questions which indicate that new users have not 
   read this document or the notes beside the settings in the script.
Please read this documentation fully before proceeding, and check the
   explanation beside each option in the script before making changes.

Common questions relate to cloud height, Cumulus forecast vs metar, and,
station elevation.
   Cumulus calculates the theoretical cloud height based on a standard formula
      which is virtually identical to the one built into this script.
      Use the Cumulus option to ensure any representation of cloud height is
      consistant on the website.
   The theoretical cloud height is calculated using temperature and dew point.
      It does NOT mean there are actually any visible clouds.
      The cloud height is only displayed if clouds are displayed on the image
      (normally determined from forecast or metar).
   If the option $alwaysShowCloud is set to true, then if no clouds
      would have been shown, a fictitious cloud band is displayed with the
      theoretical cloud height.

   The intent of the Script is to show current conditions. However unless you
      have an instrument to gauge cloud conditions on the station (not
      supported by this script), then either forecast or history must be used.
   Cumulus provides forecast information via the Zambretti algorithm.
      This is a basic forecast for 12 to 24 hrs in the future.
   Metar provides historical information via observation typically at an airport
      and is either:-
      automatic (typically every 30 mins on the hour and half hour), or
      manual (typically every hour on the hour). 
      Metar will always be more accurate at or near the observation location
         than a forecast would ever be.
   You have to decide which alternative is the better representation of the 
      station's environment.
   There is an option $showCldSource to indicate the source of the cloud height
      (Metar or Forecast) - displayed in small text at the top of the image.

   Cumulus always outputs station Altitude Above Ground Level (AGL).
      Should you wish to show the cloud height Above Sea Level (ASL), then this
      can be achieved by setting $stationAltitude to match the Altitude set in
      the Cumulus Configuration/Station/Altitude setting. This Altitude will be
      added to the AGL cloud height by the script to display ASL.
   There is an option $showAGLASL which if set to true will display AGL or ASL
      (whichever is appropriate) beside the cloud height.
      Note this may not always be displayed as there is not always enough space
      for it - see the explanation in the script.

INSTALLATION;

Create a new folder for the expanded files in the CumulusMX folder
	Open the webfiles folder   Copy the contents of the
		Cloudbase for Saratoga folder into this new folder.

Use a PROPER EDITOR - NOT windows notepad - suggest notepad++ as an alternative

In cloudbaseCUmx.php
Check the settings in the section
   // !!! YOU MUST SET/CHECK THESE SETTINGS !!!
   and make sure they are correct for the location and website


Upload
	the images folder
	cloubaseCUmx.php
	get-metarSA-inc.php
to the working Saratoga website.

Install in CumulusMX/web/
Either
	CUtagsT.php
		in the CumulusMX/web folder and configure extrawebfiles to process this file
		Local Filename			C:\CumulusMX\web\CUtagsT.php
		Destination Filename	httpdocs/weather/CUtags.php (or whatever the website path name is)
		tick	Process, FTP, and UTF8
OR
	cldbaseCUtagsT.php
		in the CumulusMX/web folder and configure extrawebfiles to process this file
		Local Filename			C:\CumulusMX\web\cldbaseCUtagsT.php
		Destination Filename	httpdocs/weather/cldbaseCUtags.php (or whatever the website path name is)
		tick	Process, FTP, and UTF8

cldbaseCUtagsT.php is a replacement for the old cloudbaseCUT.txt used in previuos version(s) of Cloudbase.
If running in a Cumulus website which already uses CUTags.php then use
	require_once('./CUtags.php');
If running in a Saratoga website which does not have CUTags.php then use
	require_once('./cldbaseCUtags.php');

Translations;
If a different language is required, the script may be edited directly.
See the notes in the header in the script and edit the texts at the lines
   indicated as required.
Note, translations for cloudbase is NOT provided by the translation
   system used for the rest of the website.
You may also adjust the remaining settings but would recommend that the script
   be used as is until it is seen to be working properly, then change settings
   one at time so you can see the effect.

If Metar is not used, then the file get-metarSA-inc.php is not required.
   Refer to the notes about Metar in the script.

Once configuration is complete, Ftp the new / changed files to the website

Note,  cloudbaseCU.txt cannot used in this version of cloudbase.
 
Enjoy!
BCJKiwi