== List of parameters for PALM NCL scripts ==
[[TracNav(doc/app/ncltoc)]]
The following lists give an overview of all existing parameters to steer the PALM NCL scripts. Further descriptions can be found in the configuration file [[source:palm/trunk/SCRIPTS/NCL/.ncl.config.default|.ncl.config.default]].\\
Most parameters are allocated with a suitable default value in the configuration file but some need to be changed before running any script. These variables are [[#file_1|file_1]] and if available [[#file_2|file_2]], ..., up to [[#file_6|file_6]].\\
In case of a job chain without extended output files, the scripts will automatically read all necessary files after indicating the first and the last cyclic number (see [[#start_f|start_f]] and [[#end_f|end_f]]).\\\\
The parameters are arranged in five different lists: 
* Parameters which are [[#common|common]] for all the four existing scripts 
* Parameters for output of [[#cross_sections|cross sections]]
* Parameters for output of [[#profiles|profiles]]
* Parameters for output of [[#spectra|spectra]]
* Parameters for output of [[#timeseries|timeseries]]
The following abbreviations for the NCL types are used in the lists: [=#NCL_types ]
||=Abbr.  =||=Explanation  =||=Example =||
||D  ||double   ||2.0d    || 
||F  ||float    ||2.0     ||
||I  ||integer  ||2       || 
||S  ||string   ||"name"  ||
The following abbreviations for the NCL scripts are used in the lists:
||=Abbr.  =||=Explanation  =||
||CS  ||cross sections  ||   
||PR  ||profiles  || 
||SP  ||spectra  || 
||TS  ||timeseries  || 
\\
[=#common '''Common parameters''']
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width: 150px"
[=#end_f '''end_f''']
}}}
{{{#!td style="vertical-align:top;width: 50px"
I
}}}
{{{#!td style="vertical-align:top;width: 120px"
-1
}}}
{{{#!td
Last cyclic number of data from a job chain that shall be used for input.\\
Setting of '''end_f''' \= -1 is only useful when more than one file of a job chain exist.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#end_time_step '''end_time_step''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (last avail-\\able time step)
}}}
{{{#!td
Last time step in ''hour''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#file_1 '''file_1''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"File in"
}}}
{{{#!td
Path and name of the input file.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#file_out '''file_out''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"~/test_!**"
}}}
{{{#!td
Path and name of the output file.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#font_size '''font_size''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
0.04 (CS)\\
0.02 (PR+SP)\\
0.07 (TS)
}}}
{{{#!td
Font size of the strings in the plots in height of [[http://www.ncl.ucar.edu/Document/Graphics/ndc.shtml|NDC]] coordinates.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#format_out '''format_out''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"x11"
}}}
{{{#!td
Format of the output file. Supported file formats \\are: x11, pdf, ps, eps, epsi ncgm or png. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_columns '''no_columns''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
Number of plots in one row.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_rows '''no_rows''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
2
}}}
{{{#!td
Number of plots in one column. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_f '''start_f''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
First cyclic number of data from a job chain that shall be used for input.\\
Setting of '''start_f''' \= -1 is only useful when more than one file of a job chain exist. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_time_step '''start_time_step''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (first avail-\\able time step)
}}}
{{{#!td
First time step in ''hour''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#var '''var''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"all"
}}}
{{{#!td
Names of variables in the input file that shall be output. For output of u, v and w"pt" \\
use '''var''' = 'u v w"pt"' in the prompt or '''var''' = ",u,v,w"+dq+"pt"+dq}}} in '''.ncl.config'''.
}}}
\\
[=#cross_sections '''Parameters for plotting cross sections''']
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width:150px"
[=#axes_explicit_cs '''axes_explicit''']
}}}
{{{#!td style="vertical-align:top;width:50px"
I
}}}
{{{#!td style="vertical-align:top;width:120px"
0
}}}
{{{#!td
Explicit setting of the axes is switched of with '''axes_explicit''' = 0 and\\
can be switched on by using the value '''axes_explicit''' = 1. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#fill_mode_cs '''fill_mode''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"!RasterFill"
}}}
{{{#!td
Type of filling of the contour plots. Further possibilities are '''fill_mode''' = "!AreaFill" and '''fill_mode''' = "!CellFill".\\
In case of a large data set, setting of '''fill_mode''' = "!AreaFill" leads to a long execution time of the script.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#font_size_legend_cs '''font_size_legend''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
0.04
}}}
{{{#!td
Font size of legend strings in height of [[http://www.ncl.ucar.edu/Document/Graphics/ndc.shtml|NDC]] coordinates.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#legend_label_stride_cs '''legend_label_stride''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
2
}}}
{{{#!td
With '''legend_label_stride''' = 2 every second label is displayed.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#major_ticks_x_cs '''major_ticks_x''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
6
}}}
{{{#!td
Setting of '''major_ticks_x''' is only used if [[#axes_explicit_cs|axes_explicit]] = 1 and indicates \\
the number of major tick marks at the x-axis.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#major_ticks_y_cs '''major_ticks_y''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
6
}}}
{{{#!td
Setting of '''major_ticks_y''' is only used if [[#axes_explicit_cs|axes_explicit]] = 1 and indicates \\
the number of major tick marks at the y-axis.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#mode_cs '''mode''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"Fill"
}}}
{{{#!td
Type of plot. '''mode''' = "Fill" leads to contour plots, '''mode''' = "Line" results in an isoline plot \\
and '''mode''' = "Both" is a combination of the aforementioned types. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
[=#profiles '''Parameters for plotting profiles''']
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||

{{{#!td style="vertical-align:top;width: 150px"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top;width: 50px"
platz
}}}
{{{#!td style="vertical-align:top;width: 120px"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
[=#spectra '''Parameters for plotting spectra''']
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
[=#timeseries '''Parameters for plotting timeseries''']
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#platz '''platz''']
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td style="vertical-align:top"
platz
}}}
{{{#!td
platz
}}}
|----------------