Print bookPrint book

Climsoft Guides in English

This item uses the "Book" Resource to present the Climsoft Guides in English.

Site: Met-eLearning Site (Moodle 2.9)
Course: Climsoft
Book: Climsoft Guides in English
Printed by: Guest user
Date: 15 December 2017


     Quick Installation Guide

    This guide is intended for Climsoft site installers. It will help you to navigate the three-part installation and configuration process.

     Quick Installation - Video

    This video will guide you through the process of installing Climsoft v3.2. It includes a demonstration lasting 10 minutes followed by a practice session where you follow the steps yourself.

     Guide to User Management

    This guide describes the different user roles that are available in Climsoft. Different roles have different sets of permissions ranging from the Operator who only has access to the temporary database via the key entry tables, through to the Administrator who has full access to the whole system. This guide explains how to add and remove users and assign them different roles.

     Guide to Data Migration and Upgrading

    This guide is designed for those users who are currently using version 2 of Climsoft and will show how to migrate their data into version 3.

     Guide to Uninstalling and Reinstalling Climsoft

    This guide will show you how to remove Climsoft and its components from your computer so that a re-installation can be completed without interference from the previous installation. In order to re-install from a previous version several processes must be carried out to ensure that the new installation is fully functional.

     Updating Climsoft - Video

    This video takes you through the process of uninstalling Climsoft and then installing a new version. This includes a demonstration lasting 15 minutes followed by a practice session. Before you remove Climsoft you must make sure you have taken a backup copy of your database files so that these do not get overwritten in the re-installation process.

     Uninstalling Climsoft - Video

    This video will take you through the process of removing Climsoft from your PC. It includes a demonstration lasting just 3 minutes followed by a practice session.

     Guide to Populating Climsoft from the Main Installation File

    In many cases Climsoft will need to be installed on several workstations within a site and for this we advocate a two-part installation. The first part is the installation of the software itself which will be done on all workstations. Customisation, including adding the station information, would then be done on one workstation and the resulting databases packed together so they can be easily transferred to all other workstations. The second part of the installation would be the transfer of the customised databases which would then be done on the other workstations. This guide details this process.


The Climsoft tutorial is designed to take you through the process of setting station information and entering climatic data. It covers entering information and data directly using the forms provided with Climsoft, as well as importing the information and data from text files. In this section you will find not only the detailed instructions, but also the data files you will need for importing.

Please note the tutorial is not yet complete; updated versions will be loaded as they become available.

Guides to Data Entry

The guides in this section are designed to show staff how to enter data using the different forms that are available. It is assumed that site administrators would carry out any necessary customisation of the data screens.

      Data Entry Guide

    This guide explains how to enter data for one or multiple elements using a variety of different data entry forms. Data are entered into a temporary database before being transferred to the intermediate database where quality control checks are carried out and from there they are transferred to the main CLIMSOFT database.

      Quality Control during Key Entry

    Although most of the quality control is done from within the intermediate database there are some checks that are carried out during key entry. Must of this is to do with checking that values are within the allowable range for the particular element. Note that data for many of the elements are entered with a scale factor; for example temperature by default has a scale factor of 0.1, thus a temperature of 10oC should be entered as 100.

      Guide to Entering Data for Rainfall Stations

    This guide shows the user how to enter daily rainfall data for a month at a time.

      Entering Rainfall Data - Video

    This video shows how to enter rainfall data a month at a time using one of the data entry forms provided with Climsoft. There is a six-minute demonstration followed by a practice session.

      Importing Data into the Temporary Work File

    This guide shows how to import data into Climsoft. This would generally be data stored in a .csv file. When you are importing data for particular stations you must ensure that the station information already exists within the Climsoft database. You would need to ensure this is the case for all workstations where you intend to import the data.

      Guide to Exporting Data from the Temporary Work File

    This guide is intended for users who only perform key entry tasks and describes how they can save, export and send data from the temporary work file on their computers to a central database server where the files will be imported into an intermediate database for quality control and further use.

      Exporting Data from the Temporary Work File - Video

    This video demonstrates the process of exporting data from the temporary work file.  It comprises a short 3 minute demonstration followed by a practice session.

Guides for the Site Administrator

