Installing KPP-for-GEOS-Chem

Once you have made sure that your system meets all the System requirements, you may download and install KPP-for-GEOS-Chem.

Downloading

The following sections describe how to download KPP-for-GEOS-Chem with Git. The version of KPP-for-GEOS-Chem that you will need to use depends on the GEOS-Chem version that you have.

Important

Do not download the KPP-for-GEOS-Chem source code into your GEOS-Chem source code directory! This will avoid confusion with the KPP folder within GEOS-Chem. This folder contains Fortran-90 source code files that are generated by KPP-for-GEOS-Chem.

KPP-for-GEOS-Chem 2.3.2_gc – currently experimental

The current version of KPP-for-GEOS-Chem 2.3.2_gc is for use with ongoing GEOS-Chem development. It should not yet be used with any released GEOS-Chem versions.

To download this version, type at the command line:

$ git clone -b GC_updates https://github.com/geoschem/KPP.git

You may now proceed to our Compiling section below

KPP-for-GEOS-Chem 2.3.1.gc – for GEOS-Chem 13.1.0 and later

If you will be working with GEOS-Chem 13.1.0 and later, then you will need to download KPP-for-GEOS-Chem 2.3.1_gc. Type at the command line:

$ git clone -b 2.3.1_gc https://github.com/geoschem/KPP.git
$ git -C KPP branch 2.3.1_gc

You may now proceed to our Compiling section below.

KPP-for-GEOS-Chem 2.2.5_gc – for GEOS-Chem 13.0.2 and earlier

If you will be working with GEOS-Chem versions older than 13.1.0, then you will need to download KPP-for-GEOS-Chem 2.2.5_gc. Use the following commands:

$ git clone -b 2.2.5_gc https://github.com/geoschem/KPP.git
$ git -C KPP branch 2.2.5_gc

Compiling

Build the KPP-for-GEOS-Chem executable file with these commands:

$ cd KPP/kpp-code
$ make distclean
$ make all

If the build completes successfully, you will see the executable file KPP/kpp-code/bin/kpp.

Setting the path

Once have built KPP-for-GEOS-Chem, you must add the path to the executable file to your PATH environment variable.

If you use the bash Unix shell, add these lines to your ~/.bash_aliases file. If you don’t have a ~/.bash_aliases file, you can add these lines to your ~/.bashrc file instead.)

export PATH=$PATH:/PATH_TO_KPP/KPP/kpp-code/bin/
export KPP_HOME=PATH_TO_KPP/KPP/kpp-code`

If you use the csh or tcsh Unix shell, add these lines to your ~/.cshrc file:

setenv PATH $PATH:/PATH_TO_KPP/KPP/kpp-code/bin/
setenv KPP_HOME=PATH_TO_KPP/KPP/kpp-code

Note

  • For example, if you installed FlexChem-KPP into your home directory, then PATH_TO_KPP would be ~/KPP, etc.