source: palm/trunk/SCRIPTS/NCL/Archive/crosssections_new.usage.txt @ 190

Last change on this file since 190 was 154, checked in by letzel, 14 years ago
  • new NCL scripts added to trunk/SCRIPTS/NCL
  • previous NCL scripts moved to trunk/SCRIPTS/NCL/Archive
File size: 2.8 KB
Line 
1Usage of PALM NCL script crosssections_new.ncl
2==============================================
3Last change: $Id: crosssections_new.usage.txt 127 2007-10-23 11:05:25Z letzel $
4initial version: Marcus Letzel, 17 July 2007
5contour and vector overlay: Theres Franke/Marcus Letzel, 26 July 2007
6
7Command-line syntax
8===================
9ncl crosssections_new.ncl [parameters]
10
11The parameter syntax depends on their data type:
12A) numeric data    : parameter=value      (for example t=0)
13B) character string: 'parameter="string"' (for example 'var="u_xy"')
14
15Alphabetical parameter list
16===========================
17Name    Default value           Meaning
18-----------------------------------------------------------------------------
19cm      "ncview_default"        colormap
20di      ""                      input directory (with final /)
21d       =di                     output directory (with final /)
22fi      "example_xy"            base name of input file (without suffix)
23fo      ""                      base name of output files (without suffix)
24fill_mode "AreaFill"            fill mode for mode="Fill":
25                                "AreaFill", "RasterFill" or "CellFill"
26mode    "Fill"                  output mode ("Fill" or "Line")
27t       0                       output time step
28var     "u_xy"                  variable to be output
29xs      -1e+38                  output x-coordinate range start (in m)
30xe      +1e+38                  output x-coordinate range end   (in m)
31ys      -1e+38                  output y-coordinate range start (in m)
32ye      +1e+38                  output y-coordinate range end   (in m)
33zs      -1e+38                  output z-coordinate range start (in m)
34ze      +1e+38                  output z-coordinate range end   (in m)
35co                              variable to be output as contour overlay
36wv1                             first component of wind vector overlay
37wv2                             second component of wind vector overlay
38
39Usage
40=====
41This script draws NCL contour plots from two-dimensional cross-sections of
42NetCDF data produced by PALM. Instantaneous or time-averaged xy-, xz-, yz- or
433D-data can be used with this script.
44
45The sectional plane has neither a default orientation nor a default position.
46Both must be specified together using the coordinate range parameters:
47- For xy cross-sections specify zs and ze (with zs=za).
48- For xz cross-sections specify ys and ye (with ys=ya).
49- For yz cross-sections specify xs and xe (with xs=xa).
50
51The remaining coordinate range parameters can optionally be used to restrict
52the output coordinate range.
53
54By default, only screen output is produced. Additional file output is optional
55and requires to specify the parameter fo. This will create three files: fo.pdf,
56fo.eps and fo.ps.
57
58Input and output files can optionally be preceeded by an input and output
59directory di and d, respectively. If not specified, this scripts expects the
60input file to reside in the current directory.
61
62The contours can be drawn either in "Fill" (default) or "Line" mode.
63
64The parameter co activates an optional contour overlay; the parameters wv1 and
65wv2 activate an optional vector overlay.
Note: See TracBrowser for help on using the repository browser.