NuSDaS User's Guide

v1.0 Definition File - Structure Statements

nusdas version

version of NuSDaS. If not omitted, it must be 10 *1. And if not omtted, it is highly recommended to place this statement at the top of definition file; in future versions of NuSDaS, there may be incompatible extension to the definition file, and this version will describe what version of NuSDaS you are using.

path ...

specifies the directory at which data files will be located. It is relative path from NRD. One of following syntax list is used for words.

path relative_path template

The relative path will be template. See Pathname Expansion for special symbols. By default this style is assumed and ``/_model/_attribute/_space/_time/_name'' as template.

path nwp_path_s

Equivalent to statements ``path relative_path /_3d_name'' and ``filename _validtime''.

path nwp_path_vm

Equivalent to statements ``path relative_path /_3d_name'' and ``filename _member''.

path nwp_path_m

Equivalent to statements ``path relative_path /_3d_name/_member'' and ``filename _validtime''.

path nwp_path_bs

Equivalent to statements ``path relative_path /_3d_name/_basetime'' and ``filename _validtime''.

path nwp_esf

In this special case, internal file I/O will be done through ES interface, not by standard C library.

filename filename

Name of data file will be filename. See Pathname Expansion for special symbols. By default, _basename is assumed.

creator creator

Specifies information on creator of the data. It will written in NUSD record after prepending user name and host name.

type1 _model _2d _3d

This statement cannot be omitted. Word _model is four name characters (alphabet, number, and underline) representing model name or creation process. Word _2d is two name characters representing horizontal grid name. Word _3d is two name characters representing vertical grid name. See Reference Manual for table of possible values.

type2 _attribute _time

This statement cannot be omitted. Word _attribute is two name characters representing data attribute. Word _time is two name characters representing time attribute. See Reference Manual for table of possible values.

type3 _name

This statement cannot be omitted. Word _name is four name characters. You can use arbitrary name for this field; it does not affect behavior of library nor conventional meaning. Name "STD1" is used for the most typical operational dataset. Note: when _name is less than 4 letters, space character is appended in internal operation, such as contents of CNTL record. However, in Pathname Expansion, underline ("_") character if prefixed.

member n_dc inout

Word n_dc is number of members (1 assumed by default). When inout is in, records for different members are stored in one file, and when inout is out, records for different members are stored in separated files.

memberlist member member ...

lists up members.

basetime YYYYmmddHHMM

This statement is omitted in most cases. It specifies base time. Format of YYYYmmddHHMM is same as %Y%m%d%H%M in UNIX date(1) or strftime(3).

validtime n_vt inout unit

This statement cannot be omitted. This specifies number of valid times n_vt and unit, units of numbers in following validtime1 and validtime2 statements. Word unit should be one of min, hour, day, pen, mon, week, jun. When inout is in, records for different valid times are stored in one file, and when inout is out, records for different valid times are stored in separated files.

validtime1 arithmetic initial step
validtime1 all_list vt1 vt2 vt3 ...

This statement cannot be omitted. At least and just one of above two formes should appear. This statement specifies list of the first part of valid time, called valid1 in Reference Manual. When the second word is arithmetic, the valid1 is an arithmetical series with specified initial and step value. When the second word is all_list, following words are interpreted as list of valid times. Usually the list is written in ascending order. All of the arguments initial, step, vt1, ... are in units declared in previous validtime statement.

validtime2 ft1 ft2 ft3 ...
validtime2 -dt

At least and just one of above two formes should appear. This statement specifies list of the second part of valid time, called valid2 in Reference Manual. When the former form is used, the list of valid2 will be (vt1 + ft1), (vt2 + ft2), (vt3 + ft3), and so on. Usually the list is written in ascending order. When the latter form is used, the list of valid2 will be (vt1 + dt), (vt2 + dt), (vt3 + dt), and so on. All of the arguments dt, ft1, ft2, ... are in units declared in previous validtime statement. If this statement is omitted, the special value -1 is assumed as valid2.

plane n_lv

This statement cannot be omitted. Specifies the number of planes.

plane1 name name name ...

This statement cannot be omitted. Specifies the list of first plane. The list should have n_lv items. Usually the list is written in ascending order in height. It looks like descending order if pressure coordinate is used, (e.g. SURF 1000 950 900 ...).

plane2 name name name ...

Specifies the list of second plane. The list should have n_lv items. If this statement is omitted, the same list to that in plane1 is assumed.

element n_el

This statement cannot be omitted. Specifies the number of elements.

elementmap elemname elementmap

This statement cannot be omitted, and will appear n_el times. It describes where is the element elemname allowed to write. See section Elementmap for detail.

size nx ny

This statement cannot be omitted, It indicates that the number of grid points is nx in X direction, and ny in Y direction. In most cases X is taken eastward and Y northward, although that is dependent to what coordinate system (_2d in type1 statement) you use.


*1older version of this document says it should be 1.0 by mistake