Input: Difference between revisions

From icon-art guide
Jump to navigation Jump to search
(added input names figure)
(Restructured contents, moved art namelist parameters table from Input to Namelist (added link) , added placeholders for generating and downloading input data data)
Line 3: Line 3:
== Requirements for a Simulation ==
== Requirements for a Simulation ==


To run a Simulation with ICON-ART there are three main points to consider: Setting the namelist parameters, preparing the xmls, and optionally prepare additional Input data.
To run a simulation with ICON-ART installed the first thing to prepare is the runfile. It is usually best to start with an existing and working runfile and adapt parts as needed. The runfile contains the majority of parameters to run a simulation, like the length, timesteps and grids used, as well as a variety of options for methods and parametrisations used in the model. The runfile contents are then split up in several namelists that the model reads at the beginning of a simulation. An overview of the Namelist Parameters can be found in chapter [[#chap:namelist|[chap:namelist]]].

== Namelist Inputs ==

To run a simulation with ICON-ART installed the first thing to prepare is the runfile. It is usually best to start with an existing and working runfile and adapt parts as needed. The runfile contains the majority of parameters to run a simulation, like the length, timesteps and grids used, as well as a variety of options for methods and parametrisations used in the model. The runfile contents are then split up in several namelists that the model reads at the beginning of a simulation. An overview of the Namelist Parameters can be found in [[Namelist]].


To enable ART in an ICON simulation, the switch <code>lart = .TRUE.</code> has to be set in the section <code>&amp;run_nml</code>. This is the global on/off switch for ICON-ART. This is how this could look like in the context of a runfile:
To enable ART in an ICON simulation, the switch <code>lart = .TRUE.</code> has to be set in the section <code>&amp;run_nml</code>. This is the global on/off switch for ICON-ART. This is how this could look like in the context of a runfile:
Line 36: Line 40:


</div>
</div>
The namelist <code>&amp;art_nml</code> is used for general options of the ART simulation. To run a certain kind of simulation the according switch has to be set to <code>.TRUE.</code>. For Example to include a point source the switch <code>cart_aerosol_xml</code> has to be set to <code>.TRUE.</code>. This enables the inclusion of a .xml file containing additional information like location and strength of the point source. Table [[#tab:art_nml-params|1.6]] contains the most important <code>&amp;art_nml</code> namelist parameters and additional namelist parameters required if they are set to <code>.TRUE.</code>.
The namelist <code>&amp;art_nml</code> is used for general options of the ART simulation. To run a certain kind of simulation the according switch has to be set to <code>.TRUE.</code>. For Example to include a point source the switch <code>cart_aerosol_xml</code> has to be set to <code>.TRUE.</code>.

== XML Inputs ==

This enables the inclusion of a .xml file containing additional information like location and strength of the point source. Table [[#tab:art_nml-params|1.6]] contains the most important <code>&amp;art_nml</code> namelist parameters and additional namelist parameters required if they are set to <code>.TRUE.</code>.


<div id="tab:art_nml-params">
<div id="tab:art_nml-params">
Line 85: Line 93:


</div>
</div>
The reason for the use of those additional .xml files is that the ART variables (sea salt, mineral dust etc.) they contain might be different for every run which differs from the Icon Variables (Temperature, Pressure, etc.) which usually don’t change between runs. .xml files are readable for both humans and machines, which makes them easy to tweak and integrate. An Example for the contents of an .xml file adding ash particles can be seen below.
The reason for the use of those additional .xml files is that the ART variables they contain (sea salt, mineral dust etc.) might be different for every run which differs from the Icon Variables (Temperature, Pressure, etc.) which usually don’t change between runs. .xml files are readable for both humans and machines, which makes them easy to tweak and integrate. An Example for the contents of an .xml file adding ash particles can be seen below.


<pre>&lt;modes&gt;
<pre>&lt;modes&gt;
Line 97: Line 105:
Further .xml examples can be fount in <code>/your_ART_Directory/runctrl_examples/xml_ctrl. </code>
Further .xml examples can be fount in <code>/your_ART_Directory/runctrl_examples/xml_ctrl. </code>


==== Additional Input Data ====
== Input Data ==



Depending on the type of simulation there might be additional input files required. These are essential files that are not contained in classical ICON initialisation data. For example for the emission of mineral dust there has to be information about the soil types supplied to the model. The additional input files should be renamed to a netcdf file and follow the naming convention shown in fig [[#input-names|1.1]]. Please note that the XXX has to be replaced by one of the indices mentionend in Table [[#tab:input-init|1.3]] and [[#tab:input-emissions|1.4]].
Depending on the type of simulation there might be additional input files required. These are essential files that are not contained in classical ICON initialisation data. For example for the emission of mineral dust there has to be information about the soil types supplied to the model. The additional input files should be renamed to a netcdf file and follow the naming convention shown in fig [[#input-names|1.1]]. Please note that the XXX has to be replaced by one of the indices mentionend in Table [[#tab:input-init|1.3]] and [[#tab:input-emissions|1.4]].
Line 158: Line 167:
|}
|}


=== Obtaining Input Data ===


The 2 ways of obtaining input data are to generate it yourself or download it.
</div>
<div id="tab:namelist">


[[How to generate input data]]
{| class="wikitable" style="margin:auto"
|+ Art namelist parameters
! '''Name'''
! '''function'''
|-
| '''General Variables'''
|
|-
| <code>cart_input_folder</code>
| Absolute Path to ART source code
|-
| <code>iart_init_aero</code>
| Initialization of aerosol species
|-
| <code>iart_init_gas</code>
| Initialization of gaseous species
|-
| <code>lart_diag_out</code>
| Enable output of diagnostic fields
|-
| <code>lart_pntSrc</code>
| Enables point sources
|-
| <code>lart_emiss_turbdiff</code>
| Switch if emissions should be included as surface flux condition
|-
| <code>cart_io_suffix</code>
| user given suffix instead of automatically generated grid number
|-
| '''Atmospheric Chemistry'''
|
|-
| <code>lart_chem</code>
| Main switch to enable chemistry
|-
| <code>lart_chemtracer</code>
| Switch for parametrised chemtracers
|-
| <code>lart_mecca</code>
| Switch for MECCA chemistry
|-
| <code>lart_psc</code>
| Switch for computation of PSCs
|-
| <code>cart_vortex_init_date</code>
| Date of vortex initialization
|-
| <code>cheminit_file(max_dom)</code>
| Path to chemical initialization file
|-
| <code>cart_cheminit_coord</code>
| Path to chemical initialization coordinate file
|-
| <code>cart_cheminit_type</code>
| Type of chemical initialization coordinate file
|-
| '''XML configuration'''
|
|-
| <code>cart_chemtracer_xml</code>
| Path to XML file for parametrised chemtracers
|-
| <code>cart_mecca_xml</code>
| Path to XML file for MECCA tracers
|-
| <code>cart_aerosol_xml</code>
| Path to XML file for aerosol tracers
|-
| <code>cart_modes_xml</code>
| Path to XML file for modes
|-
| <code>cart_pntSrc_xml</code>
| Path to XML file for point sources
|-
| <code>cart_diagnostics_xml</code>
| Path to XML file for aerosol diagnostics
|-
| <code>cart_emiss_xml_file</code>
| Path and file name of the xml files for emission metadata
|-
| <code>cart_ext_data_xml</code>
| Path to XML file for metadata of datasets prescribing tracers
|-
| '''Atmospheric Aerosol'''
|
|-
| <code>lart_aerosol </code>
| Main switch for the treatment of atmospheric aerosol
|-
| <code>iart_seasalt </code>
| Treatment of sea salt aerosol
|-
| <code>iart_dust </code>
| Treatment of mineral dust aerosol
|-
| <code>iart_anthro</code>
| Treatment of anthropogenic aerosol
|-
| <code>iart_fire </code>
| Treatment of wildfire aerosol
|-
| <code>iart_volcano </code>
| Treatment of volcanic ash aerosol
|-
| <code>iart_nonsph</code>
| Treatment of nonspherical particles
|-
| <code>iart_pollen </code>
| Treatment of pollen
|-
| <code>iart_radioact</code>
| Treatment of radioactive particles
|-
| <code>cart_volcano_file </code>
| Absolute path + filename of input file for volcanoes
|-
| <code>cart_radioact_file</code>
| Absolute path + filename of input for radioactive emissions
|-
| '''Feedback Processes'''
|
|-
| <code>iart_aci_warm </code>
| Nucleation of aerosol to cloud droplets
|-
| <code>iart_aci_cold </code>
| Nucleation of aerosol to cloud ice
|-
| <code>iart_ari </code>
| Direct interaction of aerosol with radiation
|}


[[How to download input data]]

</div>
<div id="tab:art_nml-params">

{| class="wikitable" style="margin:auto"
|+ General art_nml namelist switches and respective parameters.
! Namelist parameter
! Default
! Description
! If .TRUE. then needs
|-
| <code>iart_modeshift</code>
| 1
|
|
|}


</div>

Revision as of 08:58, 27 October 2022

Input

Requirements for a Simulation

To run a Simulation with ICON-ART there are three main points to consider: Setting the namelist parameters, preparing the xmls, and optionally prepare additional Input data.

Namelist Inputs

To run a simulation with ICON-ART installed the first thing to prepare is the runfile. It is usually best to start with an existing and working runfile and adapt parts as needed. The runfile contains the majority of parameters to run a simulation, like the length, timesteps and grids used, as well as a variety of options for methods and parametrisations used in the model. The runfile contents are then split up in several namelists that the model reads at the beginning of a simulation. An overview of the Namelist Parameters can be found in Namelist.

To enable ART in an ICON simulation, the switch lart = .TRUE. has to be set in the section &run_nml. This is the global on/off switch for ICON-ART. This is how this could look like in the context of a runfile: 

! run_nml: general switches ----------
&run_nml
 ltestcase = .FALSE.
 num_lev = 50
 ltransport = .TRUE.
.............

 \textcolor{red}{lart = .TRUE.}

Generally the first letters of a namelist switch refer to its type, the "l" in "lart" stands for logical, meaning it has to be either True or False. Table 1.1 lists some examples.

Some namelist switches and their data types.
namelist switch type
lart logical
cart_aerosol_xml character
iart_init_aero integer


The namelist &art_nml is used for general options of the ART simulation. To run a certain kind of simulation the according switch has to be set to .TRUE.. For Example to include a point source the switch cart_aerosol_xml has to be set to .TRUE..

XML Inputs

This enables the inclusion of a .xml file containing additional information like location and strength of the point source. Table 1.6 contains the most important &art_nml namelist parameters and additional namelist parameters required if they are set to .TRUE..
General art_nml namelist switches and respective parameters.
Namelist parameter Default Description If .TRUE. then needs
lart_chem .FALSE. Enables chemistry. lart_chemtracer = .TRUE.OR lart_mecca = .TRUE.
lart_chemtracer .FALSE. Switch for simple OH chemistry cart_chemtracer_xml
lart_mecca .FALSE. Switch for kpp chemistry cart_mecca_xml
lart_pntSrc .FALSE. Enables addition of point sources cart_pntSrc_xml
lart_aerosol .FALSE. Main switch for the treatment of cart_aerosol_xml
atmospheric aerosol. and cart_modes_xml
lart_diag_out .FALSE. Enables diagnostic output fields cart_diagnostics_xml


The reason for the use of those additional .xml files is that the ART variables they contain (sea salt, mineral dust etc.) might be different for every run which differs from the Icon Variables (Temperature, Pressure, etc.) which usually don’t change between runs. .xml files are readable for both humans and machines, which makes them easy to tweak and integrate. An Example for the contents of an .xml file adding ash particles can be seen below. 

<modes>
  <aerosol id="asha">
    <kind type="char">2mom</kind>
    <d_gn type="real">1.190E-6</d_gn>
    <sigma_g type="real">1.410E+0</sigma_g>
    <rho type="real">2.600E+3</rho>
  </aerosol>
</modes>

Further .xml examples can be fount in /your_ART_Directory/runctrl_examples/xml_ctrl.

Input Data

Depending on the type of simulation there might be additional input files required. These are essential files that are not contained in classical ICON initialisation data. For example for the emission of mineral dust there has to be information about the soil types supplied to the model. The additional input files should be renamed to a netcdf file and follow the naming convention shown in fig 1.1. Please note that the XXX has to be replaced by one of the indices mentionend in Table 1.3 and 1.4.

ICON-ART input file naming convention.
Additional input files for the initialisation
Species Namelist switch Options XXX
Gas iart_init_gas 0 (cold start), 5 (from file) IGX
Aerosol iart_init_aero 0 (cold start), 5 (from file) IAE


Additional input files for the emissions
Type Data XXX
Point souces XML-file -
Sea salt no extra data necessary -
Mineral Dust Soil Type Data ART_STY
Biogenic VOCs Emissions or Vegetatiom ART_STY
Athropogenic emissions Emission data sets ART_BIO ART_ANT
Biomass burning Satellite data ART_BCF

Obtaining Input Data

The 2 ways of obtaining input data are to generate it yourself or download it.

How to generate input data

How to download input data

Retrieved from "https://www.icon-art.kit.edu/userguide/index.php?title=Input&oldid=52"