DISPLAY HOVMOLLER STEER.DAT: Difference between revisions
From BAWiki
imported>Brodhagen Tabea (description of steering file for Display_hovmoller) |
imported>Brodhagen Tabea m (added key for new steering file) |
||
| Line 12: | Line 12: | ||
* information about the file input (block '''input''') | * information about the file input (block '''input''') | ||
** key "'''file'''" : path to folder containing the input data | ** key "'''file'''" : path to folder containing the input data | ||
** key "'''inputformat'''" : format of the input data ( | ** key "'''inputformat'''" : format of the input data (choose "xtrdata" for files that were created using [[XTRDATA]] or "netcdf" for profile oriented data that is stored in [[NetCDF]]-files) | ||
* information regarding the output (block '''output''') | * information regarding the output (block '''output''') | ||
** key "'''directory'''" : path to folder where plots will be saved (program can create this folder if it does not exist yet during runtime) | ** key "'''directory'''" : path to folder where plots will be saved (program can create this folder if it does not exist yet during runtime) | ||
** key "'''outputformat'''" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended | ** key "'''outputformat'''" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended | ||
** key "'''parameter'''" : name of the physical quantity that is plotted(choose "all" to plot all quantities or give the name of a quantity as it is given in the Xtrdata-output file) | ** key "'''parameter'''" : name of the physical quantity that is plotted(choose "all" to plot all quantities or give the name of a quantity as it is given in the Xtrdata-output file) | ||
** Key "'''profile'''" : name of the profile as it is given in the variable Mesh1_prof_long_name in the [[NetCDF]]-file (is only needed when "inputformat = netcdf" was chosen) | |||
** key "'''metadata'''" : set to "1" to display metadata beneath the plot | ** key "'''metadata'''" : set to "1" to display metadata beneath the plot | ||
** key "'''fontsize'''" : fontsize of the plot | ** key "'''fontsize'''" : fontsize of the plot | ||
Revision as of 13:35, 12 October 2016
Basic Information
File-Type
display_hovmoller_steer.dat
File-Form
FORMATTED
Version
April 2016
Description-Date
April 2016
Significance of the File
contains general input data for the program display_hovmoller
File-Contents (in Catchwords)
Input Steering Data
- information about the file input (block input)
- information regarding the output (block output)
- key "directory" : path to folder where plots will be saved (program can create this folder if it does not exist yet during runtime)
- key "outputformat" : desired format of the created plots (*.pdf,*.png,*.fig,*.eps); *.pdf is recommended
- key "parameter" : name of the physical quantity that is plotted(choose "all" to plot all quantities or give the name of a quantity as it is given in the Xtrdata-output file)
- Key "profile" : name of the profile as it is given in the variable Mesh1_prof_long_name in the NetCDF-file (is only needed when "inputformat = netcdf" was chosen)
- key "metadata" : set to "1" to display metadata beneath the plot
- key "fontsize" : fontsize of the plot
- key "font" : font of the plot
- key "figsize" : size of the created plot [width height] in cm
- further information about the plot (block plotinfo)
- key "palette" : name of the colormap that Matlab should use (see picture for available colormaps)
- key "xlimit" : limits of the x-axis [lower_boundary upper_boundary]
- key "ylimit" : limits of the y-axis [lower_boundary upper_boundary] (optional; can only be chosen if one physical quantity is plotted)
General Remarks
- While reading this steering file the dictionary file display_hovmoller_dico.dat will be automatically accessed in directory $PROGHOME/dic/.
Programs using this Type of File
Example-File
siehe $PROGHOME/examples/display_hovmoller/example1/display_hovmoller_steer.dat
back to: File Descriptions