In this section are the guides designed for Site Administrators. Activities include entering the station information, customising the data forms, setting up double data entry, and backing up the database.

      Metadata Management Guide

    This guide is intended for administrators who wish to import, modify or create metadata. For the purposes of Climsoft, metadata refers to information about stations, elements, instruments and other objects in the Climsoft database. Station information must be in place before data for that station can be added. We would anticipate this being done by the site administrator.

      Entering Station Information - Video

    This video demonstrates the process of entering station information into Climsoft. The station information must be present in the Climsoft database before data for that station can be added.

      Importing Station Information - Video

    This link will take you to a video stored on the SSC's YouTube Channel (SSC Broadcast) and demonstrates how to import station information from a text file. The same example is used in the tutorial which can be downloaded, along with the relevant data files, from the Climsoft website.

      Guide to Customising Data Forms

    This guide is intended for administrators who wish to modify or delete data forms for key entry users. Climsoft comes pre-installed with a number of data forms as examples for key entry. Some forms are immediately visible in the Key Entry window and are ready for data entry, while other must be added. Forms can also be removed from the Key Entry window, adapted for local use, or deleted altogether.

      Guide to Double Entry

    This guide will show administrators how to use Climsoft's double key entry feature. This facility means that each data item entered from a paper form is entered twice and by different key entry operators. This works on the assumption that two individuals will not make the same errors in data entry and in this way it helps to trap potential errors that might otherwise find their way into the database.

      Guide to Backing up and Restoring the Main Database

    Backing up the database is an essential part of data management. Without secure backups your data are vulnerable to both hardware and software failure. This guide is intended for site administrators to show them how to back-up the main database in Climsoft and how to restore it from the backup. We would recommend backing up on a regular basis and keeping at least two backup copies in secure and separate locations.

Guides to Quality Control and Data Transfer

Quality Control - Intermediate & Main Databases

Climsoft works with three databases: (1) the temporary work file, (2) the Intermediate Database, and (3) the Main Database. The guides in this section show how to transfer data from the temporary work file to the Intermediate Database; describe the quality control checks that are done in the Intermediate Database; and show how to make the final transfer to the Main Database.

      Updating the Intermediate Database

    This guide explains how to transfer data from the temporary work file to the intermediate database where further checks on the data will be carried out.

      Quality Control in the Intermediate Database

    In Climsoft most of the quality control is carried out in the Intermediate Database; this guide shows how that is done. The quality control process looks for data entry errors, errors in imported data and for inconsistencies between data items.

      Updating the Main Database

    Once quality control checks have been carried out in the Intermediate Database, the data should be transferred to the Main Database. The idea behind the three database system is to try and ensure that only clean data are transferred and stored in the Main Database. This guide will show how to do this final transfer and update.  You should remember however that datasets are seldom completely clean and as such you may need to make further corrections or further transfers if errors are discovered at a later date.

Products Guide and Specialist Guides

      Guide to Climsoft Products

    In the context of Climsoft, Products are the reports and diagrams that can be generated from within the software package. This guide will explain the types of output that are available and how they are produced.

    Note: This guide is not yet complete.

      Encoding Data into TDCF

    The Table Driven Code Form (TDCF) is used to code meteorological data in a fixed form using numeric codes. Two examples of TDCF are Binary Universal Form for the Representation of meteorological data (BUFR) and Character form for the Representation and Exchange of data (CREX). These systems offer flexibility and expandability as they are self-descriptive. Data for many elements can be coded into a single TDCF message. This guide will briefly describe these methods and will show how to encode and transmit data using these systems.

    Note: The BUFR and CREX functions have not been verified - Information in this guide was taken from earlier versions of the guides but has yet to be confirmed as correct by the developers.

      AWS Real Time Data Processing

    This guide is intended for users from Automatic Weather Stations and explains how to set up and configure CLIMSOFT for processing data from these stations.

    Note: AWS functions have yet to be verified by the developers.

Guide for Contributors and Developers

    Contributing to Climsoft

    Climsoft is an Open-Source community development. It is developed to meet the needs of its users, and it is very important that users get involved.

    Contributors are users who are actively involved in using and developing Climsoft, through some or all of the following activities:

    • Reporting bugs and errors through the Forum
    • Testing bug fixes
    • Suggesting and specifying extensions to the Project
    • Developing and testing local extensions and changes
    • Offering developments for inclusion in the core Project.

    Get involved!

    The Climsoft Community needs your help. Share your experience and ideas here, and become a Contributor.

    Climsoft Contributors must first read and sign the Climsoft Contributor Agreement. This is to protect both you and the Climsoft Project. Click on the link below:

      Climsoft Contributor's Agreement

      Contributors Discussion Forum

    [Not available unless you complete the Climsoft Contributor's Agreement.]

    This is where the Climsoft Contributors discuss and help develop Climsoft (report a bug, ask for help or changes, give results of tests, share new or amended products, tools, code and documentation).

    Please complete the Contributor's Agreement through the link above, then you will have full access to this Forum. Guests can read the forum posts, but not add to the forum.

      Data Model - 2014-03-27

    This comprehensive guide describes the structure of the main Climsoft database including the relationships within the database. The eventual aim of this document is to also describe the tables and queries within the database and state their purpose within the Climsoft system.

    This guide is still under development but we have uploaded it here so that users and developers can provide feedback.

      Climate Data Management System Specifications

    WMO No 1131 - also available through a WMO website link. This provides advice on the functionality of a climate data management system, with classifications as Essential, Recommended or Optional. This advice is general, not just for Climsoft, and is intended to be useful for all National Meteorological and Hydrological Services.