Getting Started

From icon-art guide
Revision as of 11:50, 13 October 2023 by Admin 1 (talk | contribs) (→‎Creating a Runfile: typo)
Jump to navigation Jump to search

Requirements to run ICON-ART

As for most atmospheric models, it is strongly recommended to run ICON-ART on a High Performance Computing system such as Levante from the DKRZ or HoreKA from KIT. This usually requires an account which has to be obtained through the respective HPC Systems procedures.

Getting the source code

A user who wants to work with ICON-ART has to sign the ICON license agreement with the German Weatherservice (DWD) and Max-Planck-Institute for Meteorology (MPI-M) first. Further information can be found on the following website:

https://code.mpimet.mpg.de/projects/iconpublic

Afterwards you also should get access to the DKRZ gitlab. If you have access you can clone ICON.

Example for cloning the ICON-KIT repository including all submodules (including ART):

git clone --recursive git@gitlab.dkrz.de:icon/icon-kit.git

Installation

ICON-ART is already included in the most recent ICON version. For Instructions on how to install ICON, please refer to the first chapter of the ICON Model Tutorial. The only caveat is that during the configuration step the tag --enable-art has to be included.

Step-by-step guide:

  • Navigate to your ICON main folder.
  • Within this directory, you will find the 'config' folder.
  • Inside the 'config' directory, there are several subfolders corresponding to different institutions.
  • In each institutional folder, you will find configuration scripts tailored for various computers and compilers.

Example for HoreKa at KIT:

  1. Access your ICON main folder.
  2. Run the following command: config/kit/hk.intel-2022-openmpi-4.0 --enable-art
  3. Execute make -j4
  4. You should now have a functional binary with ART integration. For other HPC systems, substitute the config script with the one relevant to your HPC system.

Creating a Runfile

  • Go to icon-kit/run/checksuite.icon-kit
  • Run bash-script run_testsuite via ./run_testsuite
  • The script creates the folder runscripts, which contains exemplary runfiles which are adapted to your HPC-System (if available in the config files). For the description of the runscripts see the table below.
  • in icon-kit/run/checksuites.icon-kit/Test-<current_date>.info you will find a few informations to the ICON-ART Testsuite you just created, including your output directory when you perform the model runs in the next step
  • To run your chosen runscript just execute from the console, e.g. by typing runscripts/NWP_LIFETIME.run
runscript description
NWP_OH_CHEMISTRY.run Short example for simplified oh chemistry
NWP_GASPHASE.run Example for MECCA chemistry based on https://gmd.copernicus.org/articles/11/4043/2018/
NWP_LIFETIME.run Example for parameterized chemtracer chemistry including lifetime, simnoy, linoz and passive tracers, as well as regional tracers and PSCs
NWP_EXT_DATA.run tbd
NWP_LIFETIME_lart.run tbd
NATAERO_NORAD.run tbd
VOLAERO_RAD.run tbd

Running a Job

For a user who succeeded in running the ICON model, there are only a few steps to run the ART extension along with the ICON model. A description how to run the ICON model can be found in .

In order to run ICON-ART, one has to do the following steps:

  • Make sure you have everything required for an ICON run
  • Prepare the input data (see section Input )
  • Inside the runscript in the namelist run_nml, set the main switch for ICON-ART to true: lart = .true.
  • Add a namelist art_nml and choose the namelist parameters for the ART setup as described in Input.
  • Adapt the XML files for tracers, emi. The number of tracers related to a specific setup is equal to the number of possible prognostic output fields as described in Input.
  • Add an output namelist as described in for the species you are interested in Input.
  • Submit the job analogous to an ICON job.