Ready to get started with Climpact? Find out how you can install the latest version of the R package, Climpact2, and how you can get started producing output. (This information is also available in the user guide.)

Prerequisite: installing R

Climpact2 uses the R programming language, so you'll need to download that first (Climpact2 requires R ≥ 3.3) and install it. The video on the right walks you through the process of installing R on Windows, although it is also available for macOS and Linux.

Download R

Using Climpact2's Graphical User Interface (GUI)

The videos here show you the process of installing Climpact2 on either Windows or Linux. Note that you will need administrator privileges on your computer or the ability to install R libraries.

Download the Climpact2 package

  1. Download the above zip file to your computer (https://github.com/ARCCSS-extremes/climpact2/archive/master.zip) and extract it. This will create a directory named climpact2-master.
  2. In Windows: open R and select "File -> Change dir..." and select the climpact2-master directory created in step 1. Then type source('climpact2.GUI.r').

    (NOTE: If nothing happens, try run the additional command startss()).

    In Linux/macOS: change to the climpact2-master directory created in step 1, then open R in a terminal window and type source('climpact2.GUI.r').

    The first time Climpact2 is run it will install required R packages. This will likely require you to select a mirror from which to download.

Calculating the indices on netCDF grids

As well as the above prerequisities, you will need the following additional libraries:

Download the Climpact2 package

  1. Download the above zip file to your computer (https://github.com/ARCCSS-extremes/climpact2/archive/master.zip) and extract it. This will create a directory named climpact2-master.
  2. Change to the climpact2-master directory created in step 1, open R and run source('installers/climpact2.ncdf.installer.r') to install the required R packages. (You may be asked whether you would like to make a personal library; in most cases the answer should be 'yes'.) Once complete, quit R by typing q(). This step only needs to be done once.
  3. Modify the climpact2.ncdf.wrapper.r file to suit your needs (see manual for optional parameters to specify). Then execute by running Rscript climpact2.ncdf.wrapper.r from the Linux command line. Depending on the size of your data and the number of cores selected, this process can take anywhere from one to twelve hours.

Batch processing many station text files

Download the Climpact2 package

  1. Download the above zip file to your computer (https://github.com/ARCCSS-extremes/climpact2/archive/master.zip) and extract it. This will create a directory named climpact2-master.
  2. Change to the climpact2-master directory created in step 1, open R and run source('installers/climpact2.batch.installer.r') to install the required R packages. (You may be asked whether you would like to make a personal library; in most cases the answer should be 'yes'.) Once complete, quit R by typing q(). This step only needs to be done once.
  3. From the terminal run the following command, replacing the five flags as follows:
    • the folder where your station text files are kept,
    • the path to a metadata file containing the file name of each station text file along with relevant station information,
    • the beginning and end years of the base period, and
    • the number of cores to use in processing, respectively.

    Rscript climpact2.batch.stations.r ./sample_data/ ./sample_data/climpact2.sample.batch.metadata.txt 1971 2000 4

    See the user guide included with the package in the user_guide folder for more information.

Known issues

Documentation and contacts

Documentation exists in the form of the README file included with the code, the official Climpact2 user guide, and in the source code itself.

For software issues, contact Nicholas Herold at Nicholas.Herold@environment.nsw.gov.au.

For all other issues, contact Lisa Alexander at l.alexander@unsw.edu.au.