= List of parameters for Palmplot =
[[TracNav(doc/app/datatoc|nocollapse)]]

The following lists give an overview of all existing parameters to steer `palmplot`, 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_pr|file_2]], ..., up to [[#file_6_pr|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 [#Commonparameters common for all four scripts]
* Parameters for plotting [#Parametersforplottingcrosssections cross sections]
* Parameters for plotting [#Parametersforplottingprofiles profiles]
* Parameters for plotting [#Parametersforplottingspectra spectra]
* Parameters for plotting [#Parametersforplottingtimeseries 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 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 style="vertical-align:top;width: 800px"
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 exists. First cyclic number can be set with the parameter [[#start_f|start_f]].
}}}
|----------------
{{{#!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''. First time step can be set with [[#start_time_step|start_time_step]].
}}}
|----------------
{{{#!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. 

If there is more than one file for all time steps of a job chain, declare path and file name without cycle number and ".nc" (e.g. file_1='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr'). First and last cycle numbers are given with the parameters [[#start_f|start_f]] and [[#end_f|end_f]], otherwise declare path and full file name (e.g. file_1='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr.nc' ).
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#file_config '''file_config''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"$PALM_BIN/../../.ncl.config" or "$PALM_BIN/NCL/.ncl.config.default"
}}}
{{{#!td
Path and name of the NCL configuration file.

If this parameter is omitted, palmplot will first try to load {{{$PALM_BIN/../../.ncl.config}}}. If that file does not exist, palmplot tries to load the default configuration file {{{$PALM_BIN/NCL/.ncl.config.default}}}.
}}}
|----------------
{{{#!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. The output format of the file can be chosen with [[#format_out|format_out]].
}}}
|----------------
{{{#!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. The name and path of the output file can be chosen with [[#file_out|file_out]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_columns '''no_columns''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1 \\ except for [[#no_rows_pr|profiles]]
}}}
{{{#!td
Number of plots in one row. Number of plots in one columns can be set with [[#no_rows|no_rows]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_rows '''no_rows''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
2 \\ except for [[#no_columns_pr|profiles]]
}}}
{{{#!td
Number of plots in one column. Number of plots in one row can be set with [[#no_columns|no_columns]].
}}}
|----------------
{{{#!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 exists. Last cyclic number can be set with the parameter [[#end_f|end_f]]. 
}}}
|----------------
{{{#!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''. Last time step can be set with [[#end_time_step|end_time_step]].
}}}
|----------------
{{{#!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#Using.ncl.config|.ncl.config]].
}}}

\\\\

== 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 style="vertical-align:top;width:800px"
Explicit setting of the axes is switched of with '''axes_explicit''' = 0 and can be switched on by using the value '''axes_explicit''' = 1. When switched on, the parameters [[#major_ticks_x_cs|major_ticks_x]], [[#major_ticks_y_cs|major_ticks_y]], [[#norm_x_cs|norm_x]], [[#norm_y_cs|norm_y]], [[#norm_z_cs|norm_z]], [[#unit_x_cs|unit_x]], [[#unit_y_cs|unit_y]] and [[#unit_z_cs|unit_z]] can be set.
}}}
|----------------
{{{#!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"
[=#norm_x_cs '''norm_x''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
Setting of '''norm_x''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and normalizes the x-axis with the given value. '''norm_x''' = 1.0 results in no normalization. The resulting unit of the axis can be set explicitly with [[#unit_x_cs|unit_x]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_y_cs '''norm_y''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
Setting of '''norm_y''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and normalizes the y-axis with the given value. '''norm_y''' = 1.0 results in no normalization. The resulting unit of the axis can be set explicitly with [[#unit_y_cs|unit_y]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_z_cs '''norm_z''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
Setting of '''norm_z''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and normalizes the z-axis with the given value. '''norm_z''' = 1.0 results in no normalization. The resulting unit of the axis can be set explicitly with [[#unit_z_cs|unit_z]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#plotvec_cs '''plotvec''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"plotvec"
}}}
{{{#!td
Setting of '''plotvec''' is only possible if the vector plot is switched on: [[#vector_cs|vector]] = 1. '''plotvec''' can contain a list of variables on which the vector plot shall be overlaid. For example, if the vector plot shall be overlaid to pt and w, use '''plotvec''' = 'pt w' in the prompt and plotvec=",pt,w," in [[../ncl#Using.ncl.config|.ncl.config]]. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#ref_mag_cs '''ref_mag''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
0.05
}}}
{{{#!td
Length of the reference vector in a vector plot in height of [[http://www.ncl.ucar.edu/Document/Graphics/ndc.shtml|NDC]] coordinates. Setting is only possible with vector plot switched on: [[#vector_cs|vector]] = 1 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#shape_cs '''shape_cs''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
Aspect ratio of the plot is kept with '''shape''' = 1 and not kept with '''shape''' = 0.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#sort_cs '''sort''']
}}}
{{{#!td style="vertical-align:top"
string
}}}
{{{#!td style="vertical-align:top"
"layer"
}}}
{{{#!td
Type of the sorting of the plots. If '''sort''' = "layer" the plots are sorted by height and if '''sort''' = "time" the plots are sorted by time.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_x_cs '''unit_x''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
Setting of '''unit_x''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and useful if a normalization of the axis is used (see [[#norm_x_cs|norm_x]]). The default unit is ''meter''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_y_cs '''unit_y''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
Setting of '''unit_y''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and useful if a normalization of the axis is used (see [[#norm_y_cs|norm_y]]). The default unit is ''meter''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_z_cs '''unit_z''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
Setting of '''unit_z''' is only possible if [[#axes_explicit_cs|axes_explicit]] = 1 and useful if a normalization of the axis is used (see [[#norm_z_cs|norm_z]]). The default unit is ''meter''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#vector_cs '''vector''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
By default, no vector plots are produced with '''vector''' = 0. Vector plots can be switched on with '''vector''' = 1. Then, the setting of the components for the vector plot is required. A plot of horizontal wind vectors can be achieved by [[#vec1_cs|vec1]]='u' in the prompt and  [[#vec1_cs|vec1]]=",u," in [[../ncl#Using.ncl.config|.ncl.config]] and [[#vec2_cs|vec2]]='v' or [[#vec2_cs|vec2]]=",v,". Further on, the vector plot can be overlaid on other plots by using [[#plotvec_cs|plotvec]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#vec1_cs '''vec1''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"component1"
}}}
{{{#!td
First component for the vector plot. Setting is only possible with vector plot switched on: [[#vector_cs|vector]] = 1. By using [[#vec1_cs|vec1]]='u' in the prompt and [[#vec1_cs|vec1]]=",u," in [[../ncl#Using.ncl.config|.ncl.config]] for example, the first component of the vector plot is the wind component in x-direction.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#vec2_cs '''vec2''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"component2"
}}}
{{{#!td
Second component for the vector plot. Setting is only possible with vector plot switched on: [[#vector_cs|vector]] = 1. By using [[#vec2_cs|vec2]]='w' in the prompt and [[#vec2_cs|vec2]]=",w," in [[../ncl#Using.ncl.config|.ncl.config]] for example, the second component of the vector plot is the wind component in z-direction.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#xe_cs '''xe''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (last avail-\\able value)
}}}
{{{#!td
Value for maximum of the x-axis which is only selectable if there are no preset layers for x. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The minimum value of the x-axis can be set with [[#xs_cs|xs]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#xs_cs '''xs''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (first avail-\\able value)
}}}
{{{#!td
Value for minimum of the x-axis which is only selectable if there are no preset layers for x. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The maximum value of the x-axis can be set with [[#xe_cs|xe]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#ye_cs '''ye''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (last avail-\\able value)
}}}
{{{#!td
Value for maximum of the y-axis which is only selectable if there are no preset layers for y. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The minimum value of the y-axis can be set with [[#ys_cs|ys]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#ys_cs '''ys''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d (first avail-\\able value)
}}}
{{{#!td
Value for minimum of the y-axis which is only selectable if there are no preset layers for y. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The maximum value of the x-axis can be set with [[#ye_cs|ye]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#ze_cs '''ze''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1 (last avail-\\able value)
}}}
{{{#!td
Value for maximum of the z-axis which is only selectable if there are no preset layers for z. The value has to be given as index value of the vertical grid due to possible grid stretching. The minimum value of the z-axis can be set with [[#zs_cs|zs]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#zs_cs '''zs''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1 (first avail-\\able value)
}}}
{{{#!td
Value for minimum of the z-axis which is only selectable if there are no preset layers for z. The value has to be given as index value of the vertical grid due to possible grid stretching. The maximum value of the z-axis can be set with [[#ze_cs|ze]].
}}}
|----------------

\\\\

== Parameters for plotting profiles
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width: 150px"
[=#black_pr '''black''']
}}}
{{{#!td style="vertical-align:top;width: 50px"
I
}}}
{{{#!td style="vertical-align:top;width: 120px"
0
}}}
{{{#!td style="vertical-align:top;width: 800px"
The default setting '''black''' = 0 leads to colored lines in the plot and '''black''' = 1 results in black and white plots.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#combine_pr '''combine''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
Combining of several individual variables in one plot is switched on with '''combine''' = 1. The number of combined variables has to be set in [[#number_comb_pr|number_comb]]. And the variables have to be specified in [[#c_var_pr|c_var]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#c_var_pr '''c_var''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"c_variables"
}}}
{{{#!td
List of variables that shall be plotted in a combined plot. This setting is only available when [[#combine_pr|combine]] = 1. The list must contain [[#number_comb_pr|number_comb]] entries. If a combination of u,v and w is desired, set '''c_var''' = 'u v w' in the prompt or '''c_var''' = ",u,v,w," in [[../ncl#Using.ncl.config|.ncl.config]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dash_pr '''dash''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
The use of dashed lines in the plots can be switched on with '''dash''' = 1. The default '''dash''' = 0 leads to continuous lines.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#end_f_2_pr '''end_f_2''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
'''end_f_2''' is only used when [[#no_files_pr|no_files]] > 1 and denotes the last cyclic number of data from a job chain that shall be used for input of [[#file_2_pr|file_2]]. Setting of '''end_f_2''' \= -1 is only useful when more than one file of a job chain exists. The first cyclic number can be set with the parameter [[#start_f_2_pr|start_f_2]].
}}}
|----------------
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td
.\\
.\\
.\\
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#end_f_6_pr '''end_f_6''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
'''end_f_6''' is only used when [[#no_files_pr|no_files]] > 1 and denotes the last cyclic number of data from a job chain that shall be used for input of [[#file_6_pr|file_6]]. Setting of '''end_f_6''' \= -1 is only useful when more than one file of a job chain exists. The first cyclic number can be set with the parameter [[#start_f_6_pr|start_f_6]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#end_x_pr '''end_x''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
If 3D data ([[../iofiles#DATA_3D_NETCDF|DATA_3D_NETCDF]] or [[../iofiles#DATA_3D_AV_NETCDF|DATA_3D_AV_NETCDF]]) is used as input, '''end_x''' denotes the last grid point which is included in averaging along the x-axis in ''grid points''. The default '''end_x''' = -1 uses all grid points in x-direction for averaging. The first grid point for averaging can be set via [[#star_x_pr|start_x]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#end_y_pr '''end_y''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
If 3D data ([[../iofiles#DATA_3D_NETCDF|DATA_3D_NETCDF]] or [[../iofiles#DATA_3D_AV_NETCDF|DATA_3D_AV_NETCDF]]) is used as input, '''end_y''' denotes the last grid point which is included in averaging along the y-axis in ''grid points''. The default '''end_y''' = -1 uses all grid points in y-direction for averaging. The first grid point for averaging can be set via [[#star_y_pr|start_y]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#file_2_pr '''file_2''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"File in"
}}}
{{{#!td
Path and name of the second input file. Declaring of '''file_2''' is only allowed if [[#no_files_pr|no_files]] > 1.

If there is more than one file for all time steps of a job chain, declare path and file name without cycle number and ".nc" (e.g. file_2='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr'). First and last cycle numbers are given with the parameters [[#start_f|start_f]] and [[#end_f|end_f]], otherwise declare path and full file name (e.g. file_2='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr.nc' ).
}}}
|----------------
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td
.\\
.\\
.\\
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#file_6_pr '''file_6''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"File in"
}}}
{{{#!td
Path and name of the sixth input file. Declaring of '''file_6''' is only allowed if [[#no_files_pr|no_files]] > 1.

If there is more than one file for all time steps of a job chain, declare path and file name without cycle number and ".nc" (e.g. file_6='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr'). First and last cycle numbers are given with the parameters [[#start_f|start_f]] and [[#end_f|end_f]], otherwise declare path and full file name (e.g. file_6='~/palm/current_version/JOBS/example_cbl/OUTPUT/example_cbl_pr.nc' ).
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#font_size_legend_pr '''font_size_legend''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
0.02
}}}
{{{#!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"
[=#log_z_pr '''log_z''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
A logarithmic scaling of the z-axis can be switched on with '''log_z''' = 1. The default setting '''log_z''' = 0 results in a linear z-axis.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#max_z_pr '''max_z''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d
}}}
{{{#!td
Value for maximum of the z-axis. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The default value '''max_z''' = -1.0d uses the last available grid point. The minimum value of the z-axis can be set with [[#min_z_pr|min_z]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#min_z_pr '''min_z''']
}}}
{{{#!td style="vertical-align:top"
D
}}}
{{{#!td style="vertical-align:top"
-1.0d
}}}
{{{#!td
Value for minimum of the z-axis. The value has to be given in ''meter'' which is rounded internally to the next existent grid point on the file. The default value '''min_z''' = -1.0d uses the first available grid point. The maximum value of the z-axis can be set with [[#max_z_pr|max_z]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#name_legend_1_pr '''name_legend_1''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"File 1"
}}}
{{{#!td
Label for the first item corresponding to the first input file which is placed in an extra legend (see also [[#no_files_pr|no_files]]). Declaring of '''name_legend_1''' is only allowed if [[#no_files_pr|no_files]] > 1.
}}}
|----------------
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td
.\\
.\\
.\\
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#name_legend_6_pr '''name_legend_6''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"File 6"
}}}
{{{#!td
Label for the sixth item corresponding to the sixth input file which is placed in an extra legend (see also [[#no_files_pr|no_files]]). Declaring of '''name_legend_6''' is only allowed if [[#no_files_pr|no_files]] > 1.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_columns_pr '''no_columns''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
If '''no_columns=-1''', [wiki:doc/app/d3par#profile_columns profile_columns] will be used.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_rows_pr '''no_rows''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
If '''no_rows=-1''', [wiki:doc/app/d3par#profile_rows profile_rows] will be used.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#no_files_pr '''no_files''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
The number of different files which shall be plotted together is set via '''no_files'''. Not more than six different files can be used. All the files must contain the same variables and dimensionality and identical variables are merged in one plot. The path and name of the additional files is set with the parameters [[#file_2_pr|file_2]], ..., [[#file_6_pr|file_6]]. It is also possible to use files of a job chain which can be declared with [[#start_f_2_pr|start_f_2]], ..., [[#start_f_6_pr|start_f_6]] and [[#end_f_2_pr|end_f_2]], ... , [[#end_f_6_pr|end_f_6]]. It is not possible to combine variables: [[#combine_pr|combine]] is automatically switched off. Further on, the overlaying of predefined variables is also not possible: [[#over_pr|over]] = 0. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_z_pr '''norm_z''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
The z-axis is normalized with the given value. By default, no normalizing occurs.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#number_comb_pr '''number_comb''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
The number of variables for combining is given with '''number_comb'''. The maximum number of combined variables is 3. Consequently, only '''number_comb''' = 2 or '''number_comb''' = 3 are valid values. Overall, the setting of '''number_comb''' is only possible if [[#combine_pr|combine]] = 1.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#over_pr '''over''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
The predefined overlaying of special variables can be switched on with '''over''' = 1. But this feature can not be used if the input file contains output for [../initialization_parameters#statistic_regions statistic regions]. The default '''over''' = 0 results in no overlaying.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_f_2_pr '''start_f_2''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
'''start_f_2''' is only used when [[#no_files_pr|no_files]] > 1 and denotes the first cyclic number of data from a job chain that shall be used for input of [[#file_2_pr|file_2]]. Setting of '''start_f_2''' \= -1 is only useful when more than one file of a job chain exists. The last cyclic number can be set with the parameter [[#end_f_2_pr|end_f_2]].
}}}
|----------------
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td style="vertical-align:top"
.\\
.\\
.\\
}}}
{{{#!td
.\\
.\\
.\\
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_f_6_pr '''start_f_6''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
'''start_f_6''' is only used when [[#no_files_pr|no_files]] > 1 and denotes the first cyclic number of data from a job chain that shall be used for input of [[#file_6_pr|file_6]]. Setting of '''start_f_6''' \= -1 is only useful when more than one file of a job chain exists. The last cyclic number can be set with the parameter [[#end_f_6_pr|end_f_6]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_x_pr '''start_x''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
If 3D data ([[../iofiles#DATA_3D_NETCDF|DATA_3D_NETCDF]] or [[../iofiles#DATA_3D_AV_NETCDF|DATA_3D_AV_NETCDF]]) is used as input, '''start_x''' denotes the first grid point which is included in averaging along the x-axis in ''grid points''. The default '''start_x''' = 0 uses the first available grid point in x-direction for averaging. The last grid point for averaging can be set via [[#end_x_pr|end_x]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#start_y_pr '''start_y''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
If 3D data ([[../iofiles#DATA_3D_NETCDF|DATA_3D_NETCDF]] or [[../iofiles#DATA_3D_AV_NETCDF|DATA_3D_AV_NETCDF]]) is used as input, '''start_y''' denotes the first grid point which is included in averaging along the y-axis in ''grid points''. The default '''start_y''' = 0 uses the first available grid point in y-direction for averaging. The last grid point for averaging can be set via [[#end_y_pr|end_y]].
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#time_stride_pr '''time_stride''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
'''time_stride''' denotes the temporal stride for the plot. If '''time_stride''' = 1 all the profiles between [[#start_time_step|start_time_step]] and [[#end_time_step|end_time_step]] are plotted (including [[#start_time_step|start_time_step]] and [[#end_time_step|end_time_step]]). If '''time_stride''' = 3 every third time step between [[#start_time_step|start_time_step]] and [[#end_time_step|end_time_step]] is plotted.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#var_pr '''var''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"cross_profiles"
}}}
{{{#!td
If '''var''' = "cross_profiles", all profiles are plotted as defined in [wiki:doc/app/d3par#cross_profiles cross_profiles]. If '''var''' = "all", each profile will be plotted solitary (this is recommended for plotting a high amount of profiles).
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#xe_pr '''xe''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
-1.0
}}}
{{{#!td
Value for maximum of the x-axis in the plot. When the default value '''xe''' = -1.0 is used the maximum value of the data is taken. The minimum value of the x-axis can be set with [[#xs_pr|xs]]. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#xs_pr '''xs''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
-1.0
}}}
{{{#!td
Value for minimum of the x-axis in the plot. When the default value '''xs''' = -1.0 is used the minimum value of the data is taken. The maximum value of the x-axis can be set with [[#xe_pr|xe]]. 
}}}
|----------------

\\\\

== Parameters for plotting spectra
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width: 150px"
[=#black_sp '''black''']
}}}
{{{#!td style="vertical-align:top;width: 50px"
I
}}}
{{{#!td style="vertical-align:top;width: 120px"
0
}}}
{{{#!td style="vertical-align:top;width: 800px"
The default setting '''black''' = 0 leads to colored lines in the plot and '''black''' = 1 results in black and white plots.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dash_sp '''dash''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
The use of dashed lines in the plots can be switched on with '''dash''' = 1. The default '''dash''' = 0 leads to continuous lines.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#font_size_legend_sp '''font_size_legend''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
0.02
}}}
{{{#!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"
[=#height_level_sp '''height_level''']
}}}
{{{#!td style="vertical-align:top"
I(0:99)
}}}
{{{#!td style="vertical-align:top"
-1
}}}
{{{#!td
The default '''height_level''' = -1 leads to the plot of all the height levels which are in the file. A sample of several height levels can be chosen by '''height_level''' = (/0,3,5/) for example. In this case, the first, fourth and sixth height level in the file are taken. Note that the height levels have to be given as indices and that the first index of an array is 0 in NCL. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#log_x_sp '''log_x''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
The logarithmic scaling of the x-axis can be switched off with '''log_x''' = 0. The default setting '''log_x''' = 1 results in a logarithmic x-axis.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#log_y_sp '''log_y''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
1
}}}
{{{#!td
The logarithmic scaling of the y-axis can be switched off with '''log_y''' = 0. The default setting '''log_y''' = 1 results in a logarithmic y-axis.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_height_sp '''norm_height''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
The x-axis can be normalized with the height of each spectrum with the setting '''norm_height''' = 1. The default setting '''norm_height''' = 0 leads to no normalizing. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_x_sp '''norm_x''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
The setting of '''norm_x''' normalizes the x-axis with the assigned value, for example '''norm_x''' = 10.0. The unit of the x-axis can then be set appropriately with [[#unit_x_sp|unit_x]]. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#norm_y_sp '''norm_y''']
}}}
{{{#!td style="vertical-align:top"
F
}}}
{{{#!td style="vertical-align:top"
1.0
}}}
{{{#!td
The setting of '''norm_y''' normalizes the y-axis with the assigned value, for example '''norm_y''' = 10.0. The unit of the y-axis can then be set appropriately with [[#unit_y_sp|unit_y]]. 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#sort_sp '''sort''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
"height"
}}}
{{{#!td
'''sort''' = "height" leads to plots in which all the height levels are merged. The other possibility is '''sort''' = "time". Then, all time steps are merged in one plot.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_x_sp '''unit_x''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
The unit of the x-axis can be set with '''unit_x''' if [[#norm_x_sp|norm_x]] is set unequal to 1.0. The default unit on the x-axis is ''1/m''.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_y_sp '''unit_y''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
The unit of the y-axis can be set with '''unit_y'''. By default no unit is set for the y-axis.
}}}
|----------------

\\\\

== Parameters for plotting timeseries
||='''Parameter Name'''  =||='''[#NCL_types NCL]\\[#NCL_types Type]'''  =||='''Default\\Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width: 150px"
[=#norm_t_ts '''norm_t''']
}}}
{{{#!td style="vertical-align:top;width: 50px"
F
}}}
{{{#!td style="vertical-align:top;width: 120px"
1.0
}}}
{{{#!td style="vertical-align:top;width: 800px"
The setting of '''norm_t''' normalizes the x-axis (time) with the assigned value, for example '''norm_t''' = 3600.0. The unit of the x-axis can then be set appropriately with [[#unit_t_ts|unit_t]]. The default setting leads to no normalization.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#over_ts '''over''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
0
}}}
{{{#!td
The predefined overlaying of special variables can be switched on with '''over''' = 1. But this feature can not be used if the input file contains output for [../initialization_parameters#statistic_regions statistic regions]. The default '''over''' = 0 results in no overlaying.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#unit_t_ts '''unit_t''']
}}}
{{{#!td style="vertical-align:top"
S
}}}
{{{#!td style="vertical-align:top"
" "
}}}
{{{#!td
The unit of the x-axis (time) can be set with '''unit_t''' if [[#norm_t_ts|norm_t]] is set unequal to 1.0. The default unit on the x-axis is ''s''.
}}}
|----------------