View source for DISPLAY HOVMOLLER STEER.DAT

{{FileDescription
|name_de=DISPLAY_HOVMOLLER_STEER.DAT
|filetype=display_hovmoller_steer.dat
|version=April 2016 
|version_descr=April 2016 
|significance=contains general input data for the program display_hovmoller
|filecontents=
[[File:Matlabcolormaps.PNG|thumb|'''Picture ''Colormaps available in MATLAB'''''.]]

'''Input Steering Data''' 

* information about the file input (block '''input''')
** key "'''file'''" : path to folder containing 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''')
** 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/'''. 
|nutzerprogramme="DISPLAY_HOVMOLLER"
|language=FORTRAN90
|fileform=FORMATTED
|fileaccess=SEQUENTIAL
|fileextension=.dat
|writemodules=interactive generation (editor) 
|readmodules=An adapted and as a mex-file compiled version of the p_dictionary_ui.f90 is used to check the user input in the steering file. The [[MATLAB]] class Xtrdata_Output.m is used to read the content of the steering file and make it available in [[MATLAB]].
|contact_original=[mailto:tabea.brodhagen@baw.de T. Brodhagen]
|contact_maintenance=[mailto:tabea.brodhagen@baw.de T. Brodhagen]
|examplefile=siehe $PROGHOME/examples/display_hovmoller/example1/display_hovmoller_steer.dat}}