TM5 rc files


TM5 interface consists in one main rc file, where users control the model settings. Through [[User_interface_:_RC_files#Encapsulation|encapsulation]], it includes several other rc files, which deal with settings that users seldom have to change. These extra resources are found in:
  • Grid and Region rc file
    The file defines the horizontal grid, zoom regions (if any) and reduced grid settings.
  • Expert rc file
    Contains expert settings for configuring the code. You probably will never have to look at it.
  • Meteo rc file
    Has keys that define how to read and interpolate the meteorological fields.
  • Machine rc file
    This file is site/system specific. It defines path to libraries, the make/MPI/debugger commands, and path to model data. It also contains the compiler-specific keys, either directly or through inclusion of a compiler rc file.
  • Compiler rc file
    Characterizes the compiler and its flags. Files for ifort, gfortran and xlf are available.
  • Job scheduler
    Defines all the flags available to submit a job. Files for bsub, qsub, loadleveler and SLURM are available.
  • chem.input.rc
    This file defines several inputs for the chemistry project: path to emissions inventories and flags for switching inventories, photolysis and stratospheric boundary inputs.
  • expert
    For core developers.

All the rc files distributed with the code are in the rc directory.

Main rc

This is the principal interface with the model. It has its own wiki page here.

Grid and region

The regions file is by default included in the expert file, which automatically picks up the file defined by the global region (eg, pycasso-tm5-regions-glb300x200.rc for a glb300x200 run).

The regions files define the global grid (resolution, number of grid box, ...), but also both the zoom regions and the reduced grid around the poles for advection. Beware that you should not modify those files in the distribution. If you want to change them, make a copy that you can edit and include in your main rc file. This requires using the expert file that does not include a region file. That is, you just replace:

#include base/${my.branch}/rc/pycasso-tm5-expert.rc


#include base/${my.branch}/rc/pycasso-tm5-expert-no-region-def.rc
#include path/to/my/own/region/file/pycasso-tm5-regions-glb300x200.rc

As an example, check the chemistry template (tm5_template_chem.rc) that automatically uses a specific regions file for glb100x100.



See how to configure TM5.


The compiler information, which can be either in the machine rc file, or in its own file.

Job scheduler

Information about the job manager can be added to the machine rc file, or found in a dedicated file.


It is available in the rc subdir of your base branch. It is recommended to make and use a copy in the main TM5 dir, so you can freely edit the file. Most of the keys are self explanatory, and switches (T/F) are set to their recommended values. You basically need to:
  • set the path to the main inventories
  • switch on/off the inventories you want

Note the following key:
input.emis.year : YYYY
When set, it fixes emissions to their YYYY level. If you comment the line (as it is by default), the run will use the "simulation year" as "emissions year".

Keep in mind that, with an inventory available for 1998-2009 for example, emission years before 1998 will use 1998, and after 2009 will use 2009.


Included in the main rc file, this file is mainly for core developers. Modify only if you know what you are doing!