Technical Report No. ? - DKRZ

Technical Report No. ? 

DRAFT 

Description of programs 

handling files in 

WMO GRIB 

and 

EXTRA 

format 

H. Borgert and W. Welke, 

Max-Planck-Institut für Meteorologie, 

Bundesstraße 55, D-20146 Hamburg 

Edited by: Modellbetreuungsgruppe 

Hamburg, December 1993

1. INTRODUCTION 

1.1 BACKGROUND 

DKRZ GRIB/EXTRA Format Module Documentation 

The Max-Planck-Institut für Meteorologie (MPI) has a number of meteorological and oceanic data, 

including both observed data and model simulations. A programming package has been set up that will 

enable a user to do data extractions and analyses with little effort. This manual describes the two standard 

data formats used, lists the programs available and gives instructions to use them. A comprehensive 

list of observed data available at Hamburg and their structure should refer to: 

DKRZ Technical Report No.1, Inventory of Available Observed Data Sets, by Ingo Jessel. 

1.2 PURPOSE OF THIS MANUAL 

This manual will enable scientists to extract the data they require from the sets, and to perform their analyses 

quickly and easily. It describes a number of programs for doing simple arithmetic, statistic, selection 

or display of data from the data sets. 

Some of the programs have been provided by the Canadian Climate Centre (CCC) and have been modified 

in Hamburg to cater for the specific Hamburg data structure. 

1.3 CONTENTS OF THIS MANUAL 

This manual comprises three sections: 

• Outline of the system. 

• The GRIB-Format: Description of the format, outline of some of the data sets available, and full 

details of the programs that work with GRIB-Format data sets. 

• The EXTRA-Format: Description of the format, outline of some of the data sets available, and full 

details of the programs that work with EXTRA-Format data sets. 

PAGE 1.0.1


PAGE 1.0.2

2. OUTLINE OF THE SYSTEMS 


A system has been devised involving two standardised data formats and a library of programs which perform 

basic arithmetic, statistics or extraction on any dataset that is in one of these formats. The purpose 

of the system is to enable users to extract the data they need without having to write programs or do long 

complicated data manipulations. These programs also include some complex data analysis routines such 

like EOF’s, canonical correlation and spectral analysis. 

The two data formats are called EXTRA-Format and GRIB-Format. The EXTRA-Format was designed 

by E. Kirk (University of Hamburg). The GRIB-Format was devised by WMO. One set of programs convert 

between EXTRA- and GRIB-Format. 

2.1 THE GRIB-FORMAT 

2.1.1 Outline 

The GRIB-Format was devised by WMO for use in weatherforecasting. It is used in Hamburg for model 

output data. Its data structure is readable on any computer and also provides a highly dense packaging. 

Further details can be found in 

WMO-No. 306 Manual on Codes, Volume 1, International Codes, Part B - Binary Codes 

2.1.2 The System 

The GRIB-Format system comprises a set of program modules. 

The GRIB-Format program names are listed in section 3.1 . The method of calling the programs is given 

in section 3.2 . An introduction to the GRIB-Format is given in section 3.3 . The details of all the program 

modules can be found in section 3.4 . In section 3.5 some examples of program calls are shown. 

2.1.3 Method of Use 

The user should be familiar with the use of the procedure EXTRACT and with UNIX before using the 

GRIB program modules. Use of EXTRACT is described in section 3.4.1 . The user runs the program 

modules under UNIX. The procedure EXTRACT itself makes use of the GRIB system, hiding details of 

the GRIB-Format to the user. 

PAGE 2.1.1

2.2 THE EXTRA-FORMAT 

2.2.1 Outline 


The EXTRA-Format was created at the Meteorologisches Institut der Universität Hamburg for the data 

output of its T21-General Circulation Model. It has been adopted by the MPI for their model outputs and 

many of their sets of observational data. 

The EXTRA-Format has an extremely simple structure, which allows for a wide range of types of data 

to be included. The data sets classified this way include: Spatial fields of one variable; Sequences of spatial 

fields of several variables; Time sequences of spatial fields; Sets of a given field over several levels; 

Time series of single variables. 

This simplicity makes for versatility, enabling a relatively small number of program modules to do a very 

wide range of processing options and enables a user to transfer every dataset into the EXTRA-Format. 

However, the simplicity also means that much information important to the data sets is not included in 

the sets themselves. For example, data that represent spatial fields are not indicated as such, nor is the 

geographical location of the points indicated. The user must therefore obtain the relevant information 

about the data sets before using them. 

2.2.2 The System 

The EXTRA-Format system comprises Data sets and Program modules. The structure of the data sets is 

described in section 3.1 . The program modules are listed in section 4.2 . The method of calling the programs 

is given in section 4.3 . Information about the implementation on all computers at the DKRZ and 

at the KNMI in DeBilt are given in section 4.4 . A description of the online help system is given in section 

4.5 and some examples pointed out in section 4.7 . The details of all the program modules can be 

found in section 4.6 . 

2.2.3 Method of Use 

• The user establishes which data set(s) he wants to use, and clarifies their structure. 

• The user runs the program modules using very simple UNIX calls. This will result in various 

derived data sets. 

• The user may, if desired, write programs that read the derived data sets (or the originals) and 

generate further results. It is recommended that the user writes his programs in such a way that they 

will read any EXTRA-Format file, and writes their output also in EXTRA-Format, when 

appropriate. 

• The EXTRA-Format data sets can be displayed with the included plot programs, isolines can be 

plotted easily with the ISO plot package. 

PAGE 2.2.1

3. GRIB-FORMAT PROGRAMS 


In this section programs for computation of GRIB files are described. 

It is recommended to use the programs in the bourne shell. They are available after execution of the command 

PATH=$PATH:$GRIB 

All programs have upper case and lower case names. This is useful, if there are other programs with conflicting 

names. 

The directory containing these programs can be specified in the execution path environment variable 

PATH prior to the directory mentioned above; then both programs will be available. 

The general calling sequence for all programs is 

prog [+|-] file1 file2 file3 ... 

where prog is the name of the program and file1, file2, ... are names of data files. 

Standard files INPUT and OUTPUT can be redirected by the UNIX mechanism using ’’ for OUTPUT. See UNIX manual page ’sh’ for further information. 

Some programs can read parameter lists from standard INPUT; this can be suppressed by a ’-’ or forced 

by a ’+’ as first parameter. For default action see single program descriptions. 

Meaningless specifications of ’-’ and ’+’ as first parameter are ignored. 

PAGE 3.0.1


PAGE 3.0.2

3.1 LIST OF AVAILABLE PROGRAMS 


a) in alphabetical order 

3.4.6.1 ABS outfile = abs(infile) 

3.4.12.4 ACCU Accumulate time series 

3.4.7.1 ADD outfile = infile1 + infile2 

3.4.10.5 ANOMAL Subtract multi-year monthly time averages from a time series. 

3.4.8.3 CATEXTF Concatenate up to 88 files in blocked extra format 

3.4.8.3 CATSRVF Concatenate up to 88 files in blocked service/afterburner format 

3.4.12.5 CHEAD Change grib header specifications 

3.4.8.1 GRB2EXF File conversion - grib to formatted extra format 

3.4.8.1 GRB2EXP File conversion - grib to unblocked extra format 

3.4.8.1 GRB2EXT File conversion - grib to blocked extra format 

3.4.8.1 GRB2SRF File conversion - grib to formatted service/afterburner format 

3.4.8.1 GRB2SRP File conversion - grib to unblocked service/afterburner format 

3.4.8.1 GRB2SRV File conversion - grib to blocked service/afterburner format 

3.4.8.2 EXF2GRB File conversion - formatted extra to grib format 

3.4.8.2 EXP2GRB File conversion - unblocked extra to grib format 

3.4.8.2 EXT2GRB File conversion - blocked extra to grib format 

3.4.8.2 SRF2GRB File conversion - formatted service/afterburner to grib format 

3.4.8.2 SRP2GRB File conversion - unblocked service/afterburner to grib format 

3.4.8.2 SRV2GRB File conversion - blocked service/afterburner to grib format 

3.4.12.1 CORREL Calculate correlation 

3.4.12.2 CORRWM Calculate correlation to window mean 

3.4.11.3 CRETAN Create annual cycle (1st and 2nd annual harmonic) of daily data. 

3.4.4.1 DAMSEL Select a day range within each month from infile 

3.4.4.1 DAYSEL Select a day range within each year from infile 

3.4.7.1 DIV outfile = infile1 / infile2 (x/0:=0) 

3.4.4.1 DMDSEL Select equidistant days within each month from infile 

3.4.6.1 EXPONE outfile = e infile 

3.4.1.1 EXTRACT User interface to extraction module EXTRAKT 

3.4.1.2 EXTRAKT Extraction of GCM data residing on tapes to disk 

3.4.11.1 FINDAN Determine annual cycle (1st and 2nd annual harmonic) of daily data. 

3.4.9.2 FLDAVG Compute mean of input fields 

3.4.9.2 FLDMAX Compute maxima of input fields 

3.4.9.2 FLDMIN Compute minima of input fields 

3.4.6.4 FMASK Create floating point mask according to arithmetic comparison 

3.4.6.3 FPOW outfile = infile pow (0 pow =0) 

PAGE 3.1.1


3.4.7.3 GADD outfile = infile1 + (first record of) infile2 

3.4.3.3 GGDIFF Print statistics over differences of two files 

3.4.3.1 GGSTAT Print header information and simple statistics for each field in a file. 

3.4.3.2 GGSTATM Print number of fields per month in a file. 

3.4.3.1 GGSTATS Print header information for each field in a file. 

3.4.3.2 GGSTATT Print number of fields per date in a file. 

3.4.7.3 GDIV outfile = infile1 / (first record of) infile2 

3.4.9.1 GLOBAVG Compute the surface mean of input fields using weight factors for latitudes 

3.4.7.3 GMLT outfile = infile1 * (first record of) infile2 

3.4.12.3 GSCOPY File conversion from one-level to multi-level sets 

3.4.7.3 GSUB outfile = infile1 - (first record of) infile2 

3.4.4.1 HOURSEL Select a hour range within each day from infile 

3.4.6.1 INV outfile = 1/infile (1/0=0) 

3.4.10.4 LMEAN Compute multi-year monthly averages. 

3.4.10.4 LMMAX Compute multi-year monthly maxima. 

3.4.10.4 LMMIN Compute multi-year monthly minima. 

3.4.10.7 LMSTDV Compute multi-year monthly standard deviations. 

3.4.6.1 LOGE outfile = ln(infile) (ln(0):=0) 

3.4.6.1 LOG10 outfile = log10 (infile) (log10 (0) := 0) 

3.4.9.3 MERAVG Compute meridional averages of input fields 

3.4.9.3 MERMAX Compute meridional maxima of input fields 

3.4.9.3 MERMIN Compute meridional minima of input fields 

3.4.7.1 MLT outfile = infile1 * infile2 

3.4.2 MOD21 Read, unpack, transform and select data generated by ECHAM-T21. 




3.4.10.2 MONAVG Compute monthly averages. 

3.4.10.2 MONMAX Compute monthly maxima. 

3.4.10.2 MONMIN Compute monthly minima. 

3.4.4.1 MONSEL Select a month range within each year from infile 

3.4.5.2 POINT Extract single points from grid fields 

3.4.7.4 PSADD (set of) outfile = (set of) infile2 + (field of) infile1 

3.4.7.4 PSDIV (set of) outfile = (set of) infile2 / (field of) infile1 

3.4.7.4 PSMLT (set of) outfile = (set of) infile2 * (field of) infile1 

3.4.7.4 PSSUB (set of) outfile = (set of) infile2 - (field of) infile1 

3.4.5.4 ROTATE Rotate grid fields 

3.4.10.3 SELAVG Compute time range averages. 

PAGE 3.1.2


3.4.4.1 SELECT Select from infile fields according to specified codes, levels and timesteps. 

3.4.10.3 SELMAX Compute time range maxima. 

3.4.10.3 SELMIN Compute time range minima. 

3.4.6.1 SIGN outfile = sign(infile) 

3.4.5.3 SLICE Extract slices from grid fields 

3.4.4.5 SPLITC Split file to several files, one for each code 

3.4.4.2 SPLITD Split file to several files, one for each day of month 

3.4.4.2 SPLITH Split file to several files, one for each hour of day 

3.4.4.5 SPLITL Split file to several files, one for each level 

3.4.4.2 SPLITM Split file to several files, one for each month of year 

3.4.4.4 SPLITS Split file to several files with equal numbers of sets 

3.4.4.3 SPLITY Split file to several files, one for each year 

3.4.6.1 SQUARE outfile = infile 2 

3.4.6.1 SQROOT outfile =sqrt(infile) 

3.4.10.6 STDDEV Calculate local standard deviation 

3.4.7.1 SUB outfile = infile1 - infile2 

3.4.11.2 SUBTAN Subtract annual cycle (1st and 2nd annual harmonic) from daily data. 

3.4.10.1 TIMAVG Compute time average. 

3.4.10.8 TIMDEV Compute deviation from time average 

3.4.10.1 TIMMAX Compute time maximum. 

3.4.10.1 TIMMIN Compute time minimum. 

3.4.5.1 WINDOW Extract windows from grid fields 

3.4.6.2 XLIN outfile = a * infile + b 

3.4.7.2 XYLIN outfile = a * infile1 + b * infile2 + c 

3.4.10.2 YEARAVG Compute yearly averages. 

3.4.10.2 YEARMAX Compute yearly maxima. 

3.4.10.2 YEARMIN Compute yearly minima. 

3.4.4.1 YEARSEL Select a year range from infile 

3.4.9.3 ZONAVG Compute zonal averages of input fields 

3.4.9.3 ZONMAX Compute zonal maxima of input fields 

3.4.9.3 ZONMIN Compute zonal minima of input fields 

3.4.5.5 ZXCOLC Collect slices or small windows of same level and combine them to 

two-dimensional fields 

3.4.5.5 ZXCOLD Collect slices or small windows and combine them to two-dimensional fields 

3.4.5.5 ZXCOLL Collect slices or small windows of same code and combine them to 


PAGE 3.1.3


b) in thematic order 

Listing of file contents 






Selection of fields and splitting of files according to miscellaneous criteria 














Selection and conversion of parts of fields 









3.4.5.5 ZXCOLD Collect slices or small windows and combine them to two-dimensional fields 

PAGE 3.1.4






Unary operators 




3.4.6.1 LOG10 outfile = log10 (infile) (log10 (0) := 0) 

3.4.6.2 XLIN outfile = a * infile + b 



Binary operators 






Binary operators, first field of second operand used only 





Binary operators, one field of first file used for each set of second file 

3.4.7.4 PSADD (set of) outfile = (set of) infile2 + (field of) infile1 

3.4.7.4 PSSUB (set of) outfile = (set of) infile2 - (field of) infile1 

3.4.7.4 PSMLT (set of) outfile = (set of) infile2 * (field of) infile1 

3.4.7.4 PSDIV (set of) outfile = (set of) infile2 / (field of) infile1 

PAGE 3.1.5


Conversion and concatenation of files in extra and service/afterburner format 















Computation of averages, minima and maxima over fields or time series 





















PAGE 3.1.6







Deviation programs 





Annual cycle programs 




Others 






Extraction modules 

3.4.1.1 EXTRACT User interface to extraction module EXTRAKT 

3.4.1.2 EXTRAKT Extraction of GCM data residing on tapes to disk 

Afterburner 





PAGE 3.1.7


PAGE 3.1.8


3.2 EXAMPLES FOR LEGAL PROGRAM CALLS 

# 

# === Input < and params outfile’ appends to an already existing file 

# or creates a new one. 

# 

PAGE 3.2.1


PAGE 3.2.2

3.3 THE GRIB-FORMAT 


The programs described below use the following specifications. 

- TYPE Data representation type 

0 latitude / longitude grid 

4 gaussian latitude / longitude grid 

-4 0 or 4 

50 spherical harmonic coefficients 

-1 any 

- TIME Time step number 

Time steps have decimal format YYMMDDHH 

Day of year is specified as MMDD, hour of day as HH, etc. 

Time ranges are specified as parameters NT1 and NT2. 

- CODE Data code, please refer to Table 1. 

Codes greater than 256 are folded to fit in one byte. 

Programs treat codes equal, if they have equivalent representation, e.g. codes 263 and 7 match. 

- LEVEL Either Isobaric level, pressure specified in hPa, or Sigma level number. 

Ranges are specified as parameters LV1 and LV2. 

For full details about the internal byte structure of grib code data see inline comments of the conversion 

program package and the appropriate pages of documentation ‘MARS USER GUIDE’. 

PAGE 3.3.1


The following code-list is available from /pf/k/k204003/doc/codes 

type: g=grid, s=spectral, m=mean over output interval, p=packed 

code levels 

Table 1 Code numbers of the ECHAM-Models (Sheet 1 of 5) 

internal 

name 

type variable unit 

------------------ clear sky diagnostics (method II), not available in standard model ---------------------- 

101 1 SRAFS g m net surface solar radiation (clear sky) [W/m**2] 

102 1 TRAFS g m net surface thermal radiation (clear sky) [W/m**2] 

103 1 SRAFO g m net top solar radiation (clear sky) [W/m**2] 

104 1 TRAFO g m net top thermal radiation (clear sky) [W/m**2] 

105 1 SRAFOU g m top solar radiation upward (clear sky) [W/m**2] 

106 1 SRAFSU g m surface solar radiation upward (clear sky) [W/m**2] 

107 1 TRAFSU g m surface thermal radiation upward (clear sky) [W/m**2] 

----------------------------------------------------------------------------------------------------------------------- 

129 1 GEOSP g surface geopotential (orography) [m**2/s**2] 

130 19 STP s temperature [K] 

131 19 g u-velocity [m/s] 

132 19 g v-velocity [m/s] 

133 19 SQ s specific humidity [kg/kg] 

134 1 APS g surface pressure [Pa] 

135 1 9 g vertical velocity [Pa/s] 

138 19 SVO s vorticity [1/s] 

139 1 TS g surface temperature [K] (see also 169) 

140 1 WS g soil wetness [m] 

141 1 SN g snow depth I [m] 

142 1 APRL g m large scale precipitation [m/s] 

143 1 APRC g m convective precipitation [m/s] 

144 1 APRS g m snow fall [m/s] 

145 1 VDIS g m boundary layer dissipation [W/m**2] 

146 1 AHFS g m surface sensible heat flux [W/m**2] 

147 1 AHFL g m surface latent heat flux [W/m**2] 

148 19 g streamfunction [m**2/s] 

PAGE 3.3.2

code levels 


149 19 g velocity potential [m**2/s] 

151 1 g mean sea level pressure [Pa] 

152 1 STP(20) s log surface pressure 

153 19 SX s liquid water content [kg/kg] (see 161, 222) 

154 


internal 

name 


155 19 SD s divergence [1/s] 

156 19 g geopotential height [gpm] 

157 19 g relative humidityII [fract.] 

158 1 g tendency of surface pressureII [Pa/s] 

159 1 USTAR3 g m ustar**3 [m**3/s**3] 

160 1 RUNOFF g m surface runoff (not ECHAM1 !) III [m/s] (see also 271) 

161 19 ALWC g liquid water content [kg/kg] (see also 222) 

162 19 ACLC g cloud cover [fract.] (see also 223) 

163 1 ACLCV g total cloud cover [fract.] (see also 164) 

164 1 ACLCOV g m total cloud cover [fract.] 

165 1 U10 g m 10m u-velocity [m/s] 

166 1 V10 g m 10m v-velocity [m/s] 

167 1 TEMP2 g m 2m temperature [K] 

168 1 DEW2 g m 2m dew point temperature [K] 

169 1 TSURF g m surface temperature [K] (see also 139) 

170 1 TD g deep soil temperature IV [K] 

171 1 WIND10 g m 10m windspeed [m/s] 

172 1 SLM g land sea mask [0: sea, 1: land] 

173 1 AZ0 g surface roughness [m] 

174 1 ALB g surface background albedo [fract.] 

175 1 ALBEDO g surface albedo [fract.] 

176 1 SRADS g m surface solar radiation [W/m**2] 

177 1 TRADS g m surface thermal radiation [W/m**2] 

178 1 SRAD0 g m top solar radiation [W/m**2] 

179 1 TRAD0 g m top thermal radiation [W/m**2] 

PAGE 3.3.3

code levels 



internal 

name 

180 1 USTR g m u-stress [Pa] 

181 1 VSTR g m v-stress [Pa] 

182 1 EVAP g m Evaporation [m/s] 

183 1 TDCL g soil temperature IV [K] 

194 1 WLM1 g skin reservoir content of plants [m] 

195 1 USTRGW g m u-gravity wave stress [Pa] 

196 1 VSTRGW g m v-gravity wave stress [Pa] 

197 1 VDISGW g m gravity wave dissipation [W/m**2] 

201 1 T2MAX g maximum 2m-temperature [K] 

202 1 T2MIN g minimum 2m-temperature [K] 

203 1 SRAD0U g m top solar radiation upward [W/m**2] 

204 1 SRADSU g m surface solar radiation upward [W/m**2] 

205 1 TRADSU g m surface thermal radiation upward [W/m**2] 

206 1 TSN g snow temperature IV [K] 

207 1 TD3 g soil temperature IV [K] 



210 1 SEAICE g sea ice cover [fract.] 

211 1 SICED g sea ice depth [m] 

212 1 FOREST g vegetation type 


213 1 TEFF g (effective) sea-ice skin temperature [K] 

214 1 TSMAX g maximum surface temperature [K] 

215 1 TSMIN g minimum surface temperature K] 

216 1 WIMAX g maximum 2m-wind speed [m/s] 

217 1 TOPMAX g maximum convective cloud tops [m] 

218 1 SNMEL g m snow melt [m/s] 

220 1 TSLIN g m land: residual surface heat budget 

sea-ice: conductive heat flux 

PAGE 3.3.4 

[W/m**2] 

[W/m**2]

code levels 


221 1 DSNAC g m snow depth change [m/s] 

222 19 ALWCAC g m liquid water content [kg/kg] 

223 19 ACLCAC g m cloud cover [fract.] 

------------------ clear/overcast sky diagnostics (method I) ----------------------- 

224 1 SRAD0F g m top solar radiation in clear-sky areas [W/m**2] 

225 1 TRAD0F g m top thermal radiation in clear-sky areas [W/m**2] 

226 1 ACCNTF g number of clear-sky events 

227 1 SRAD0C g m top solar radiation in overcast areas [W/m**2] 

228 1 TRAD0C g m top thermal radiation in overcast areas [W/m**2] 

229 1 ACCNTC g number of overcast events 

------------------------------------------------------------------------------------------------------------------------ 

230 1 QVI g m vertically integrated specific humidity [kg/m**2] 

231 1 ALWCVI g m vertically integrated liquid water cont. [kg/m**2] 

232 1 GLAC g glacier mask [0: no, 1: yes] 

241 19 XT(1) s tracer gas 

. . 


internal 

name 

255 19 XT(15) s tracer gas 


259 19 g windspeed ((u**2+v**2) 1/2 ) 

260 1 g m total precipitation (142+143) 

261 1 g m total top radiation (178+179) 

262 1 g m total surface radiation (176+177) 

263 1 g m net surface heat flux (146+147+176+177-220) 

264 1 g m total surface water (142+143+182-160) 

265 1 g m top solar cloud forcing (method I) (178-224) 

266 1 g m top thermal cloud forcing (method I) (179-225) 

267 1 g m total top cloud forcing (method I) (178+179-224-225) 

268 1 g m atmospheric solar radiation (178-176) 

269 1 g m atmospheric thermal radiation (179-177) 

270 1 g m total atmospheric radiation (178+179-176-177) 

271 1 g m surface runoff (only ECHAM1 !) (142+143+182-221) 

PAGE 3.3.5

code levels 



internal 

name 

272 19 g mass stream function 


273 1 g dp s /dλ zonal derivative of surface pressure 

274 1 g dp s /dφ meridional derivative of surface pressure 

275 1 g m precipitation - evaporation (142+143+182) 

------------------ cloud forcing (method II), not available in the standard model ---------------------- 

364 g m top solar cloud forcing (178-103) 

365 g m top thermal cloud forcing (179-104) 

366 g m top net cloud forcing (364+365) 

370 g m surface solar cloud forcing (176-101) 

371 g m surface thermal cloud forcing (177-102) 

372 g m surface net cloud forcing (370+371) 

373 g m atmospheric solar cloud forcing (364-370) 

374 g m atmospheric thermal cloud forcing (365-371) 

375 g m atmospheric net cloud forcing (373+374) 

376 g m surface net radiation (clear sky) (101+102) 

377 g m atmospheric solar radiation (clear sky) (103-101) 

378 1 g m atmospheric thermal radiation (clear sky) (104-102) 

379 1 g m atmospheric net radiation (clear sky) (377+378) 

--------------------------------------------------------------------------------------------------------------------- 

380 1 g m planetary albedo V -(203/(178-203))*100. [fract.] 

381 1 g m planetary albedo V -(105/(103-105))*100. [fract.] (clear sky) 

382 1 g m surface albedo -(204/(176-204))*100. [fract.] 

I. ECHAM1: 

Due to a coding error the runoff (code 160) should not be used. 

A "residual runoff" (code 271) may be applied for long term water budget studies instead. 

II. Codes 157 (relative humidity) and 158 (tendency of surface pressure) are predefined but not calculated by the 

afterburner package. 

III. ECHAM2/ECHAM3: 

Over land ice (SN > 9.5 m or GLAC = 1) the snow melt is not calculated i.e. the snow gradually 

accumulates. In long term integrations with coupled models a suitable ice flow to the ocean 

(glacier calving) has to be introduced for maintaining the water budget. 

PAGE 3.3.6


IV. For description of soil temperatures see section 3.7.2 

V. The planetary albedo (code 380 and 381, respectively for clear sky) equals zero, if the numerator is zero. 

Calculate albedos only from temporal or eventually spatial mean fluxes. The global mean results 

from the glogal mean of fluxes ! 

Note: For a description of method I and method II of calculating clear sky diagnostics and cloud forcing 

refer to DKRZ Technical Report No. 6, The ECHAM3 Atmosphere Model, Appendix F. 

T s 

T Sn 

T D3 

T D4 

T D5 

T D 

T DCL 

surface temperature (interface to the atmosphere) 

snow temperature 

soil temperatures 

Figure 1 Description of soil temperatures in the ECHAM model. 1 

For detailed description of soil processes refer to DKRZ Technical Report No. 6, The 

ECHAM3 Atmosphere Model, section 3.13 . 

1. Note that the surface temperature T s is always the interface temperature to the atmosphere even in 

snow coverded areas. 

PAGE 3.3.7


PAGE 3.3.8

3.4 DESCRIPTION OF THE MODULES 

3.4.1 Extraction modules 

3.4.1.1 EXTRACT 

Purpose 


The procedure EXTRACT creates a namelist file and calls procedure EXTRAKT to read GCM 

results from tape. 

Calling sequence 

Parameters 

extract \ 

-exp experiment \ 

-psd scratch \ 

-rfp result \ 

-pit text1 \ 

-pit text2 

text1, text2,... : lines of namelist parameters 

For meaning of parameters see appropriate program descriptions 

(e.g. afterburner package (mod21, mod42, mod63, mod106), select). 

Parameters not used by EXTRACT are propagated to EXTRAKT. 

The most important ones are: 

experiment: experiment mnemonic 

scratch: scratch directory used for tape processing 

If specified, it must precede parameters -pit . 

Default is $TMPDIR. 

result: result file prefix 

Processing output files will have names "resultYYMM", where date format matches the one on input 

tape labels. 

Example: 

extract \ 

-exp Control \ 

-psd $TMPDIR/example \ 

-rfp $MFHOME/result \ 

-pit ’type=30 code=156’ \ 

-pit ’level=50000,30000,20000,10000’ \ 

-pit ’mean=0 grib=1’ 

PAGE 3.4.1.1

3.4.1.2 EXTRAKT 

Purpose 


The procedure EXTRAKT provides an easy way to access tape data generated by a GCM. Usually 

it is called via procedure EXTRACT. 

If the features given by EXTRACT suffice for your purposes, this description should be left alone. 

Parameters (with only a few exceptions: lop, skp, end and err) have the general form ‘-par value’. 

Upper case and lower case characters can be mixed in any way and are significant for file names 

only. 

Parameter overview 

Parameter for listing 

lst list 

Parameters starting with ’p’ for processing 

pyf process year first 

pyl process year last 

pmf process month first 

pml process month last 

pmb process month begin 

pme process month end 

pmi process month increment 

psd process scratch directory 

ppn process procedure name 

ppi process procedure input 

Parameters starting with ’r’ for result file name 

rfp result file prefix 

rfi result file infix 

rfs result file suffix 

rfy result file yearpad 

rfm result file monthpad 

rfc result file centurypad 

Parameters for recursive procedure calls 

exp experiment 

emp experiment mnemonic prefix 

epc experiment parameter cut 

epl experiment parameter list 

lop loop 

PAGE 3.4.1.2

skp skip 

end end 

err error 

msg message 


Parameters starting with ’i’ for input tape description 

ivf intape vsn first 

ivi intape vsn increment 

ilp intape label prefix 

ili intape label infix 

ils intape label suffix 

ilc intape label centurypad 

ild intape label delimiter 

ily intape label yearpad 

ilm intape label monthpad 

ipf intape position first 

ipi intape position increment 

ipn intape position number 

iyf intape year first 

iyi intape year increment 

iyl intape year last 

imf intape month first 

imi intape month increment 

iml intape month last 

imb intape month begin 

ime intape month end 

imo intape month omit 

ibl intape block length 

icf intape check file 

ijp intape job prefix 

idt intape data type 

iac intape access command 

idp intape diskfile prefix 

ijc intape job class 

Parameter for listing 

lst list 

Default is no listing, but processing. Allowed values are no, short and long. 

Used to list available experiment data specifications or to check input tape description 

parameters. 

Listing for -lst short contains 

PAGE 3.4.1.3


• Experiment mnemonic, if any 

• Availability of tapes needed (+ for yes, - for no, * for partial) 

• Starting VSN and date 

• Ending VSN and date 

• Listing for -lst long contains 

• Name of each tape job that would be submitted 

• VSN and availability of each tape accessed 

• Position and label of each file on tape 

Parameters starting with ’p’ for processing 

pyf process year first 

pyl process year last 

pmf process month first 

pml process month last 

First year, last year, first month and last month to process. 

Default is to process all data, i.e. iyf, iyl, imf and iml. 

The procedure processes files from tape always in one piece; structures and dates inside 

these files are hidden to the procedure. For the selection of files the starting date (i.e. the 

date information on tape label) is checked only. 

pmb process month begin 

pme process month end 

pmi process month increment 

First and last month and increment starting from pmb to form month numbers processed 

within each year. 

Defaults for pmb and pme are imb and ime. Default for pmi is 1. 

The default values process whole years. 

psd process scratch directory 

Scratch directory for tape processing. 

Default is $TMPDIR. 

Used to protect files in $TMPDIR from being deleted. 

If specified, psd should be a subdirectory of $TMPDIR, because it will contain disk 

copies of tape data, which usually are very big. 

ppn process procedure name 

Procedure to process tape data. 

Defaults for idt=gcm* are the appropriate afterburner programs (mod*) by E.Kirk. 

Default for idt=mod is the module select. 

Defaults for idt=obs_* are the appropriate data handling programs by I. Jessel. 

This procedure is given two file names and (optional) parameter input. The first file 

contains a disk copy of tape data. The second file is the result file name formed by 

rf-parameter values and year and month numbers. 

ppi process procedure input 

Input file for process procedure. 

Default is no input. 

If specified, this file is given as input to the procedure ppn. 

PAGE 3.4.1.4


Parameters starting with ’r’ for result file name 

rfp result file prefix 

rfi result file infix 

rfs result file suffix 

Prefix, infix and suffix to form result file names. 

Defaults are empty strings. 

Result file names are formed as 

"rfp [rfc] [rfy ily] year rfi [rfm ilm] month rfs" , 

where appearance of parameters in brackets depends on number of characters in year and 

month. 

rfy result file yearpad 

rfm result file monthpad 

rfc result file centurypad 

Result file name padding for year and month number. 

Default is no padding, i.e. empty strings. 

If padding is on, one-digit year and month numbers are prefixed by rfy and rfm, resp. to 

form two-digit numbers used for result file names. 

Padding with rfc is done for one- or two-digit year numbers only. 

Result file padding should be used only, if intape label padding does not suffice to form 

lexically ordered result files. 

Use ‘no’ to specify empty strings. 

Parameters for recursive procedure calls 

exp experiment 

Experiment mnemonic name. 

A prefix of ‘=’ is replaced by the actual value of emp, exp is translated to upper case, 

‘==’ is appended, then file epl is searched for lines starting with the resulting pattern. 

From all matching lines the first epc characters are cut away and parameter exp is 

replaced by the remaining line parts. 

emp experiment mnemonic prefix 

Prefix for experiment mnemonic names. Default is the empty string. 

Used to simplify loops over mnemonic names with similar prefixes. 

epc experiment parameter cut 

Experiment parameter list cutcount. 

Default is 30. 

Number of characters cut away from lines in epl starting with exp==. 

epl experiment parameter list 

Experiment parameter list file. 

Default is =main. 

This file contains frequently used parameters. 

As the order of parameters is retained over recursive procedure calls, one can switch 

between several parameter list files. 

A prefix of ‘=’ is equivalent to a directory containing files with tape structure information 

for all experiments known to the author. 

When using specifications from these files, parameters describing input tapes (i.e. those 

starting with ‘i’) should be omitted. 

PAGE 3.4.1.5


See info /pool/GRIB/info/exper for a list of available experiment output data. 

lop loop 

Loop over experiment parts. 

Each following parameter value until the ending delimiter ‘-end’ results in a recursive 

procedure call with the parameter value used as experiment mnemonic name and all 

other parameters retained. 

skp skip 

Skip parameters. 

Ignores all parameters until the ending delimiter ‘-end’. 

end end 

End delimiter for lop and skp, not used by itself. 

msg message 

’@’ are converted to blanks. 

err error 

Error forced by calling routine. 

If procedures as EXTRACT detect an parameter error, they can use this option to make 

EXTRAKT perform a parameter check without processing. 

It is recommended to add this parameter twice, because else it could be treated as a 

parameter value and be ignored. 

Parameters starting with ’i’ for input tape description 

ivf intape vsn first 

ivi intape vsn increment 

VSN of first input tape and increment to compute subsequent VSNs. 

No default for ivf, parameter is required. 

Default for ivi is 1. 

The increment is added to the ending numeric part of parameter ivf. 

The resulting number is prefixed by starting characters of parameter ivf to form a sixcharacter 

VSN for the second tape. 

This procedure continues for the third and following tapes. 

ilp intape label prefix 

ili intape label infix 

ils intape label suffix 

ilc intape label centurypad 

ild intape label delimiter 

Input tape label prefix, infix, suffix, centurypad and delimiter. 

Defaults are empty strings. 

Padding with ilc is done for one- or two-digit year numbers only. 

File labels on tapes are formed as “ilp [ilc] ild [ily] year ili [ilm] month ils” , where 

appearance of parameters in brackets depends on number of characters in year and 

month. 

ily intape label yearpad 

ilm intape label monthpad 

Input tape label padding for year and month number. 

Default is padding with 0. 

PAGE 3.4.1.6


If padding is on, one-digit year and month numbers are prefixed by ily and ilm, resp. to 

form two-digit numbers used for tape file labels and result file names. 

Use no to specify empty strings. 

ilo intape label omit 

Switch to omit input tape label checks. 

Default is no. 

If set to yes, input tape labels are not checked. 

ipf intape position first 

ipi intape position increment 

ipn intape position number 

First file position on tapes, increment to compute subsequent positions and number of 

files on any one tape. 

Defaults are 1. 

iyf intape year first 

iyi intape year increment 

iyl intape year last 

First and last year of input data and increment to form year numbers. 

Defaults for iyf and iyi are 1. 

Default for iyl is iyf. 

imf intape month first 

imi intape month increment 

iml intape month last 

First month of year iyf, last month of year iyl and increment to form month numbers. 

Default for imf is imb. 

Default for imi is 1. 

Default for iml is ime. 

imb intape month begin 

ime intape month end 

Beginning and ending month of a year. 

Default for imb is 1. 

Default for ime is 12. 

Year breaks inside input tape files are hidden to the procedure. 

By shifting imb and ime these files can be handled. 

For yearly mean files specified as month 00 set imb and ime to zero. 

imo intape month omit 

Indicator to omit month numbers in input tape labels. 

Default for imo is no. 

If set to yes, month numbers are not inserted in input tape labels. 

Month loop bounds are not influenced. 

ibl intape block length 

Block length on input tapes for use on the CRAY-YMP. 

Default is 172032. 

This parameter is ignored on the CRAY-2S. 

PAGE 3.4.1.7


icf intape check file 

File to check if tape read errors are fatal. 

Default is no check file. 

If a job submitted to read tape data aborts without generating the desired disk file, this 

file (if specified) is searched for two- to five-digit year and month information as on tape 

label. 

If that date is found, the procedure exits without error, else an exit code is set. 

ijp intape job prefix 

Part of names for jobs submitted to read tapes. 

Default is Ext. 

idt intape data type 

Type of data on input tapes. 

Default is gcm21. 

Allowed values are gcm*, mod and obs_*. 

iac intape access command 

Command used to copy file from tape to disk. 

Default is cp. 

Allowed values are cp and ta. 

idp intape diskfile prefix 

File name prefix (without directory name) for disk copy of tape file. 

Default is no prefix. 

ijc intape job class 

Job class for jobs submitted to read data from tapes. 

Default for iac=cp is TS. 

Default for iac=ta is TM. 

PAGE 3.4.1.8

3.4.2 Afterburner 

3.4.2.1 Overview 


The afterburner is a program dealing with the model data of the specific truncations of the ECHAM 

model (T21, T42, T63 and T106). 

The name of the program is after or alternatively: 

mod21, mod42, mod63 or mod106. 

The last 4 names are symbolic links to after (held for traditional reasons). 

The purpose of the program is to read, unpack, transform and select data from T-model GRIB files, and 

write them either unformatted (unblocked SERVICE/afterburner format) or in GRIB format for further 

processing using the GRIB Format programs descibed later on in this documentation. 

The transformation capabilities of the afterburner include optional spectral transformation as well as 

optional interpolation from originally 19 ECHAM hybrid levels to pressure levels. 

The selection feature consists of code selection and level selection. 

Selection and transformation can be combined, e.g. to write out the geopotential field, which is originally 

represented as a grid point field on hybrid levels, as spectral coefficients on the 500 hPa pressure level. 

3.4.2.2 Usage 

The calling sequences of the program is: 

where 

/pf/k/k204004/burn/after inputdata outputdata [Debug] < namelist [>myoutput] 

/pf/k/k204004/burn/after executable program (alternative names: see above) 

inputdata path/filename of GRIB data 

outputdata path/filename of resultfile in specified format 

Debug optional parameter to check memory allocation (written on stderr) 

namelist path/filename of namelistfile (structure: see below) 

myoutput optional path/filename to redirect stdout 

PAGE 3.4.2.1

3.4.2.3 Namelist 


The standard input of the programs is a namelist, which can/must contain the following keywords and 

user specifications: 

Keyword 

possible user 

specification 

TYPE 0 

10 

11 

20 

30 

40 

41 

50 

60 

61 

70 

Table 2: Afterburner standard input 

PAGE 3.4.2.2 

Meaning Default 

Output of spectral coefficients on hybrid levels. 

Output of fourier coefficients on hybrid levels. 

Output of zonal mean sections on hybrid levels. 

Output of gauss grid on hybrid levels. 

Output of gauss grid on pressure levels. 

Output of fourier coefficients on pressure levels. 

Output of zonal mean sections on pressure levels. 

Output of spectral coefficients on pressure levels. 

Output of fourier coefficients on pressure levels. 

Output of zonal mean sections on pressure levels. 

Output of gauss grid on pressure levels. 

CODE 1-275 various variables (ECMWF field code), see section 3.3 . none 

UNITSEL 0 

1 

2 

hybrid or pressure level (all types) depending on type (default) 

height level in metres for type > 20 

height level in kilometres for type > 20 

LEVEL > 0 hybrid level for unitsel = 0, type < 30 

pressure level in Pascal ! for unitsel = 0, type > 20 

height level in metres for unitsel = 1, type > 20 

height level in kilometres for unitsel = 2, type > 20 

MULTI 0 

n 

Process only one input file. 

Process n input files, each containing one month. 

Put only the first input file into the command line. 

All subsequent files are expected to be in the same directory. 

The filenames must follow the syntax 

fileprefix_YYMM for ECHAM1/2/3 

fileprefix_YYMM.DD for ECHAM4 

where YY denotes year, MM month and DD day, respectively. 

DAYINC > 0 ECHAM4 output files for higher truncations (T63, T106) do not 

neccessarily contain full months, because of their length. If you 

want to use MULTI > 0 to process those files, DAYINC gives the 

number of days per file to calculate subsequent filenames. 

0 

0 

none 

0 

30

Keyword 

possible user 

specification 

MEAN 0 

1 

Two more keywords belong to the namelist: 

2 

3 

GRIB 0 

1 


Write out all terms. 

Compute and write out monthly mean fields. 

(for TYPE>=20 only) 

Compute and write out monthly deviations. 

(for TYPE=20 or TYPE=30 only) 

Combination of MEAN=1 and MEAN=2. Each mean field is followed 

by a deviation field with an identical header record 

(for TYPE=20 or TYPE=30 only) 

The outputdata file is an unformatted (unblocked SERVICE/afterburner 

format) one with the following structure: 

The hole file consists of pairs of header records and data records, 

The header record is an integer array of 8 elements. 

The format of the outputfile is GRIB 

(Currently this option only works for TYPE=20, 30, 50 or 70) 

HEAD7 any integer This parameter is for personal use. 

All header records (unblocked SERVICE/afterburner format) 

take this value as their 7th element. 

The contents of the header record are: 

1. Word: ECMWF field code 

2. Word: level (1-19) or pressure [Pa] 

3. Word: date [yymmdd] (yymm00 for monthly means) 

4. Word: time [hh] (-1 for monthly means) 

5. Word: 1st dimension of the data array 

6. Word: 2nd dimension of the data array 

7. Word: may be set using the parameter HEAD7 

8. Word: experiment number (extracted from inputdata filename) 

TIMESEL -1 

0 

6 

12 

18 

Table 2: Afterburner standard input 

Process all terms found on input file. 

Process only 00 hour terms. 




Reassure that the inputdata file contains the term you 

selected. 

&SELECT to indicate the beginning of the namelist 

&END to indicate the end of the namelist 

PAGE 3.4.2.3 

Meaning Default 

0 

0 

0 

-1


A typical example for the generation of a namelist file using the UNIX here document is: 

cat > namelistfile

3.4.2.5 Troubleshooting 


The afterburner package writes pure (unblocked) data files without any record information. 

So don’t forget the pure (CRAY-2S) or the unblocked (CRAY-YMP) attribute in the assign statement 

before reading it with the FORTRAN READ or the CRAY-FORTRAN BUFFER IN.If you read it using 

fread an assign statement is not needed. 

Check your namelist file, espacially for invalid codes, types and levels. 

If all fails run the program with the Debug parameter mentioned above, e.g. 

mod21 < namelistfile > myoutput inputdata outputdata Debug 

Make the file myoutput readable for the public (using chmod 744 myoutput) and call the user support 

group at the DKRZ. 

3.4.2.6 Possible combinations of TYPE, CODE and MEAN 

TYPE CODE MEAN 

0-11 130 temperature 

131 u-velocity 

132 v-velocity 

133 specific humidity 

138 vorticity 

148 streamfunction 

149 velocity potential 

152 ln p s 

155 divergence 

20-70 All codes 0/1 

The four variables vorticity, divergence, streamfunction and velocity potential need special treatment if 

the output on pressure levels (TYPE > 20) is selected. They are not available as TYPEs 30, 40 and 41. 

If you select one of those combinations, TYPE is automatically switched to 70, 60 and 61 respectively. 

PAGE 3.4.2.5 

0


PAGE 3.4.2.6

3.4.3 Listing of file contents 







PAGE 3.4.3

3.4.3.1 GGSTAT GGSTATS 

Calling sequences 

Purposes 

Input file 

Listing 

Notes 

Example 

GGSTAT infile 

GGSTATS infile 


GGSTAT Print header information and simple statistics for each field in a file. 

GGSTATS Print header information for each field in a file. 

infile Required Grid and/or spectral file 

For each field both programs print 

• the record number 

• a specification of GRID or spherical harmonics (SPEC) 

• the code 

• the level (either hektopascal or sigma level number) 

• GRID - no. of latitudes and longitudes 

• SPEC - dimensions with product giving length of field 

Additionally GGSTAT prints 

• internal number of data mask (0 means no mask) 

• pack size in bits per data value 

• GRID - minimum, maximum, mean and variance of field 

• SPEC - mean of field 

One line is printed for each record in the file, this may result in a very large printer output. 

If minimum, maximum, mean and variance are not needed, use the much faster GGSTATS. 

None 

PAGE 3.4.3.1

3.4.3.2 GGSTATT GGSTATM 


Purposes 

Input file 


Example 

GGSTATT infile 

GGSTATM infile 


GGSTATT Print number of fields per date in a file. 

GGSTATM Print number of fields per month in a file. 


One line is printed for each date/month in the file, this may result in a large printer output. 

On page 3.5.5 

PAGE 3.4.3.2

3.4.3.3 GGDIFF 


Purpose 

Input files 

Listing 


Examples 

GGDIFF infile1 infile2 


GGDIFF Print statistics over differences of two files 

infile1 Required Grid and/or spectral file 


For each pair of fields the program prints 

• the record number 

• a specification of GRID or spherical harmonics (SPEC) 

• the code 

• the level (either in hPa or as sigma level number) 

• GRID - no. of latitudes and longitudes 

• SPEC - dimensions with product giving length of field 

• internal number of data mask (0 means no mask) 

• pack size in bits per data value 

• occurrence of coefficients pairs with different signs 

• occurrence of zero values 

• the maximum absolute difference of coefficient pairs 

• the maximum relative difference of non-zero coefficient pairs with equal signs 

One line is printed for each record pair in the files, this may result in a very large printer output. 

If header informations on input files do not match, the program stops. 


PAGE 3.4.3.3


3.4.4 Selection of fields and splitting of files according to miscellaneous criteria 


3.4.4.1 FLDSEL Alias for SELECT to avoid conflicts with Korn shell command select 













PAGE 3.4.4


3.4.4.1 SELECT DATESEL YEARSEL MONSEL DAYSEL DAMSEL HOURSEL 


Purpose 

Input file 

Output files 

SELECT infile out01 out02 ... out88 

DATESEL infile out01 out02 ... out88 

YEARSEL infile out01 out02 ... out88 

MONSEL infile out01 out02 ... out88 

DAYSEL infile out01 out02 ... out88 

DAMSEL infile out01 out02 ... out88 

HOURSEL infile out01 out02 ... out88 

SELECT Select fields according to specified codes, levels and timesteps from infile. 

DATESEL Select a time range from infile 

YEARSEL Select a year range from infile 

MONSEL Select a month range within each year from infile 

DAYSEL Select a day range within each year from infile 

DAMSEL Select a day range within each month from infile 

HOURSEL Select a hour range within each day from infile 


out01 Required File for first code selected or all codes 

out02 Files for optional second to 

out88 88th code 

Input parameters 

nt1 First time step Integer Default is from start of input file 

nt2 Last time step Integer Default is until end of input file 

nti Time step increment Integer Default is 1 

lv1 First level Integer Default is vacuum 

lv2 Last level Integer Default is ground level 

PAGE 3.4.4.1


Examples 


level Levels to be selected Integer array(20) Default is all levels. 

file Files to be written Integer array(256) For default see below. 

code Codes to be selected for Integer array(256) For default see below 

outputfiles 

type Types to be selected for Integer array(256) For default see below 

outputfiles 

A code equal -1 selects all codes on infile. The first matching element is used, so a ‘-1’ terminating 

the code sequence collects all codes not explicitly selected. 

• The number of output files specified must be one or must match the number of codes 

selected (including a terminating ‘-1’, if present). 

• Specification of parameters level and lv1/lv2 is mutually exclusive. 

• If nt1 greater nt2, date ranges are wrapped around interval bounds. 

On page 3.5.5 and page 3.5.10 to page 3.5.13 

PAGE 3.4.4.1

3.4.4.2 SPLITM SPLITD SPLITH 


Purposes 

Input file 

SPLITM infile outfile 

SPLITD infile outfile 

SPLITH infile outfile 


SPLITM Split file to several files, one for each month of year 

SPLITD Split file to several files, one for each day of month 

SPLITH Split file to several files, one for each hour of day 


Output file(s) 


Example 

outfile Optional Prefix for output files named outfilexx with outfile replaced by the name 

given on the command line and xx replaced by a two-digit date number part. 

Default is name specified for file infile. 

Fields of same month/day/hour in different years/month/day are collected to one file. Thus maximum 

number of output files is 12/30(31)/24. 

Be sure to provide two additional characters for date information in output file names. 

On page 3.5.24 

PAGE 3.4.4.2

3.4.4.3 SPLITY 


Purpose 

Input file 

Output files 

Note 

Example 

SPLITY infile outfile 


SPLITY Split file to several files, one for each year 


outfile Optional Prefix for output files named outfileyy with outfile replaced by the name 

given on the command line and yy replaced by two-digit year numbers. 


Year numbers greater than 99 are coded as ‘a0’ to ‘a9’, ‘b0’ etc. to guarantee correct lexical order 

of output files. 

Be sure to provide two additional characters for date information in output file names. 


PAGE 3.4.4.3

3.4.4.4 SPLITS 


Purpose 

Input file 

Output files 

SPLITS infile outfile 


SPLITS Split file to several files with equal numbers of sets 


outfile Optional Prefix for up to 359 output files named outfilenn with outfile replaced by 

the name given on the command line and nn replaced by numbers starting from 01. 




Example 

nsets Number of sets for each output file Integer Default is 1. 

File numbers greater than 99 are coded as ‘a0’ to ‘a9’, ‘b0’ etc. to guarantee correct lexical order 

of output files. 

Be sure to provide two additional characters for numbering in output file names. 


PAGE 3.4.4.4

3.4.4.5 SPLITC SPLITL 


Purpose 

Input file 

Output files 


Example 

SPLITC infile outfile 

SPLITL infile outfile 


SPLITC Split file to several files, one for each code 

SPLITL Split file to several files, one for each level 


outfile Optional Prefix for output files named outfilennn with outfile replaced by the name given 

on the command line and nnn replaced by three-digit code or level numbers. 


Level numbers greater than 999 are coded as ‘a00’ to ‘a99’, ‘b00’ etc. to guarantee correct lexical 

order of output files. 

Be sure to provide three additional characters for code/level information in output file names. 


PAGE 3.4.4.5


PAGE 3.4.4.5


3.4.5 Selection and conversion of parts of fields 









3.4.5.5 ZXCOLT Collect slices or small windows and combine them to two-dimensional fields 

PAGE 3.4.5

3.4.5.1 WINDOW 


Purpose 

Input file 

Output file 

WINDOW infile outfile 


WINDOW Extract windows from grid fields 

infile Required Grid file 

outfile Required File for windows 



Examples 

lon1 First longitude of output field Integer Default is first longitude of input field 

lon2 Last longitude of output field Integer Default is last longitude of input field 

loni Longitude increment Integer Default is 1 

lat1 First latitude of output field Integer Default is first latitude of input field 

lat2 Last latitude of output field Integer Default is last latitude of input field 

lati Latitude increment Integer Default is 1 

If lon1 greater lon2, window is wrapped around input array bounds. 

For lon1 equal to lon2+1, the entire input field is only shifted and the new field starts with the 

former lon1 longitude. 

On page 3.5.1 to page 3.5.3 

PAGE 3.4.5.1

3.4.5.2 POINT 


Purpose 

Input file 

Output file 

POINT infile outfile 


POINT Extract single points from grid fields 


outfile Required File for points 


Examples 

lon Longitudes of points Integer array(255) No default 

lat Latitudes of points Integer array(255) No default 


PAGE 3.4.5.2

3.4.5.3 SLICE 


Purpose 

Input file 

Output file 

SLICE infile outfile 

SLICE Extract slices from grid fields 


outfile Required File for slices 


Examples 


icr List of longitudes or latitudes to be selected Integer(100) No default 

kcr Switch to select latitude or longitude Integer No default 

• 0 longitude 

• 1 latitude 

On page 3.5.2 and page 3.5.3 

PAGE 3.4.5.3

3.4.5.4 ROTATE 


Purpose 

Input file 

Output file 

ROTATE infile outfile 

ROTATE Rotate grid fields 


outfile Required File for slices 


Examples 


icr Orientation of output fields Integer No default 

Combined operations are requested as sum of single operation codes. 

• 0 no change 

• 1 invert north/south 

• 2 invert east west 

• 4 switch lat/long (done first) 


PAGE 3.4.5.4

3.4.5.5 ZXCOLL ZXCOLC ZXCOLD 


Purpose 

Input file 

Output file 


Examples 

ZXCOLL infile outfile 

ZXCOLC infile outfile 

ZXCOLT infile outfile 


ZXCOLL Collect slices or small windows of same code and combine them to 


ZXCOLC Collect slices or small windows of same level and combine them to 


ZXCOLT Collect slices or small windows and combine them to two-dimensional fields 

infile Required Grid file of slices or small windows 

outfile Required File for cross-sections 

If infile contains multi-level slice sets then outfile will contain zonal or meridional cross-sections. 

Fields in infile combined to the same field in outfile must have same date, type, lat and long information. 

On page 3.5.2 to page 3.5.4, and page 3.5.19 

PAGE 3.4.5.5

3.4.6 Unary operators 









3.4.6.1 LOG10 outfile = log 10 (infile) (log 10 (0) := 0) 

3.4.6.2 XLIN outfile = a · infile + b 



PAGE 3.4.6


3.4.6.1 ABS SIGN INV SQUARE SQROOT EXPONE LOGE LOG10 


Purposes 

Input file 

Output file 

Example 

ABS infile outfile 

SIGN infile outfile 

INV infile outfile 

SQUARE infile outfile 

SQROOT infile outfile 

EXPONE infile outfile 

LOGE infile outfile 

LOG10 infile outfile 

ABS outfile = abs(infile) 

SIGN outfile = sign(infile) 

INV outfile = 1/infile (1/0=0) 

SQUARE outfile = infile2 SQROOT outfile = sqrt(infile) 

EXPONE outfile = e infile 

LOGE outfile = ln(infile) (ln(0):=0) 

LOG10 outfile = log 10 (infile) (log 10 (0) := 0) 


outfile Required File containing function value of infile 

On page 3.5.9, page 3.5.14, page 3.5.15, page 3.5.17, and page 3.5.18 

PAGE 3.4.6.1

3.4.6.2 XLIN 


Purpose 

Input file 

Output file 

XLIN infile outfile 

XLIN outfile = a · infile + b 


infile Required Grid and/or spectral File 

outfile Required Result a · infile + b 

Input parameter 


Example 

code Codes Integer array(100) Default is 100 * -1 

Code -1 matches all codes 

level Levels Integer array(100) Default is 100 * -1 

Level -1 matches all levels 

a Multiplying factors Real array(100) Default is 100 * 1. 

b Additive constants Real array(100) Default is 100 * 0. 

May be non-zero for grid fields only 

For each input fields the lists of code and level are searched for a matching pair. The corresponding 

values for a and b are used for computation. 


PAGE 3.4.6.2

3.4.6.3 FPOW 


Purpose 

Input file 

Output file 

FPOW infile outfile 

FPOW outfile = infile pow (0 pow =0) 


outfile Required Result infile pow 


Examples 


pow Exponent Real Required 


PAGE 3.4.6.3

3.4.6.4 FMASK 


Purpose 

Input file 

Output file 

FMASK infile outfile 


FMASK Create floating point mask according to arithmetic comparison 


outfile Required vyes/vno mask fields 


Example 

lop Logical operator (eq,ne,lt,le,gt,ge) Character*2 Default is ‘ge’ 

value Comparison value for lop Real Default is 0. 

vyes Value set where condition (x.lop.value) holds Real Default is 1. 

vno Value set where condition does not hold Real Default is 0. 

On page 3.5.9 

PAGE 3.4.6.4

DKRZ GRIB/EXTRA Format Module Documentation

3.4.7 Binary operators 











3.4.7.4 PADD (set of) outfile = (set of) infile1 + (field of) infile2 

3.4.7.4 PSUB (set of) outfile = (set of) infile1 - (field of) infile2 

3.4.7.4 PMLT (set of) outfile = (set of) infile1 * (field of) infile2 

3.4.7.4 PDIV (set of) outfile = (set of) infile1 / (field of) infile2 

PAGE 3.4.7

3.4.7.1 ADD SUB MLT DIV 


Purpose 

Input files 

Output file 

Examples 

ADD infile1 infile2 outfile 

SUB infile1 infile2 outfile 

MLT infile1 infile2 outfile 

DIV infile1 infile2 outfile 

ADD outfile = infile1 + infile2 

SUB outfile = infile1 - infile2 

MLT outfile = infile1 * infile2 


DIV outfile = infile1 / infile2 (x/0:=0) 

infile1 Required Grid and/or spectral (for ADD and SUB) file 

infile2 Required Grid and/or spectral (for ADD and SUB) file 

outfile Required Sum, difference, product or quotient of infile1 and infile2 

On page 3.5.7 to page 3.5.14, page 3.5.17 and page 3.5.18 

PAGE 3.4.7.1

3.4.7.2 XYLIN 


Purpose 

Input files 

Output file 

XYLIN infile1 infile2 outfile 


XYLIN outfile = a * infile1 + b * infile2 + c 



outfile Required Result a * infile1 + b * infile2 + c 


Examples 

a Multiplying factor for infile1 Real Default is 1. 

b Multiplying factor for infile2 Real Default is 1. 

c Additive constant Real Default is 0. 

May be non-zero for grid fields only 


PAGE 3.4.7.2

3.4.7.3 GADD GSUB GMLT GDIV 


Purpose 

Input files 

Output file 

Example 

GADD infile1 infile2 outfile 

GSUB infile1 infile2 outfile 

GMLT infile1 infile2 outfile 

GMLT infile1 infile2 outfile 


GADD outfile = infile1 + (first record of) infile2 

GSUB outfile = infile1 - (first record of) infile2 

GMLT outfile = infile1 * (first record of) infile2 

GDIV outfile = infile1 / (first record of) infile2 

infile1 Required Grid or spectral (for GADD and GSUB) file 


outfile Required Sum, difference, product or quotient of infile1 and first record of infile2 

with appropriate dimension 


PAGE 3.4.7.3

3.4.7.4 PADD PSUB PMLT PDIV 


Purpose 

Input files 

Output file 


Example 

PADD infile1 infile2 outfile 

PSUB infile1 infile2 outfile 

PMLT infile1 infile2 outfile 

PDIV infile1 infile2 outfile 


PADD (set of) outfile = (set of) infile1 + (field of) infile2 

PSUB (set of) outfile = (set of) infile1 - (field of) infile2 

PMLT (set of) outfile = (set of) infile1 * (field of) infile2 

PDIV (set of) outfile = (set of) infile1 / (field of) infile2 

infile1 Required Grid and/or spectral (PADD and PSUB) file 

infile2 Required Grid and/or spectral (PADD and PSUB) file 

outfile Required Sum, difference, product or quotient of sets of infile1 and fields of infile2 

There must be one multi-level set in infile1 for each field in infile2. 


PAGE 3.4.7.4



3.4.8 Conversion and concatenation of files in extra and service/afterburner format 















PAGE 3.4.8


3.4.8.1 GRB2EXT GRB2SRV GRB2EXP GRB2SRP GRB2EXF GRB2SRF 


Purposes 

Input file 

Output file 

Parameters 


Example 

GRB2EXT infile outfile 

GRB2SRV infile outfile 

GRB2EXP infile outfile 

GRB2SRP infile outfile 

GRB2EXF infile outfile 

GRB2SRF infile outfile 

GRB2EXT File conversion - grib to blocked extra format 

GRB2SRV File conversion - grib to blocked service/afterburner format 

GRB2EXP File conversion - grib to unblocked extra format 

GRB2SRP File conversion - grib to unblocked service/afterburner format 

GRB2EXF File conversion - grib to formatted extra format 

GRB2SRF File conversion - grib to formatted service/afterburner format 

infile Required File in grib format 

outfile Required File in extra or service/afterburner format blocked, unblocked or formatted 

hform Format of header records Character * 80 Default is ‘(8i10)’ 

dform Format of data records Character * 80 Default is ‘(10e13.6)’ 

Format parameters are allowed for GRB2EXF and GRB2SRF only. 

Be sure to include parentheses in format specifications. 


PAGE 3.4.8.1


3.4.8.2 EXT2GRB SRV2GRB EXP2GRB SRP2GRB EXF2GRB SRF2GRB 


Purposes 

Input file 

Output file 

Parameters 

EXT2GRB infile outfile 

SRV2GRB infile outfile 

EXP2GRB infile outfile 

SRP2GRB infile outfile 

EXF2GRB infile outfile 

SRF2GRB infile outfile 

EXT2GRB File conversion - blocked extra to grib format 

SRV2GRB File conversion - blocked service/afterburner to grib format 

EXP2GRB File conversion - unblocked extra to grib format 

SRP2GRB File conversion - unblocked service/afterburner to grib format 

EXF2GRB File conversion - formatted extra to grib format 

SRF2GRB File conversion - formatted service/afterburner to grib format 

infile Required File in extra or service/afterburner format blocked, unblocked or formatted 

outfile Required File in grib format 

lat Latitude values Integer array(20) Default is 32, 64, 96, 128, 160, 

21, 42, 64, 85, 106 

long Longitude values Integer array(20) Default is 64, 128, 192, 256, 320, 

21, 42, 64, 85, 106 

dim Dimension values Integer array(20) Default is 2048, 8192, 18432, 32768, 51200, 

506, 1892, 4290, 7482, 11556 

PAGE 3.4.8.2


Example 


type Data type values Integer array(20) Default is 4, 4, 4, 4, 4, 

50, 50, 50, 50, 50 

0 means lat/long grid 

4 means gaussian grid 

50 means spherical harmonics. 

hour Hour to be inserted Integer Default is 0 

in grib records Only used for conversion from extra format 

pack Number of bits for Integer Default is 16 

each data value Only multiples of 8 allowed 

in grib records 

hform Format of Character * 80 Default is ‘(8i10)’ 

header records 

dform Format of Character * 80 Default is ‘(10e13.6)’ 

data records 

Arrays lat, long and dim are searched for a triple, where either dim or the product of lat and long 

matches either the dimension or the product of the lat/long specification of the input field. These 

values and the corresponding type are used for grib output. 

Defaults values are specifications for grid and spectral fields of T21, T42, T63, T84 and T106. 

These specifications remain effective after user-specified values. 

For conversion from service/afterburner format type 4 (gauss-grid) is used as a last choice. 

Format parameters are allowed for EXF2GRB and SRF2GRB only. 

Be sure to include parentheses in format specifications. 

By default, no parameters are read for unformatted input files 


PAGE 3.4.8.2 a

3.4.8.3 CATEXTF CATSRVF 


Purposes 

Input files 


CATEXTF outfile infile1 infile2 ... infile88 

CATSRVF outfile infile1 infile2 ... infile88 

CATEXTF Concatenate up to 88 files in blocked extra format 

CATSRVF Concatenate up to 88 files in blocked service/afterburner format 

infile1 

. Optional Extra- or service-/afterburner-format files 

infile88 

Output file 


Example 

outfile Required File in same format containing data of files infile1 to infile88 

Unblocked and formatted files can be concatenated using the UNIX command ‘cat’. 


PAGE 3.4.8.3



3.4.9 Computation of averages, minima and maxima over fields 











PAGE 3.4.9

3.4.9.1 GLOBAVG 


Purpose 

Input file 

Output file 


Examples 

GLOBAVG infile outfile 


Compute the surface mean of input fields using weight factors for latitudes 


outfile Optional File containing the surface mean of infile fields in fields of same size 

If outfile is not specified, the computed values are only listed 


PAGE 3.4.9.1

3.4.9.2 FLDAVG FLDMIN FLDMAX 


Purpose 

Input file 

Output file 

Example 

FLDAVG infile outfile 

FLDMIN infile outfile 

FLDMAX infile outfile 


FLDAVG Compute mean of input fields 

FLDMIN Compute minima of input fields 

FLDMAX Compute maxima of input fields 


outfile Required File containing the minimum, maximum or mean of input fields 

expanded to fields of same size 


PAGE 3.4.9.2


3.4.9.3 ZONAVG ZONMIN ZONMAX MERAVG MERMIN MERMAX 


Purpose 

Input file 

Output file 

Example 

ZONAVG infile outfile 

ZONMIN infile outfile 

ZONMAX infile outfile 

MERAVG infile outfile 

MERMIN infile outfile 

MERMAX infile outfile 

ZONAVG Compute zonal averages of input fields 

ZONMIN Compute zonal minima of input fields 

ZONMAX Compute zonal maxima of input fields 

MERAVG Compute meridional averages of input fields 

MERMIN Compute meridional minima of input fields 

MERMAX Compute meridional maxima of input fields 


outfile Required File containing a vector of zonal/meridional averages/minima/maxima 

for each input field 


PAGE 3.4.9.3


3.4.10 Computation of averages, minima, maxima, sums and deviations over time 

series 




















PAGE 3.4.10

3.4.10.1 TIMAVG TIMMIN TIMMAX 


Purpose 

Input files 

Output file 


Example 

TIMAVG infile1 outfile 

TIMMIN infile1 outfile 

TIMMAX infile1 outfile 

TIMAVG Compute time average. 

TIMMIN Compute time minimum. 

TIMMAX Compute time maximum. 



outfile Required File containing the mean/minimum/maximum of the fields in infile1 

Input fields are collected to the same result field only if they match by type, code, level and 

dimensions. 


PAGE 3.4.10.1


3.4.10.2 MONAVG MONMIN MONMAX YEARAVG YEARMIN YEARMAX 


Purpose 

Input file 

Output file 


Example 

MONAVG infile outfile 

MONMIN infile outfile 

MONMAX infile outfile 

YEARAVG infile outfile 

YEARMIN infile outfile 

YEARMAX infile outfile 

MONAVG Compute monthly averages. 

MONMIN Compute monthly minima. 

MONMAX Compute monthly maxima. 

YEARAVG Compute yearly averages. 

YEARMIN Compute yearly minima. 

YEARMAX Compute yearly maxima. 

infile Required Grid or spectral file 

outfile Required File containing one set for each month/year which is the 

mean/minimum/maximum of all the sets for this month/year in infile 

Maximum number of fields is 20. 


PAGE 3.4.10.2

3.4.10.3 SELAVG SELMIN SELMAX 


Purpose 

Input file 

Output file 

SELAVG infile outfile 

SELMIN infile outfile 

SELMAX infile outfile 


SELAVG Compute time range averages. 

SELMIN Compute time range minima. 

SELMAX Compute time range maxima. 


outfile Required File containing one set for each time range which is the 

mean/minimum/maximum of all the sets of this time range in infile 


Examples 

ndates Number of dates for one average field Integer No default 


PAGE 3.4.10.3

3.4.10.4 LMEAN LMMIN LMMAX 


Purpose 

Input file 

Output file 

Example 

LMEAN infile outfile 

LMMIN infile outfile 

LMMAX infile outfile 


LMEAN Compute multi-year monthly averages. 

LMMIN Compute multi-year monthly minima. 

LMMAX Compute multi-year monthly maxima. 


outfile Required File containing one set for each month which is the 

mean/minimum/maximum of all the sets for this month in all years. 


PAGE 3.4.10.4

3.4.10.5 ANOMAL 


Purpose 

Input files 

Output file 


Example 

ANOMAL infile1 infile2 outfile 


ANOMAL Subtract multi-year monthly time averages from a time series. 

infile1 Required Grid or spectral file 

infile2 Required File containing one set for each month which is the mean of all the sets 

in infile1 for this month in all years 

outfile Required File containing the difference between infile1 and the corresponding 

fields in infile2 for the same month 

File infile2 should have been created by a call LMEAN infile1 infile2 


PAGE 3.4.10.5

3.4.10.6 STDDEV 


Purpose 

Input file 

Output file 

Example 

STDDEV infile outfile 


STDDEV Calculate local standard deviation 


outfile Required File containing the standard deviation for each input field 


PAGE 3.4.10.6

3.4.10.7 LMSTDV 


Purpose 

Input file 

Output file 

Example 

LMSTDV infile outfile 


LMSTDV Compute multi-year monthly standard deviations. 


outfile Required File containing one set for each month which is the standard deviation 

of all the sets for this month in all years. 


PAGE 3.4.10.7

3.4.10.8 TIMDEV 


Purpose 

Input file 

Output file 


Example 

TIMDEV infile1 infile2 outfile 


TIMDEV Compute deviation from time average 



outfile Required File containing one field for each field in infile1 which is the difference 

of that field to the corresponding field in infile2 

infile2 should have been created by TIMAVG infile1 infile2 


PAGE 3.4.10.8


3.4.11 Annual cycle programs 





PAGE 3.4.11

3.4.11.1 FINDAN 


Purpose 

Input file 

Output file 


Example 

FINDAN infile outfile 


FINDAN Determine annual cycle (1st and 2nd annual harmonic) of daily data 


outfile Required Annual cycle fields: a0, a1, b1, a2, b2 

For fields in infile the condition 

x(t) = a0 + a1 * cos(w t) + b1 * sin(w t) + a2 * cos(2 w t) + b2 * sin(2 w t) 

holds with w=2π/(number of days per year) 


PAGE 3.4.11.1

3.4.11.2 SUBTAN 


Purpose 

Input file 

Output file 


Example 

SUBTAN infile1 infile2 outfile 


SUBTAN Subtract annual cycle (1st and 2nd annual harmonic) from daily data 

infile1 Required Grid file 

infile2 Required Annual cycle fields: a0, a1, b1, a2, b2 

outfile Required Difference of infile1 to annual cycle 

infile2 should have been created by FINDAN infile1 infile2 


PAGE 3.4.11.2

3.4.11.3 CRETAN 


Purpose 

Input file 

Output file 


Example 

CRETAN infile outfile 


CRETAN Create annual cycle (1st and 2nd annual harmonic) of daily data 

infile Required Annual cycle fields: a0, a1, b1, a2, b2 

outfile Required Daily fields of annual cycle 

infile should have been created by FINDAN somefile infile 


PAGE 3.4.11.3

3.4.12 Others 







PAGE 3.4.12

3.4.12.1 CORREL 


Purpose 

Input files 

Output file 

Example 

CORREL infile1 infile2 outfile 

CORREL Calculate correlation 




outfile Required Correlation of corresponding fields 

On page 3.5.1 

PAGE 3.4.12.1

3.4.12.2 CORRWM 


Purpose 

Input files 

Output file 

CORRWM infile1 infile2 outfile 


CORRWM Calculate correlation to window mean 



outfile Required Correlation of each field in infile1 to the mean of a window of the 

corresponding field in infile2 



Example 

lon1 First longitude of window used Integer Default is first longitude of input field 

lon2 Last longitude of window used Integer Default is last longitude of input field 

lat1 First latitude of window used Integer Default is first latitude of input field 

lat2 Last latitude of window used Integer Default is last latitude of input field 

If lon1 greater lon2, window is wrapped around input array bounds. 

On page 3.5.1 

PAGE 3.4.12.2

3.4.12.3 GSCOPY 


Purpose 

Input file 

Output file 

Parameter 

Examples 

GSCOPY infile outfile 


GSCOPY File conversion from one-level to multi-level sets 


outfile Required Multi-level set for each field in infile 

lev Level values Integer array(20) Required 


PAGE 3.4.12.3

3.4.12.4 ACCU 


Purpose 

Input file 

Output file 

Example 

ACCU infile outfile1 outfile2 

ACCU Accumulate time series 



outfile1 Required Accumulated sum of infile 

outfile2 Optional Copy of last record of outfile1 


PAGE 3.4.12.4

3.4.12.5 CHEAD 


Purpose 

Input file 

Output file 

Parameters 


Examples 

CHEAD infile outfile 


CHEAD Change grib header specifications 


outfile Required File with changed headers 

ocode Old code values Integer array(255) Optional 

A code equal -1 selects all codes on infile. The first matching element is used, so a ‘-1’ terminating 

the code sequence collects all codes not explicitly selected. 

ncode New code values Integer array(255) Optional 

olevel Old level values Integer array(100) Optional 

nlevel New level values Integer array(100) Optional 

A level equal -1 selects all levels on infile. The first matching element is used, so a ‘-1’ terminating 

the level sequence collects all levels not explicitly selected. 

ntstart Starting date Integer Optional 

ntinc Date increment Integer Optional 

neqdat Number of fields with equal date Integer Optional 

The number of ncode and nlevel values specified must match the number of ocode and olevel values 

(including a terminating ‘-1’, if present). 

Times are specified as YYYMMDDHH. 

If parameter ntinc is specified and neqdat is not, time on outfile changes whenever time on infile 

does. 

If a parameter group (code, level or time) is not specified, the file header values are not changed. 


PAGE 3.4.12.5

3.5 EXAMPLES 

DKRZ GRIB Format Module Documentation 

# 

# Example for programs WINDOW, CORREL and CORRWM 

# 

# Correlation of two time series files. 

# One grid point is needed only. 

# This is done in three different ways. 

# 

# out1, out2 and out3 will contain similar data 

# 

# 

# Parameters for WINDOW and CORRWM 

# 

cat >params


# 

# Example for programs WINDOW, SLICE and ZXCOLL 

# 

# Get longitudinal cross sections in two different ways 

# 

# Files tmp1 and tmp2 will contain similar data 

# Files out1 and out2 will contain similar data 

# 

# 

# Get longitudes as slices of input fields 

# 

SLICE in1 tmp1


# 

# Example for programs WINDOW, SLICE and ZXCOLL 

# 

# Get latitudinal cross sections in two different ways 

# 

# Files tmp1 and tmp2 will contain similar data 


# 

# 

# Get latitudes as slices of input fields 

# 

SLICE in1 tmp1


# 

# Example for programs ZONAVG and ZXCOLL 

# 

# 

# Get zonal averages of fields in multi-level sets 

# 

ZONAVG in1 tmp1 

# 

# Collect zonal average sets to two-dimensional fields 

# 

ZXCOLL tmp1 out1 

# 

PAGE 3.5.4


# 

# Example for programs GGSTATM, GGSTATT, MONSEL, DMDSEL and HOURSEL 

# 

# Select specified dates from a time series and show intermediate 

# results using the appropriate list programs 

# 

# List number of fields for each month 

# 

GGSTATM in1 

# 

# Select months december, january and february 

# 

MONSEL in1 out1


# 

# Example for programs FINDAN, SUBTAN and CRETAN 

# 

# 

# Compute annual cycle coefficients 

# 

FINDAN in1 tmp1 

# 

# Subtract annual cycle from original field 

# 

SUBTAN in1 tmp1 out1 

# 

# Create annual cycle file 

# 

CRETAN in1 out1 

# 

PAGE 3.5.6

# 

# Example for programs ADD and XYLIN 

# 

# Adding two files in two different ways 

# 

# Files out1 and out2 will contain similar data. 

# Of course, ADD does the faster job. 

# 

# 

# Add input files 

# 

ADD in[12] out1 

# 

# Add input files with default coefficients 

# 

XYLIN - in[12] out2 

# 


PAGE 3.5.7


# 

# Example for programs SUB and XYLIN 

# 

# Subtracting two files in two different ways 

# 


# Of course, SUB does the faster job. 

# 

# 

# Subtract input files 

# 

SUB in[12] out1 

# 

# Add input files with coefficient -1 for second input file 

# 

XYLIN in[12] out2


# 

# Example for programs ABS, SIGN, MLT and FMASK 

# 

# Put data file to absolute value in two different ways 

# 


# Files tmp1 and tmp2 will contain similar data. 

# 

# 

# Get absolute values of input file 

# 

ABS in1 out1 

# 

# Get sign of input file 

# 

SIGN in1 tmp1 

# 

# Multiply with sign to get absolute values 

# 

MLT in1 tmp1 out2 

# 

# Get sign of input field by logical comparison 

# 

FMASK in1 tmp2


# 

# Example for programs SELECT, GSCOPY, ADD, PADD 

# 

# Add one level to all levels in sets in two different ways. 

# 


# 

# 

# Select all codes with non-zero levels 

# 

SELECT in1 tmp1


# 

# Example for programs SELECT, GSCOPY, SUB, PSUB 

# 

# Subtract one level from all levels in sets in two different ways. 

# 


# 

# 


# 

SELECT in1 tmp1


# 

# Example for programs SELECT, GSCOPY, MLT, PMLT 

# 

# Multiply all levels in sets by one level in two different ways. 

# 


# 

# 


# 

SELECT in1 tmp1


# 

# Example for programs SELECT, GSCOPY, DIV, PDIV 

# 

# Divide all levels in sets by one level in two different ways. 

# 


# 

# 


# 

SELECT in1 tmp1


# 

# Example for programs SQUARE, MLT and FPOW 

# 

# Get square of file in three different ways. 

# 

# Files out1, out2 and out3 will contain similar data. 

# 

# 

# Get square values of input file 

# 

SQUARE in1 out1 

# 

# Multiply input file by itself 

# 

MLT in1 in1 out2 

# 

# Raise input file to power two 

# 

FPOW in1 out3


# 

# Example for programs SQROOT and FPOW 

# 

# Get square root of file in two different ways. 

# 


# 

# 

# Get square root of input file 

# 

SQROOT in1 out1 

# 

# Raise input file to power 1/2 

# 

FPOW in1 out2


# 

# Example for program TIMAVG and concatenation of GRIB-files 

# 

# Files out1, out2 and out3 will contain similar data. 

# 

# 

# Concatenate all input files 

# 

cat in[123] >tmp1 

# 

# Get average of concatenated files 

# 

TIMAVG tmp1 out1 

# 

# Get average of first input file 

# 

TIMAVG in1 tmp2 

# 

# Get average of second input file adding result of previous run 

# 

TIMAVG in2 tmp3 tmp2 

# 

# Get average of third input file adding result of previous runs 

# 

TIMAVG in3 out2 tmp3 

# 

# Get average of second input file 

# 

TIMAVG in2 tmp4 

# 

# Concatenate averages of first and second input file 

# 

cat tmp2 tmp4 >tmp5 

# 

# Get average of third input file adding results of previous runs 

# 

TIMAVG in3 out3 tmp5 

# 

PAGE 3.5.16

# 

# Example for programs DIV, INV and MLT 

# 

# Divide two files in two different ways 

# 


# 

# 

# Divide input files 

# 

DIV in[12] out1 

# 

# Get reciprocal value 

# 

INV in2 tmp1 

# 

# Multiply with reciprocal value 

# 

MLT in1 tmp1 out2 

# 


PAGE 3.5.17


# 

# Example for programs EXPONE, SQUARE, LOGE, ADD and XLIN 

# 

# Double file in three different ways 

# 

# Files out1, out2 and out3 will contain similar data 

# 

# 

# Double input file 

# 

XLIN in1 out1


# 

# Example for programs MERAVG and ZXCOLL 

# 

# 

# Get meridional averages of fields in multi-level sets 

# 

MERAVG in1 tmp1 

# 

# Collect meridional average sets to two-dimensional fields 

# 

ZXCOLL tmp1 out1 

# 

PAGE 3.5.19


# 

# Example for programs MONAVG and SELAVG 

# 

# Get monthly averages in two different ways 

# 


# 

# 

# Get monthly averages 

# 

MONAVG in1 out1 

# 

# Get monthly averages by counting dates, two dates per day 

# 

SELAVG in1 out2


# 

# Example for programs YEARAVG and SELAVG 

# 

# Get yearly averages in two different ways 

# 


# 

# 

# Get yearly averages 

# 

YEARAVG in1 out1 

# 

# Get yearly averages by counting dates, two dates per day 

# 

SELAVG in1 out2


# 

# Example for programs CNV2EXT, CNV4EXT and CATEXTF and 

# concatenation of GRIB-files 

# 



# 

# 

# Convert first input file 

# 

CNV2EXT in1 tmp1 

# 

# Convert second input file 

# 

CNV2EXT in2 tmp2 

# 

# Concatenate converted files 

# 

CATEXTF tmp[12] out1 

# 

# Convert back concatenated file using predefined dimensions 

# 

CNV4EXT - out1 out3 

# 

# Concatenate input files 

# 

cat in[12] >out2 

# 

# Convert concatenated file 

# 

CNV2EXT out2 out4 

# 

PAGE 3.5.22


# 

# Example for program XLIN 

# 


# 

# 

# Convert first input file 

# 

XLIN in out


# 

# Example for programs SPLITY and SPLITM 

# 

# Files yearmon.YYMM and monyear.MMYY will contain similar data. 

# Files in and yearmon will contain similar data. 

# 

# 

# Split input file to months 

# 

SPLITM in monyear. 

# 

# Split each month to years 

# 

for $monfile in monyear.?? 

do 

SPLITY $monfile 

done 

# 

# Concatenate single files 

# 

cat monyear.???? > monyear 

# 

# Split resorted file to years 

# 

SPLITY monyear yearmon. 

# 

# Split each year to months 

# 

for $yearfile in yearmon.?? 

do 

SPLITM $yearfile 

done 

# 

# Concatenate single files 

# 

cat yearmon.???? >yearmon 

# 

PAGE 3.5.24

4. THE EXTRA-FORMAT 


The EXTRA-Format is a very simple Format for data representation. This fact allows every user to transform 

his own data set into the EXTRA-Format easily and enable him to use the programs described in 

this section. 

4.1 STRUCTURE OF DATA SETS 

Each EXTRA-Format file consists of any number of pairs of records, i.e. it has the pattern: 

header-record data-record 

[header-record data-record [ etc.....] ] 

The header record gives information about the immediately-following data record. The header record 

comprises 4 or more binary integer values. These were written in a Fortran program using the statement: 

WRITE (UNIT) IDAT, IVAR, LEVEL, LEN 

The variables IDAT, IVAR, LEVEL and LEN represent respectively the Date, the Variable, the Height 

level and the field size of the following data record. Table 3 shows the possible values for IDAT, IVAR 

and LEVEL. The value for missing IDAT, IVAR or LEVEL is 9999. The variable LEN must be set to the 

number of field points, because it will be used in the read statement for the data record. All values for 

IVAR shown in Table 4 are frequently used with EXTRA- Format. These values can be converted to the 

values used in the GRIB-Format by adding 128 to the EXTRA values of IVAR. 

Each data record was written in Fortran using the statement: 

WRITE (UNIT) (DATA(I),I=1,LEN) 

where LEN is given in the immediately-preceding header record. The values of DATA are REAL values. 

The default value for missing data is 9.E99. 

A file may consist of any set of pairs of records. However, if the records are mixed in character, some 

program modules will not work. Therefore it is usual for a file to comprise a set of records similar in 

some way. For example, in a given file all data records should have the same length, but may differ in 

their dates, variables or levels. The field represented by the record are treated by the program modules 

as one-dimensional. Some of the program modules select records to analyze according to one or more 

of the parameters IDAT, IVAR and LEVEL. Other programs analyze all records in a file, so the user of 

such programs should ensure that he chooses only files for which all records indeed refer to the same 

variable and level. 

PAGE 4.1.1


Table 3 Meaning of the variables in the header record 

PARAMETER TYPE CONTENTS 

IDAT Integer Date 

YYYYMMDD 

with YYYY = year 

MM = month 

DD = day 

or: 

YYMMDD 

with YY = year 

MM = month 

DD = day 

or: 

NN 

with NN = running index 

IVAR Integer Code number of variable 

as defined in Table 4 and Table 5 

LEVEL Integer Height level in hPa. 

Surfaces are labeled with -100 

Sea level is labeled with -200 

LEN Integer Length of data record 

Table 4 Standard Model Codes for IVAR in EXTRA-Format (Sheet 1 of 4) 

Code Name of variable [unit] 

1 surface geopotential (orography) [m**2/s**2] 

2 temperature [K] 

3 u-velocity [m/s] 

4 v-velocity [m/s] 

5 specific humidity [kg/kg] 

6 Surface pressure [Pa] 

7 vertical velocity [Pa/s] 

9 precipitable water content [m] 

10 vorticity [1/s] 

11 surface temperature [K] 

12 surface soil wetness [m] 

13 snow depth [m] 

14 large scale precipitation [m/s] 

PAGE 4.1.2




15 convective precipitation [m/s] 

16 snow fall [m/s] 

17 boundary layer dissipation [W/m**2] 

18 surface sensible heat flux [W/m**2] 

19 surface latent heat flux [W/m**2] 

20 stream function [m**2/s] 

21 velocity potential [m**2/s] 

23 mean sea level pressure [Pa] 

24 log surface pressure 

25 liquid water content [kg/kg] 

27 divergence [1/s] 

28 geopotential height [gpm] 

29 relative humidity [fract.] 

30 tendency of surface pressure [Pa/s] 

31 

3 

u * 

[m**3/s**3] 

32 surface runoff [m/s] 


34 cloud cover [fract.] 

35 total cloud cover [fract.] 

36 total cloud cover [fract.] 

37 10m u-velocity [m/s] 

38 10m v-velocity [m/s] 

39 2m temperature [K] 

40 2m dew point temperature [K] 

41 surface temperature [K] 

42 deep soil temperature [K] 

43 10m wind speed [m/s] 

44 land sea mask [0: sea, 1: land] 

45 surface roughness [m] 

46 surface background albedo [fract.] 

47 surface albedo [fract.] 

48 surface solar radiation [W/m**2] 

PAGE 4.1.3




49 surface thermal radiation [W/m**2] 

50 top solar radiation [W/m**2] 

51 top thermal radiation [W/m**2] 

52 u-stress [Pa] 

53 v-stress [Pa] 

54 Evaporation [m/s] 

55 soil temperature [K] 

66 skin reservoir content of plants [m] 

67 u-gravity wave stress [Pa] 

68 v-gravity wave stress [Pa] 

69 gravity wave dissipation [W/m**2] 

73 maximum 2m-temperature [K] 

74 minimum 2m-temperature [K] 

75 top solar radiation upward [W/m**2] 

76 surface solar radiation upward [W/m**2] 

77 surface thermal radiation upward [W/m**2] 

78 snow temperature [K] 

79 soil temperature [K] 

80 " [K] 

81 " [K] 

82 sea ice cover [fract.] 

83 sea ice depth [m] 

84 vegetation type 

85 (effective) sea-ice skin temperature [K] 

86 maximum surface temperature [K] 

87 minimum surface temperature [K] 

88 maximum 10m-wind speed [m/s] 

89 maximum convective cloud tops [m] 

90 snow melt [m/s] 

92 residual surface heat budget [W/m**2] 

93 snow depth change [m/s] 


PAGE 4.1.4




95 cloud cover [fract.] 

96 top solar radiation in clear-sky areas [W/m**2] 

97 top thermal radiation in clear-sky areas [W/m**2] 

98 number of clear-sky events 

99 top solar radiation in overcast areas [W/m**2] 

100 top thermal radiation in overcast areas [W/m**2] 

101 number of overcast events 

102 vertically integrated specific humidity [kg/m**2] 

103 vertically integrated liquid water cont. [kg/m**2] 

104 glacier mask [0: no, 1: yes] 

113-127 tracer gases 

131 wind speed ((u**2 + v**2) 1/2 ) [m/s] 

132 total precipitation (14+15) [m] 

133 total top radiation (50+51) [W/m**2] 

134 total surface radiation (48+49) [W/m**2] 

135 net surface heat flux (18+19+48+49-92) [W/m**2] 

136 total surface water (14+15+54-32) [m] 

137 solar cloud forcing (50-96) [W/m**2] 

138 thermal cloud forcing (51-97) [W/m**2] 

139 total cloud forcing (50+51-96-97) [W/m**2] 

140 atmospheric solar radiation (50-48) [W/m**2] 

141 atmospheric thermal radiation (51-49) [W/m**2] 

142 total atmospheric radiation (50+51-48-49) [W/m**2] 

143 surface runoff (calc.as residual) (14+15+54-93) [m/s] 

144 mass stream function 

145 dps ⁄ dλ : zonal derivative of surface pressure 

146 dps ⁄ 

dφ : meridional derivative of surface pressure 

Table 5 Codes for IVAR in EXTRA-Format created by some programs 


503 Empirical Orthogonal Functions 

PAGE 4.1.5


Table 5 Codes for IVAR in EXTRA-Format created by some programs 


504 Principal Components 

520 Canonical correlation coefficient 

521 Canonical F-Map 

522 Canonical F-Component 

523 Canonical G-Map 

524 Canonical G-Component 

525 Local variances of F-Maps 

526 Local variances of G-Maps 

530 Frequency (spectral analyses) 

531 Variance of field A (spectral analyses) 

532 Variance of field B (spectral analyses) 

533 Phases (spectral analyses) 

534 Squared coherence (spectral analyses) 

PAGE 4.1.6

4.2 LIST OF AVAILABLE PROGRAMS 


The program modules that can read EXTRA-Format files are listed below. For detailed information 

about the programs, see section 4.6.1 to 4.6.12 

a) Listing in alphabetical order 

add add two files 4.6.3.1 

addrec merge two files record by record 4.6.7.1 

anomal calculate anomalies 4.6.4.1 

anorm normalize with standard deviation 4.6.5.1 

append copy first tape1 then tape2 to tape3 4.6.3.2 

avg average over all records 4.6.6.1 

boxavg average spatial fields over coarser grid 4.6.6.2 

cadd add a constant field 4.6.2.1 

cancor execute canonical correlation analysis 4.6.12.1 

cdiv divide by a constant field 4.6.2.2 

chanoso change field orientation (north ↔ south) 4.6.7.2 

circle cyclic completion of a two-dimensional field 4.6.7.3 

cmult multiply by a constant field 4.6.2.3 

coarse delete every second row and column from a two-dimensional field 4.6.7.4 

complet completion of a data file with dummy values 4.6.7.5 

crospec cross-spectral analysis 4.6.12.2 

csub subtract a constant field 4.6.2.4 

dform create formatted output 4.6.8.1 

dif calculate differences of time steps T+1 and T 4.6.4.2 

div divide two files 4.6.3.3 

edge values smaler/grtr than limit set to missing value 4.6.7.6 

eqdate equalize dates of two files 4.6.3.4 

findan find annual cycle of daily data 4.6.6.3 

forminv transformation of formatted to EXTRA-Format output 4.6.8.2 

foufil band pass filter 4.6.12.3 

ggstat produce a file statistic 4.6.9.1 

hovplot plot a hovmöller diagram 4.6.11.1 

ipwrva interpolate default and/or wrong values 4.6.7.7 

lookat short formated look at binary data 4.6.9.2 

lmean calculate long time mean 4.6.6.4 

ltsplot plot very long time series 4.6.11.2 

merge merge two fields 4.6.3.5 

PAGE 4.2.1


mkeof compute eigenvalues, EOFs and principal components 4.6.12.4 

mkeofnor compute eigenvalues, normed EOFs and normed principal components 4.6.12.5 

momean compute monthly means from daily data 4.6.6.5 

mult multiply two files 4.6.3.6 

norm normalize data to mean zero and stnd devn one 4.6.5.2 

recon reconstruct time series from anomalies and mean 4.6.4.3 

runmean calculate a running mean for every grid point 4.6.6.6 

sadd add a constant to data 4.6.1.1 

sdiv divide data by a constant 4.6.1.2 

selbox select a spatial box 4.6.10.1 

selmon select a special month or seasons 4.6.10.2 

selvar select variable and level 4.6.10.3 

smult multiply data by a constant 4.6.1.3 

splirec split one file into two, record by record 4.6.7.8 

split split one file into two parts 4.6.7.9 

ssub subtract a constant from data 4.6.1.4 

sub subtract two files 4.6.3.7 

subtan subtract anual cycle of daily data 4.6.6.7 

tp transpose a data field 4.6.7.10 

trend detrend a time series 4.6.6.8 

tsplot plot time series (max 2 per plot) 4.6.11.3 

vortici compute the vertical component of the vorticity 4.6.12.6 

weigavg area weighted mean 4.6.6.9 

zonmean zonal mean 4.6.6.10 

zrplot plot pairs or single time series (max 20 per plot) 4.6.11.4 

sadd add a constant to data 

sdiv divide data by a constant 

smult multiply data by a constant 

ssub subtract a constant from data 

cadd add a constant field 

cdiv divide by a constant field 

cmult multiply by a constant field 

csub subtract a constant field 

b) Listing in thematic order 

Operations with a constant (section 4.6.1 ) 

Operations with a constant field (section 4.6.2 ) 

PAGE 4.2.2

add add two files 

append copy first tape1 then tape2 to tape3 

div divide two files 

eqdate equalize dates of two files 

merge merge two fields 

mult multiply two files 

sub subtract two files 


Operations with two files (section 4.6.3 ) 

Anomaly, difference and deviation programs (section 4.6.4 ) 

anomal calculate anomalies 

dif calculate differences of time steps T+1 and T 

recon reconstruct time series from anomalies and mean 

Normalization programs (section 4.6.5 ) 

anorm normalization with standard deviation 

norm normalize data to mean zero and standard deviation one 

Averaging and detrending programs (section 4.6.6 ) 

avg average over all records 

boxavg average spatial fields over coarser grid 

findan find annual cycle of daily data 

lmean calculate long time means 

momean compute monthly means from daily data 

runmean calculate a running mean for every grid point 

subtan subtract anual cycle of daily data 

trend detrend a time series 

weigavg area-weighted mean 

zonmean zonal mean 

Manipulation of data files (section 4.6.7 ) 

addrec merge two files record by record 

chanoso chance field orientation (north -- south) 

circle cyclic completion of a two dimensional field 

coarse delete every second row and column from a two dimensional field 

complet completion of a data file with dummy values 

edge values smaller/greater than limit set to missing value 

ipwrva interpolate default and/or wrong values 

splirec split one file into two, record by record 

PAGE 4.2.3

split split one file into two parts 

tp transpose a data field 


Changes of input/output formats (section 4.6.8 ) 

dform create formatted output 

forminv transformation of formatted to EXTRA-Format output 

ggstat produce a file statistic 

lookat short formated look at binary data 

selbox select a spatial box 

selmon select a special month or seasons 

selvar select variable and level 

File information programs (section 4.6.9 ) 

Selection programs (section 4.6.10 ) 

Plot programs (section 4.6.11 ) 

hovplot plot a hovmöller diagram 

ltsplot plot very long time series 

tsplot plot time series (max 2 per plot) 

zrplot plot pairs or single time series (max 20 per plot) 

Complex programs (section 4.6.12 ) 

cancor execute canonical correlation analysis 

crospec cross-spectral analysis 

foufil band-pass filter 

mkeof compute eigenvalues, EOFs and principal components 

mkeofnor compute eigenvalues, normed EOFs and normed principal components 

vortici compute the vertical component of the vorticity 

PAGE 4.2.4

4.3 USE OF THE PROGRAMS 

4.3.1 Outline 


The running of a program comprises giving the name of the program, the names of input and output files, 

and possibly a number of parameters. The program then does four things automatically: 

• Makes connections between the channels mentioned in the Fortran program and the input and 

output files. 

• Creates an executable code. 

• Executes the program. 

• Saves the new files to disk. 

The programs are written in FORTRAN. They use CRAY-FORTRAN for a variable field length, so 

every data set can be handled with these programs. All the programs make use of the global Shell environment 

variable EXTRA. The definition of EXTRA is given in section 3.1 . 

The programs may be run either interactively or in a batch job. 

4.3.2 How to use the programs 

To run a program module, a UNIX command in which the name of the program and the names of any 

input and output files are specified, is used. The form of the call, whether run interactively or in a batch 

job, is: 

for example: 

a) Interactive usage: 

prog infile1 infile2 .. outfile1 outfile2 .. 

add u1.dat u2.dat u.dat 

If the program is run interactivly and it requires parameters, one gets a request on the screen to specify 

these parameters. In this case one has to enter the appropriate parameters and hit the RETURN key. 

If one wants to use the default values for the parameter enter Ctrl/D . 

b) Batch usage: 

If the call is made inside a batch job and the program requires input parameters, one can provide these 

in two different ways: 

1) A parameter file (parfile) has to be created where the required parameters are specified. The 

filename of this parameter file must be passed to the program. The programs read the input 

parameter from the standard input, so one can use the UNIX redirection ( < ) to use the parfile 

as standard input. In the following batch job example the directory $MFHOME/datadir 

PAGE 4.3.1


contains the data files and the parameter specified in the file parfile. 

# QSUB -lT 60 # CPU time limit in seconds 

# QSUB -lM 4MW # MEMORY limit in mega words 

# 

# execution on a temporary directory 

cd $TMPDIR 

# 

# setting of the path to the data files directory 

DIR = $MFHOME/datadir 

# 

# 

# call of the script 

prog $DIR/infile1 $DIR/infile2 $DIR/outfile1 < $DIR/parfile 

# 

# execution finished 

2) One can specify the parameter inside the batch job. In the following example the lines following 

the program call until the mark EOI are used as standard input. One declares the mark 

following the


4.4 IMPLEMENTATION ON DIFFERENT COMPUTER TYPES 

4.4.1 Outline 

All executable EXTRA-Format programs are located in a special directory. This program directory differs 

on every computer. All programs require that the global SHELL variable EXTRA is defined and 

contains the path to the EXTRA-Format programs. To simplify matters in batch and interactive use one 

add the path to the program directory to the search-path variable 

PATH=$EXTRA:$PATH 

One obtains a complete list of all EXTRA-Format programs by typing 

ls $EXTRA. 

The programs are executed in the local directory $TMPDIR. All files which are not specified as permanent 

files are lost at logout. Therefore, if output files should be saved, a permanent directory must be 

specified, e.g.: 

$MFHOME/outfile2.dat 

creates outfile2.dat in the directory $MFHOME 

outfile2.dat 

creates outfile2.dat in the current directory 

If no filename is specified a file (e.g. chan.3) will be created in the directory TMPDIR. 

If GRIB- and EXTRA-Format programs are used in the same batch file, be sure that the correct directory 

is used in each case 1 . 

4.4.2 CRAY-2 and YMP 

The variable EXTRA is a global variable set at login by the system. A redefinition of the variable PATH 

in the .profile will ease the usage of the programs. 

PATH=$EXTRA:$PATH 

The programs can read cosblocked or pure (unblocked) EXTRA-Format data files. 

1. If you use both data-formats (GRIB and EXTRA), it is helpful to arrange your PATH variable in the following 

way: 

PATH=$EXTRA:$GRIB:$PATH 

Use EXTRA-Format programs with small letters, e.g. : ggstat infile.ext 

and GRIB-Format programs with capital letters, e.g. : GGSTAT infile.grb 

This feature only works, if the correct succession in the PATH statement is given: 

First $EXTRA , then $GRIB 

PAGE 4.4.1

4.4.3 CONVEX 1 


The CONVEX has a default word length of 4 bytes for REAL and INTEGER. To have a better compatibility 

with the results of the CRAY’s and SUN’s, and to get the possibility of variable field length the 

compiler option -cfc with 8 bytes word length for REAL and INTEGER is used. 

Two conversion routines ( 4to8real and 8to4real ) are installed on the CONVEX to change between 

4- and 8-byte CONVEX real. Furthermore all programs could be called for 4-byte-REAL with a preceding 

4 (e.g. 4mkeof) or with a preceding 8 for 8-byte-REAL (e.g. 8mkeof). The default value for 8byte-REAL 

is 9.E99 and for 4-bytes REAL is 3.E33. 

The program versions installed on the CONVEX can use CRAY-2S and YMP 8-byte binary data as inand 

output (cosblocked or pure, unblocked resp.), if a preceding capital C enables the programs to 

work with these binary files (e.g. Cmkeof). The output files are pure (unblocked) binary files in 

EXTRA- Format, which work as input files for EXTRA-programs on the CRAY-2 or YMP. One can use 

this files also as input files on the CONVEX if you use a preceding C in the program name. Two conversion 

routines CRtoCONV and CONVtoCR exist on the CONVEX to convert CRAY binary data to 

CONVEX 8-byte-REAL data. Usage of the 4 converting routines (4to8real, 8to4real, CRtoCONV, 

CONVtoCR) is only useful if the dataset is often used in the future, for two or three program calls it is 

better to use the programs with a preceding C, 8 or 4 respectively. 

Executable EXTRA-Format program scripts reside in the directory /pool/EXTRA/programs. One 

has to create the global variable EXTRA and to change the PATH at login . The following commands 

should be included in the .login file: 

setenv EXTRA /pool/EXTRA/programs 

set path ( $EXTRA $path ) 

The programs without a preceding 4 or 8 use 8-byte-REAL as default for in- and output. 

4.4.4 SUN-workstations 

The EXTRA-Format programs work on the SUN server regen at the DKRZ as well. The executable 

EXTRA-Format program scripts are located in the directory /usr/mpi/EXTRA/programs. 

1. Special implementation on the CONVEX at KNMI in DeBilt: 

Executable EXTRA-Format program scripts reside in the directory /resrch3/omt/bausteine/scr. 

Change the .login file to include this directory in your path: 

setenv EXTRA /resrch3/omt/bausteine/scr 


The programs without a preceding 4 or 8 use 4-byte-REAL as default for in- and output. The plot-programs 

do not work because the correct plot-library is missing. The programs create a working directory 

for every program call. If a program ends irregular the working directory may remain on your disk in the 

$HOME-directory (e.g.:work_23351). If not further needed, please delete it. 

PAGE 4.4.2


One has to create the global variable EXTRA and to change the PATH at login. The following commands 

should be included in the .login file: 

setenv EXTRA /usr/mpi/EXTRA/programs 


The input data have to be of type double precision, otherwise the programs will fail. 

PAGE 4.4.3


4.5 ONLINE HELP 


An online help system for the EXTRA-Format programs is available on all computers at the DKRZ 1 

using the command: 

exthlp keyword1 [keyword2] ... 

Keywords are all program names and short names for every section in this manual (see Table 6). All 

actual changes since the implementation of this document version are documented. Using the keyword 

news, some general information about new features and changes in the program are shown. The command 

exthlp help 

produces a complete list of all available keywords. 

Information about changes in the programs or actual news appear at the beginning of the control printout. 

Table 6 Keywords recognized by the exthlp-command 

Section Section title keyword 

Table of contents table 

1. Introduction intro 

2. Outline of the systems outline 

3.1 Structure of datasets structure 

4.2 List of available programs list 

4.3 Use of the programs use 

4.4 Implementation on different computers implemen 

4.5 Online help exthlp 

4.7 Example of use example 

Actual changes in the programs news 

List of all keywords help 

1. The online help feature is implemented on the CONVEX at KNMI too. 

PAGE 4.5.1


PAGE 4.5.2

4.6 DESCRIPTION OF THE MODULES 

4.6.1 Operations with a constant 


This section contains a description of programs which perform operations with a constant value. 

4.6.1.1 sadd add a constant to data 

4.6.1.2 sdiv divide data by a constant 

4.6.1.3 smult multiply data with a constant 

4.6.1.4 ssub subtract a constant from data 

PAGE 4.6.1

4.6.1.1 sadd 

Purpose 

Adds a constant to a data file: 

infile1(x,t) + const = outfile1(x,t) 


sadd infile1 outfile1

4.6.1.2 sdiv 

Purpose 


Divides a data file by a constant: infile1(x,t) / const = outfile1(x,t) 


sdiv infile1 outfile1

4.6.1.3 smult 

Purpose 

Multiplies a data file with a constant: 

infile1(x,t) * const = outfile1(x,t) 


smult infile1 outfile1

4.6.1.4 ssub 

Purpose 


Subtracts a constant from a data file: infile1(x,t) - const = outfile1(x,t) 


ssub infile1 outfile1


4.6.2 Operations with a constant field 


This section contains a description of programs which performs operations with a constant vector. 

4.6.2.1 cadd add a constant vector 

4.6.2.2 cdiv divide by a constant vector 

4.6.2.3 cmult multiply by a constant vector 

4.6.2.4 csub subtract a constant vector 

PAGE 4.6.2

4.6.2.1 cadd 

Purpose 

Adds a constant field to the data file 

infile1(x,t) + infile2(x) = outfile1(x,t) 


Input files 

Output file 

Output 

cadd infile1 infile2 outfile1 


This program produces missing values in the output file whenever there is a missing value in one 

of the input files. 

infile1 EXTRA-Format 


Both files must have the same field dimension. infile2 contains the constant 

field. 

outfile1 EXTRA-Format 

control printout 

The header records contain the information from infile1 

PAGE 4.6.2.1

4.6.2.2 cdiv 

Purpose 

Divides the data file by a constant vector: 

infile1(x,t) / infile2(x) = outfile1(x,t) 


Input files 

Output file 

Output 

cdiv infile1 infile2 outfile1 


This program produces missing values in the output file when ever there is a missing value in one 





field. 




PAGE 4.6.2.2

4.6.2.3 cmult 

Purpose 

Multiplies the data file by a constant field 

infile1(x,t) * infile2(x) = outfile1(x,t) 


Input files 

Output file 

Output 

cmult infile1 infile2 outfile1 



of the input files 




field. 




PAGE 4.6.2.3

4.6.2.4 csub 

Purpose 


Subtracts a constant vector from the input file: 

infile1(x,t) - infile2(x) = outfile1(x,t) 


Input files 

Output file 

Output 

csub infile1 infile2 outfile1 






field. 




PAGE 4.6.2.4


4.6.3 Operations with two files 


This section contains a description of programs which performs simple operations with two files. 

4.6.3.1 add add two files 

4.6.3.2 append copy first tape1 to tape3, then tape2 to tape3 

4.6.3.3 div divide two files 

4.6.3.4 eqdate equalize dates of two files 

4.6.3.5 merge merge two files 

4.6.3.6 mult multiply two files 

4.6.3.7 sub subtract two files 

PAGE 4.6.3

4.6.3.1 add 

Purpose 


Adds two data files infile1(x,t) + infile2(x,t) = outfile1(x,t) 


Input files 

Output file 

Output 

add infile1 infile2 outfile1 





Both files must have the same field dimensions and number of time steps 


The header records contain the same information as in infile1. 


PAGE 4.6.3.1

4.6.3.2 append 

Purpose 


Appends infile2 behind infile1 and writes the new file to outfile1 


Input files 

Output file 

Output 

append infile1 infile2 outfile1 







PAGE 4.6.3.2

4.6.3.3 div 

Purpose 

Divides the data file infile1 by file infile2 

infile1(x,t) / infile2(x,t) = outfile1(x,t) 


Input files 

Output file 

Output 

div infile1 infile2 outfile1 









The header records contain the information from infile1. 

PAGE 4.6.3.3

4.6.3.4 eqdate 

Purpose 


Compares two files, which must be in ascending order of date. 

Generates two files which contains only dates that were present in both the input files, but are otherwise 

the same as the two input files. 

When IDATE1 equals IDATE2, the header records and data records will be written to outfile1 and 

outfile2 respectively. Outfile3 contains the protocol with all rejected dates. 


Input file 

eqdate infile1 infile2 outfile1 outfile2 outfile3 

This program produces missing values in the output files when ever there is a missing value in the 

input files. 



Both files must be in ascending order of date. 

Output file 

Output 





outfile3 Protocol. 


PAGE 4.6.3.4

4.6.3.5 merge 

Purpose 


Merge two data files. This program merges fields at correspondent locations in infile1(LENF,t) and 

infile2(LENG,t) together and forms fields which have the length of the sum of the input field length 

on outfile1(LENF+LENG,t). 

outfile1(z,t) = infile1(x,t) ; x = 1,..,LENF; z = 1,..,LENF 

outfile1(z,t) = infile2(y,t) ; y = 1,..,LENG ; z = LENF+1,..,LENF+LENG 


Input files 

Output file 

Output 

merge infile1 infile2 outfile1 





Both files must have the same number of records 



The field length is LENF + LENG. 


PAGE 4.6.3.5

4.6.3.6 mult 

Purpose 

Multiplies two data files 

infile1(x,t) * infile2(x,t) = outfile1(x,t) 


Input files 

Output file 

Output 

mult infile1 infile2 outfile1 






Both files must have the same field dimension and number of time steps 




PAGE 4.6.3.6

4.6.3.7 sub 

Purpose 


Subtracts two data files infile1(x,t) - infile2(x,t) = outfile1(x,t) 


Input files 

Output file 

Output 

sub infile1 infile2 outfile1 









PAGE 4.6.3.7


4.6.4 Anomaly, difference and deviation programs 

This section contains a description of programs which perform anomaly, difference and deviation computations 

4.6.4.1 anomal calculate anomalies 

4.6.4.2 dif calculate differences of time steps t+1 and t 

4.6.4.3 recon reconstruct time series from anomalies and mean 

PAGE 4.6.4

4.6.4.1 anomal 

Purpose 

Computes anomalies 


outfile1(x,yymmdd) = infile1(x,yymmdd) - infile2(x,yymm). 


Proceeding 

Input files 

Output file 

Output 

anomal infile1 infile2 outfile1 

The program calculates the anomalies relative to a monthly mean. The program compares the 

month (MM) given by the parameter IDAT in both input files. If the month on the both input files 

correspond the anomalies are computed. 



infile1 EXTRA-Format (actual data) 

infile2 EXTRA-Format (monthly means) 

Both files must have the same field length. 

outfile1 EXTRA-Format (anomalies) 



PAGE 4.6.4.1

4.6.4.2 dif 

Purpose 


Subtracts the field at time step t from the field at time step t+1. 

outfile1(x,t+1) = infile1(x,t+1) - infile1(x,t) 


Input file 

Output file 

Output 

dif infile1 outfile1 

This program produces missing values in the output file whenever there is a missing value in the 

input file. 



The header records contain the information from infile1 at time step t+1. 


PAGE 4.6.4.2

4.6.4.3 recon 

Purpose 


Reconstructs timeseries (inverse program to anomal) 

outfile1(x,yymmdd) = infile1(x,yymmdd) + infile2(x,yymm) 


Proceeding 

Input files 

Output file 

Output 

recon infile1 infile2 outfile1 

The program reconstructs the original value relative to the monthly mean . The program compares 

the month (MM) given by the parameter IDAT in both input files. 



infile1 EXTRA-Format (anomalie data) 

infile2 EXTRA-Format (long-term means) 


outfile1 EXTRA-Format (anomalies) 



PAGE 4.6.4.3

4.6.5 Normalization programs 

This section contains normalization programs: 


4.6.5.1 anorm normalization with standard deviation 

4.6.5.2 norm normalize data to mean zero and standard deviation one 

PAGE 4.6.5

4.6.5.1 anorm 

Purpose 


Normalization of the input data with the standard deviation. 


Input files 

Output file 

Output 

anorm infile1 infile2 outfile1 




infile2 EXTRA-Format (standard deviation) 


outfile1 EXTRA-Format (normalized data). 



PAGE 4.6.5.1

4.6.5.2 norm 

Purpose 


Normalization of the input data to time mean zero f( x) 

= 0 and 

standard deviation one 


Input files 

Output file 

Output 

norm infile1 outfile1 


input file. 


outfile1 EXTRA-Format (normalized data). 



σ 2 ( x) 

= 

1 

PAGE 4.6.5.2



4.6.6 Averaging and detrending programs 

This section contains descriptions of averaging programs. 

4.6.6.1 avg average over all records 

4.6.6.2 boxavg average spatial fields over a part of the data field(s) 

4.6.6.3 findan find annual cycle of daily data 

4.6.6.4 lmean calculate long time means 

4.6.6.5 momean compute monthly means from daily data 

4.6.6.6 runmean calculate a running mean for every grid point 

4.6.6.7 subtan subtract anual cycle of daily data 

4.6.6.8 trend detrend a time series 

4.6.6.9 weigavg area-weighted mean 

4.6.6.10 zonmean zonal mean 

PAGE 4.6.6

4.6.6.1 avg 

Purpose 


Computes an average over all records of infile1. 


Proceeding 

Input files 

Output file 

Output 

avg infile1 outfile1 

The program calculates an average over all records in infile1 without looking for the variable or 

the level. To avoid meaningless results, the user should ensure that infile1 contains only one variable 

at one level. 

This program produces missing values in the output file whenever a data point contains missing 

values in every record. 


outfile1 EXTRA-Format (average) 

The header record contains the information of the last header record from infile1. 


PAGE 4.6.6.1

4.6.6.2 boxavg 

Purpose 

Proceeding 


Computes a spatial mean over rectangular boxes for each data record. 

boxavg calculates ROWLEN as LEN/NROWS. LEN, ROWLEN and NROWS must be integer multiples 

of NROWS, BOXCOLS and BOXROWS, respectively. boxavg starts from the first data 

item and continues in blocks BOXCOLS wide and BOXROWS high. In case of dismatch, you 

must first use selbox to extract a suitable subset of the data set. 


boxavg infile1 outfile1

4.6.6.3 findan 

Purpose 


Calculates the annual cycle of a file containing daily data. 

For fields in infile1 the condition 

x(t) = a0 + a1 * cos(w t) + b1 * sin(w t) + a2 * cos(2 w t) + b2 * sin(2 w t) 

is determined with w=2π/(NDAYS) 

The coefficients a0 , a1 , a2 , b1 and b2 are least square fits. 


findan infile1 outfile1

4.6.6.4 lmean 

Purpose 


Computes means for every month corresponding to the input parameter list. 


lmean infile1 outfile1

4.6.6.5 momean 

Purpose 

Computes monthly means. 


Proceeding 

momean infile1 outfile1 


The program calculates monthly means over all records for every month occurring in the input file 

infile1, without looking for the variable or the level. To avoid meaningless results, the user should 

ensure that infile1 contains only one variable at one level. 

Missing values (9.E99) 

Input files 

Output file 

Output 

This program produces missing values in the output file when ever a data point contains missing 

values in every record. For single records the missing value is skipped. 

infile1 EXTRA-Format (actual data). 


For every year and month one data record. The header record contains the information of the 

header records from infile1. Only IDATE has changed to YYMM00 instead of YYMMDD. 


PAGE 4.6.6.5

4.6.6.6 runmean 

Purpose 


Computes a running mean for every data record. 


runmean infile1 outfile1

4.6.6.7 subtan 

Purpose 


Subtract the annual cycle computed from the program findan from the input time series. 


Input file 

Output file 

Output 

subtan infile1 infile2 outfile1 

This program produces missing values whenever missing values appaer in the input files. 


All data must be for the same level and variable. 

They may be irregularly ordered and have gaps. 


coefficents for the anual cycle (produced with the program findan). 

outfile1 EXTRA-Format, new time series without an anual cycle. 


PAGE 4.6.6.7

4.6.6.8 trend 

Purpose 


This program fits a linear or quadratic trend to a series. 


Proceeding 

trend infile1 outfile1 outfile2 

The program treats the data in each record of infile1 as a time series. It fits either a linear or a quadratic 

trend to the series. It outputs in outfile1 the coefficients of the trend, together with the root 

mean square value of the deviation from the trend. It outputs in outfile2 the series with the trend 

subtracted from it. 

Let the original data series be x(t), where the first data point is for t=1, the next for t=2, etc. The 

program fits a series y such that the root-mean-square of y-x is minimised. y is given as follows: 

For linear trend: y = a + bt 

For quadratic trend y = a + bt + ct 

This program produces missing values in outfile2 whenever the corresponding point in the input 

file is missing. 


Input files 

Output file 

Output 

1 if a linear trend is required 

2 if a quadratic trend is required. 



Linear trend: 

This file contains the coefficients a and b, and the root- mean-square of 

the detrended series. 

Quadratic trend: 

This file contains the coefficients a, b and c, and the root-mean-square of 

the detrended series. 

outfile2 EXTRA-Format This file contains the series x - y. 


PAGE 4.6.6.8

4.6.6.9 weigavg 

Purpose 


Computes an area weighted average over all grid points of a two dimensional field for every record 

of infile1. The output field contains on every grid point the same mean value. 


weigavg infile1 outfile1 0 The first point has the northernmost latitude 

< 0 The first point has the south most latitude 

FIRLAT Latitude of the first gridpoint. 

> 0 first point is on the northern hemisphere 

< 0 first point is on the southern hemisphere 

NROW Number of rows of the two dimensional input field 


Regular gridded two dimensional input field. 

outfile1 EXTRA-Format (area weighted average). 

The header records contain the information of the header records from infile1. 


PAGE 4.6.6.9

4.6.6.10 zonmean 

Purpose 


Computes a zonal mean over all grid points of every row of a two dimensional field for every 

record of infile1. The output field contains for every row one zonal mean value. 


zonmean infile1 outfile1 > MARK 

NROW 

MARK 

Missing values (9.E99) 

This program produces missing values in the output file when all data points in one row contain 

missing values. 


Input files 

Output file 

Output 

NROW number of rows of the two dimensional input field. 


Two dimensional input field. 

outfile1 EXTRA-Format (area weighted average). 

The header records contain the information of the header records from infile1. 


PAGE 4.6.6.10


4.6.7 Manipulation of data files 


This section contains descriptions of file manipulation programs. 

4.6.7.1 addrec merge two files record by record 

4.6.7.2 chanoso chance field orientation (north → south) 

4.6.7.3 circle cyclic completion of a two dimensional field 

4.6.7.4 coarse delete every second row and column from a two dimensional field 

4.6.7.5 complet completion of a data file with dummy values 

4.6.7.6 edge values smaller/greater than limit set to missing value 

4.6.7.7 ipwrva interpolate default and/or wrong values 

4.6.7.8 splirec split one file into two, recordwhise. 

4.6.7.9 split split one file into two parts 

4.6.7.10 tp transpose a data field 

PAGE 4.6.7

4.6.7.1 addrec 

Purpose 

Merges two files record by record. 


Input file 

addrec infile1 infile2 outfile1 



input files. 

Output files 

Output 





PAGE 4.6.7.1

4.6.7.2 chanoso 

Purpose 


Change the orientation of the two dimensional input field from north to south. 


f(1,i)=>f(nrow,i); f(2,i)=>f(nrow-1,i) i=1,ncol 

chanoso infile1 outfile1

4.6.7.3 circle 

Purpose 


Cyclic completion of a two dimensional data field. The first point in every row is set equal to the 

n+1 point in every row. 


circle infile1 outfile1

4.6.7.4 coarse 

Purpose 


Deletes every second row and column from a two dimensional field. 


coarse infile1 outfile1

4.6.7.5 complet 

Purpose 


This program fills up missing dates in a file which contains daily data (with a header record and a 

data record with missing values) to obtain an output file with all intervening dates present. 


complet infile1 outfile1

4.6.7.6 edge 

Purpose 


Sets every value smaller or greater than a threshold value to the missing value (9.E99) or an user 

defined value. 


edge infile1 outfile1

4.6.7.7 ipwrva 

Purpose 


This program fills in missing or wrong data. It interpolates thereby between time steps t+1 and t-1. 

f(x,t) = (f(x,t+1) + f(x,t-1)) / 2 


ipwrva infile1 outfile1

4.6.7.8 splirec 

Purpose 

Splits one file in two, record by record. 


Input file 

splirec infile1 outfile1 outfile2 


This program produces missing values in the output files when ever there is a missing value in the 

input files. 

Output files 

Output 





PAGE 4.6.7.8

4.6.7.9 split 

Purpose 


Splits a data file into two parts after a threshold date. 


split infile1 outfile1 outfile2

4.6.7.10 tp 

Purpose 


Transposes all records of the input file. The first record in the output file contains the data of all 

first elements of the input file. 


Input file 

tp infile1 outfile1 

This program produces missing values in the output file when ever there is a missing value in the 

input file. 

Output files 

Output 




PAGE 4.6.7.10


4.6.8 Changes of input/output formats 


This section contains several programs which change the binary EXTRA-Code to formatted output 

(ASCII) or vice versa from EXTRA-Format. 

4.6.8.1 dform create formatted output from EXTRA-Format 

4.6.8.2 forminv transforme formatted to EXTRA-Format 

PAGE 4.6.8

4.6.8.1 dform 

Purpose 


Transformation into formatted (ASCII) output. 


Input files 

Output file 

Output 

dform infile1 outfile1 


input file. 


outfile1 Formatted output 

WRITE (2,’(4I10)’) IDAT,IVAR,LEVEL,LEN 

WRITE (2,’(6(1X,E12.5)’) (DATA(I),I=1,LEN) 



PAGE 4.6.8.1

4.6.8.2 forminv 

Purpose 


Transformation of formatted input into binary EXTRA-Format. 


Input files 

Output file 

Output 

forminv infile1 outfile1 


input file. 

infile1 Formatted input 

READ (2,’(4I10)’) IDAT,IVAR,LEVEL,LEN 

READ (2,’(6(1X,E12.5))’) (DATA(I),I=1,LEN) 




PAGE 4.6.8.2


4.6.9 File information programs 


This section contains the description of the two EXTRA-Format file information programs 

4.6.9.1 ggstat produce a file statistic 

4.6.9.2 lookat short formated look at binary data 

PAGE 4.6.9

4.6.9.1 ggstat 

Purpose 


This program produces some information about the header records and data sets. 

It produces a printout of the four header variables and computes the mean value and standard deviation 

of the following data record. The program counts the missing values. 

It produces a printout of one line for every data record . 


Input file 

Output file 

Output 

ggstat infile1 


none 


PAGE 4.6.9.1

4.6.9.2 lookat 

Purpose 


This program enables the user to get a short look at a part of a binary EXTRA-Format data set 


lookat infile1


4.6.10 Selection Programs 


This section contains a description of programs which select special records or parts of fields. 

4.6.10.1 selbox select a spatial box 

4.6.10.2 selmon select a month or seasons 

4.6.10.3 selvar select variable and level 

PAGE 4.6.10

4.6.10.1 selbox 

Purpose 


Selects a spatial box from a two dimensional field. 

This program creates a new field. The number of columns NCOLS is computed with 

NCOLS = LEN / NROWS: 


selbox infile1 outfile1

4.6.10.2 selmon 

Purpose 


Selects one or several conservative month of the input records. The program checks the month of 

IDATE in the technical record. If it lies within the specified interval the header and data records are 

written to the output file. 


selmon infile1 outfile1

4.6.10.3 selvar 

Purpose 


Selects all records of a specific variable and/or level. 

The program checks the header information for the desired variable and level. The selected records 

are written to the output file. 


selvar infile1 outfile1

4.6.11 Plot programs 

DKRZ EXTRA Format Module Documentation 

This section contains plot program descriptions. All plot programs use the NCAR 3.0 plot software. 

4.6.11.1 hovplot plot a hovmöller diagram 

4.6.11.2 ltsplot plot time series 

4.6.11.3 tsplot plot time series (max 2 per plot) 

4.6.11.4 zrplot plot pairs or single time series (max 20 per plot) 

PAGE 4.6.11

4.6.11.1 hovplot 

Purpose 

Plots a Hovmöller-Diagram. 


hovplot infile1 sunfile 0.0 contour interval between two isolines . 

= 0.0 The program computes between ten and twenty isolines at convenient values. 

< 0.0 abs(CSTEP) = number of isolines to be plotted. 

PTEXT Text for the plot heading (max. 60 characters) 

XTEXT Text for the time axis (x-axis) (max. 40 characters) 

YTEXT Text for the grid axis (y-axis) (max. 40 characters) 


(should contain one header and one data record) 

gksm11.txt gks-gral format 

The gksm11.txt is a temporary file on the $TMPDIR. For a permanent 

plot a copy in an other directory ($MFHOME/...) has to be made. 

One can send the file gksm11.txt to a plotter using the spl command 

spl -f $TMPDIR/gksm11.txt -d psm2 

sunfile is the filename of a copy of the gksm11.txt file on the SUN (regen or niesel). 

For the use of self defined SUN variables the file name has to be enclosed with 

apostrophes (‘$PLOTDIR/hovplot’). 


PAGE 4.6.11.1

4.6.11.2 ltsplot 

Purpose 


Plots one or two time series per plot. A plotter with a suitable scale can produce large plots, e.g.: 

spl -f $TMPDIR/gksm11.txt -d versat -s 52.0 

produces a 50 x 150cm plot. 


ltsplot infile1 infile2 sunfile

4.6.11.3 tsplot 

Purpose 


Plots one or two time series per plot. The picture fills the whole page. 


tsplot infile1 infile2 sunfile

4.6.11.4 zrplot 

Purpose 


Plots a maximum of 20 time series in one plot. The program computes the maximum value for all 

time series and adds this value to every curve so that a plot with ten solid and ten dashed curves is 

produced (see example plot on page 2.4.11.15). 

If the input files contain less then 10 data series, the number of curves plotted is smaller. 


zrplot infile1 infile2 sunfile


4.6.12 Some more complex programs 

DKRZ EXTRA Format Module Documentation 

This section contains the description of the following programs: 

4.6.12.1 cancor execute canonical correlation analysis 

4.6.12.2 crospec cross-spectral analysis 

4.6.12.3 foufil band-pass filter 

4.6.12.4 mkeof compute eigenvalues, EOFs and principal components 

4.6.12.5 mkeofnor compute eigenvalues, normed EOFs and normed principal components 

4.6.12.6 vortici compute the vertical component of the vorticity 

PAGE 4.6.12

4.6.12.1 cancor 

Purpose 


The program computes a canonical correlation analysis. It estimates the correlation coefficents 

(CCA), the canonical maps (FMAP, GMAP) and the canonical components (FCOM, GCOM) for 

the fields f and g. If it is necessary the program estimates the eigenvalues (EV), empirical orthogonal 

functions (EOF) and principal components (PC) of the anomaly fields f or g. This program 

computes the variance for every canonical mode and the local variance (loc.var.) for every gridpoint, 

mode and field. 


cancor inf1 inf2 inf3 inf4 outf1

Input files 


inf1 Extra-Format actual anomalies 

inf2 Extra-Format actual anomalies 

inf3 Extra-Format. The file contains one data record with the eigenvalues and for 

each eigenvalue one record with the EOF and one record with the principal 

component of field f. 

inf4 Extra-Format. The file contains one data record with the eigenvalues and for 


component of field g. 

inf3 or inf4 could be empty. If these files are empty the program will compute the EVs, EOFs and 

PCs. 

Output files 

You can distinguish the different data types by the variables of the header records. 

inf3 and inf4 contain the EVs, EOFs and PCs of field f respectively g 

outf1 contains the estimated CCAs, FMAPs, FCOMs, GMAPs, GCOMs and local 

variances for f and g. 

Special header records 

Output 

This program changes the first three variables in the header records to give a possibility to distinguish 

the data records: 

IDATE=-1, IVAR=503, ILEV=9999 6 EV 

IDATE=EOF-Nr., IVAR=503, ILEV=9999 6 EOF 

IDATE=EOF-Nr., IVAR=504, ILEV=9999 6 PC 

IDATE=-1, IVAR=520, ILEV=9999 6 CCA 

IDATE=CCA-Nr., IVAR=521, ILEV=9999 6 FMAP 

IDATE=CCA-Nr., IVAR=522, ILEV=9999 6 FCOM 

IDATE=CCA-Nr., IVAR=523, ILEV=9999 6 GMAP 

IDATE=CCA-Nr., IVAR=524, ILEV=9999 6 GCOM 

IDATE=CCA-Nr., IVAR=525, ILEV=9999 6 loc.Var. F 

IDATE=CCA-Nr., IVAR=526, ILEV=9999 6 loc.var. G 


f˜ ( xt , ) = f( x, t) 

− f( x) 

g˜ ( xt , ) = 

g( x, t) 

− g( x) 

f˜ ( xt , ) 

g˜ ( xt , )

4.6.12.2 crospec 

Purpose 


Computation of a cross spectral analysis. The program produces a complete printout and, if 

desired, a plot of the variances, phase and squared coherence. 


crospec infile1 infile2 outfile1 plotfil

Input file 

infile1 Extra-Format. 


This file contains the timeseries of field A. The file only contains the timeseries 

for which a cross spectral analysis is to be performed. 


Output file 

This file contains the timeseries of field B. The file only contains the timeseries 

for which a cross spectral analysis is to be performed. 

Both files must have the same number of records and every data record contains 

one timeseries. 

outfile1 Extra-Format. 

For every cross-spectral analysis the output file contains respectively one 

data record for the frequencies, the variances of fields A and B, the phases and 

the squared coherences . 

plotfil gks-gral-format 


Output 


name of the plotfile on a sun (REGEN). Default = $MFHOME/plot 

On the CRAY-2 the name of the local plot output file is $TMPDIR/gksm11.txt. 

This program changes the values of IVAR in the header records to make it 

possible to distinguish the output data records: 

IVAR Description 

530 frequencies 

531 variance of field A 

532 variance of field B 

533 phases 

534 squared coherence

4.6.12.3 foufil 

Purpose 

Performance of Fourier time filter. 


foufil infile1 outfile1


Input file 

Output file 

Output 

X' ( r, t) 

= 

1 

⋅ 

n 


PMIN Real Minimum filter period 

P2 Real Lower filter border period 

P1 Real Upper filter border period 

PMAX Real Maximum filter period 

The user may select the following special types of window; 

General Rectangular filter P1=PMAX, P2=PMIN 

High Pass filter; P2=PMIN=1 (default) 

Low Pass filter; P1=PMAX=2* 

Default values; P1=PMAX=2* 

P2=PMIN=2 

Note that in the user parameter line, the filter parameters have to be typed in the order PMIN, P2, 

P1, PMAX, separated by one or more spaces. A default value is inserted by the program if the 

value -1.0 is typed at the correspond-ing place. For instance, in the latter case when the program 

is given P1=PMAX=-1, it sets P1=PMAX=2* because this corresponds to 

the lowest frequency represented in the data. If all four parameters take their default values, then 

no filtering is performed. 


Actual data fields. All data must be for the same level and variable. 

They may have gaps. 

outfile1 Extra-Format. 


n 

∑ 

t = 1 

G ( ν) 

⋅ X( r, ν) 

⋅e 

Filtered data fields 

( i⋅ 2π⋅ν ⋅t)

4.6.12.4 mkeof 

Purpose 


Estimation of the eigenvalues (EV), empirical orthogonal func tions (EOF,eigenvectors) and principal 

components (PC) of an anomaly field. 


mkeof infile1 outfile1

Output file 


outfile1 Extra-Format. The file contains one data record with the eigenvalues and for 


component. 

You can distinguish the different data types by variables of the header records. 


This program changes the first three variables in the header records to give a possibility to 

distinguish the data records: 

Memory and CPU-time 

Output 


IDATE=-1, IVAR=503, ILEV=9999 6 EV 

IDATE=EOF-Nr., IVAR=503, ILEV=9999 6 EOF 

IDATE=EOF-Nr., IVAR=504, ILEV=9999 6 PC 

The memory depends on the size of the anomalies and of the covariance matrix. A field size of 

5000 * 888 and the associated covariance matrix with a size of 888 * 888 needs less then 4 MW 

memory. The size of the covariance matrix is important. 

The CPU-time depends on the size of the covariance matrix and of the value of NUMEOF. 


size of covariance matrix CPU-time 

72 x 72 54 seconds 

444 x 444 1548 seconds 

888 x 888 6174 seconds 

The standard deviation of the PC’s is the squared eigenvalue. The standard deviation of the sum 

of all EOF’s is 1.

4.6.12.5 mkeofnor 

Purpose 


Estimation of the eigenvalues (EV), the normed empirical orthogonal functions (EOF, eigenvectors) 

and the normed principal components (PC) of an anomaly field. 



mkeofnor infile1 outfile1

4.6.12.6 vortici 

Purpose 


Computation of the vertical component of the vorticity. 


vortici infile1 infile2 outfile1 0 Orientation from north to south 

DLAT < 0 Orientation from south to north 

DLON Longitudinal distance between two data points in degrees 

FIRLAT First latitude of the field 

FIRLAT > 0 Denotes a point on the northern hemisphere 

FIRLAT < 0 Denotes a point on the southern hemisphere 

NROWS Number of rows in the two-dimensional field 

infile1 EXTRA Format 

This file contains the timeseries of the u-velocity component 

infile2 EXTRA Format 

This file contains the timeseries of the v-velocity component 

outfile1 EXTRA Format 

This file contains the timeseries of the vertical vorticity component 


PAGE 4.6.12.6


4.7 EXAMPLE OF USE 


In this section four examples of batch jobs (a-c) or interactive commands (d) which use the EXTRA Format 

programs are given. 

a) This example job performs a canonical correlation. The input data are two files which contain daily 

observations of the surface temperature and pressure respectively. This job computes the anomalies for 

both files and performs the canonical correlation. The EOFs were computed and afterwards the first 2 

canonical components selected and plotted. The plot files were made permanent (copy) and a plot command 

was send to one of the plotters (spl gksm11.txt -d plot-device name). 

# QSUB -eo # connect standard error with standard out 

# QSUB -x # export all environment Variables 

# QSUB -lT 600 # CPU time limit in Seconds 

# QSUB -lM 4MW # memory limit in mega-words 

# QSUB -r cancor # Job name 

# QSUB -o /mf/m/m211073/raus/cancor # Job output on file ...... 

# 

# H. BORGERT June 1991 at the MPIfM 

# 

# Batch Job on the CRAY-2S to perform a canonical correlation 

# 

# This job prepares the data from the files $MFHOME/data/dayt3086.XTR 

# $MFHOME/data/dayp3086.XTR for a canonical correlation, perform it and 

# produces time series plots of the first three canonical components. 

# 

# change the working directory to $TMPDIR 

cd $TMPDIR 

# 

# define a variable with the path to the data files 

DIR=/$MFHOME/data 

# 

# start the programs for EXTRA-Format 

#------------------------------------------------------------ 

# 

# Calculate the long time mean and the anomalies 

# for the temperature (dayt3086.XTR) and save the anomalies on 

# the file dayte3086.ANO. 

# 

lmean $DIR/dayte3086.XTR temp3086.LM


anomal $DIR/daypr3086.XTR pres3086.LM $DIR/daypr3086.ANO 

# 

# perform the canonical correlation 

# 

cancor $DIR/dayte3086.ANO $DIR/daypr3086.ANO te.EOF pr.EOF \ 

$DIR/tepr3086.CCA


b) This example job computes from daily temperature observations between 1950 and 1960 a monthly 

global mean (area weighted) and a monthly zonal mean. For the global means a chronological time series 

plot is produced, while the zonal means are represented in a Hovmöller-diagram. 





# QSUB -r gloavg # Job name 

# QSUB -o /mf/m/m211073/raus/gloavg # Job output on file ...... 

# 


# 

# Batch Job on the CRAY-2S to perform a monthly global mean and monthly 

# zonal mean. 

# 

# This job prepares the data from the file $MFHOME/data/temp5.XTR 

# computes a global and zonal mean. The results were plotted in a 

# time series and Hovmueller diagram. 

# 


cd $TMPDIR 

# 



# 


#------------------------------------------------------------ 

# 

# Calculate the monthly mean for the file temp5.XTR. 

# 

momean $DIR/temp5.XTR $DIR/temp5.MOM 

# 

# estimate the global mean for every month 

# 

weigavg $DIR/temp5.MOM temp5.WEI


# 

# send the plot file to one of the plotters 

# 

spl -f $TMPDIR/gksm11.txt -d psm2 

# 

# copy the plot file to a permanent catalog 

# 

cp $TMPDIR/gksm11.txt $MFHOME/plot/temp5.glm 

# 

# compute the zonal mean for every month 

# 

zonmean $DIR/temp5.MOM $DIR/temp5.ZON


c) This example job selects the temperature and geopotential height out of a file containing several variables 

at different levels. The first and last three years are deleted, the files are transposed to get on every 

data record one time series. Afterwards the cross spectral analysis is calculated. 





# QSUB -r cancor # Job name 

# QSUB -o /mf/m/m211073/raus/cancor # Job output on file ...... 

# 


# 

# Batch Job on the CRAY-2S or YMP to perform a cross spectral analysis 

# 

# This job selects the data from the file $MFHOME/data/Expe73015.XTR, 

# cuts of the first and last three years and perform a cross spectral 

# analyses 

# 


cd $TMPDIR 

# 



# 


#---------------------------------------------------------- 

# 

# Select the temperature in 500 hPa 

# 

selvar $DIR/Expe73015.XTR temp500.XTR


# 

tp $DIR/temp500.XTR $DIR/temp500.TP 

tp $DIR/geoh500.XTR $DIR/geoh500.TP 

# 

# perform the cross spectral analysis 

# 

crospec $DIR/temp500.TP $DIR/geoh500.TP


d) Interactive job: A file called SST contains COADS SST monthly data from 1960 January to 1969 

December. These data represent SST in a sequence of 2-degree boxes. The first box represents the North 

Pole. The next 180 boxes represent the zone 88o-90o N starting 0o-2o E, the next 180 boxes represent 86o- 88o N, and so on, with the last value representing the South Pole. You wish to average the data over 4 x 

10 degree boxes starting 84o-88o N, 0o-10o E. The header records have the form 

IDAT 11 -200 16202 

where IDAT runs from 600100 to 691200. First, one must strip off the North Pole and South Pole: 

with the parameters 

SELBOX SST1 TEMP1 

1 2 16201 1 1 

Then, one must strip off the northernmost and southernmost zones: 


SELBOX TEMP1 TEMP2 

90 2 89 1 180 

Finally, the averaging is performed: 


BOXAVG TEMP2 SST2 

180 2 5 

PAGE 4.7.7


PAGE 4.7.8


Appendix A Available experiment-data at the DKRZ 

Experiment-data created at the DKRZ/MPI is stored on cartridges (IBM 3480). The data can be copied 

can be extracted to the disk-system of the CRAY-2S or the CRAY-YMP using the module EXTRACT. 

The usage of EXTRACT is described in section 3.4.1 . 

The experiment-data at the DKRZ is divided into four mayor groups: 

1. Raw data 

2. Selected codes 

3. Monthly mean data 

4. Data on cartridges which are removed from the cartridge-silo 

Additionally several observed quantities are stored on cartridges. Please refer to 

DKRZ Technical Report No. 1, Inventory of Available Observed Data Sets 

by Ingo Jessel or to the online manual residing at 

/pf/m/m211053/pub/iaods/extra/coads.txt 

on the file servers regen and neptun. 

Experiment Name 

(required for use of 

EXTRACT) 

CONTROL_1 

CONTROL_2 

CTRL42_2 

ECHAM3_CTRL 

ECHAM3_OCEA 

ECHAM3_T21_CTRL 

ECHAM3_AMIP_SST 

ECHAM3_T21_AMIP_SST 

GULF_CTRL_1 

GULF_SOOT_HIGH_1 

GULF_SCENARIO_B_1 

GULF_SCENARIO_C_1 

GULF_SCENARIO_G_1 

GAGO_2 

MOGA_2 

TOGA_2 

Table 7 Available Experiments now (20/05/92) 

(Sheet 1 of 2) 

Mnemonic Labels 

on tape 

T21CTRL12_YYMM 

01090CTRL_YYMM 


22032AMIP_YYMM 

22058OCEA_YYMM 

22059AMIP_YYMM 

22062LLNL_YYMM 

22064ASST_YYMM 


07020GOLF_YYMM 

GBKOPETR__YYMM 

GCKOPETR__YYMM 

GGKOPETR__YYMM 

09021GAGO_YYMM 

06202MOGA_YYMM 

06201TOGA_YYMM 

A.1 

Created by Dates 

U.Schlese 0101 - 2312 

0101 - 2312 

0101 - 1005+ 

M.Esch 0205 - 3012 

0101 - 1012 

0101 - 1012 

0101 - 2012 

0101 - 2012 

U.Schlese 0101 - 0203 

0101 - 0203 

0901 - 1006 

0901 - 1006 

0901 - 1006 

M.Ponater 0301 - 2112 

0301 - 2112 

0301 - 2112 

ECHAM 

Version 

1 

2 

2 

3 

3 

3 

3 

3 

1 

1 

1 

1 

1 

2 

2 

2

Experiment Name 

(required for use of 

EXTRACT) 

PERM_JUL_1 

PERM_JAN_1 

056LLS 

VULK1 

VULK2 

PERM_JUL_2 

JUN88_MEAN_SST 

JUN88_MEAN_SST_NEW 

JUN88_ENV_SST 

PERM_JAN_2 

PERM_JULZ0_2 

DIUR_SST_VAR_JUL_2 

JUN88_MOD_SST 

PERMJUN_2 

JUN88_LOW_SST 

JUN88_SPAC_SST 


T21CTRLPJUL_YYMM 

56006PJA_YYMM 

56005LLS_YYMM 

VULK1___YYMM 

VULK2___YYMM 

56010PJU2_YYMM 

56014TSMN_YYMM 

56023MNNW_YYMM 

56015TSEN_YYMM 

56016PJA2_YYMM 

56017LMS2_YYMM 

56018DSST_YYMM 

56019TSHI_YYMM 

56020PJUN_YYMM 

56021TSLO_YYMM 

56022TSSH_YYMM 

A.2 

D.Schriever 0107 - 0306 

0103 - 0302 

0111 - 0306 

0704 - 1106 

0704 - 1106 

0107 - 0308 

0107 - 0306 

0107 - 0306 

0107 - 0306 

0101 - 0302 

0201 - 0206 

0107 - 0308 

0107 - 0308 

0101 - 0308 

0107 - 0312 

0107 - 0306 

POLYNYA 78001POL_YYMM R.Glovienka 0107 - 0308 1 

WAM_JUL_2_ATM 

WAM_JUL_2_WAVE 

WAM_JAN_2_ATM 

WAM_JAN_2_WAVE 

44001T21WAVE__YYMM 

44001WAVES__YYMM 

44001T21JAN___YYMM 

44001WAMJAN___YYMM 

N.Weber 0107 - 0207 

0107 - 0207 

0101 - 0201 

0101 - 0201 

PAL_RAD_115KYR_2 26001PAL1_YYMM H.Graf 0101 - 0512 2 

ICE_AGE_ATMOS_FIRST 60001LGM2_YYMM M.Lautenschlager 0101 - 1512 2 

ICE_BRIDGE 

ICE_AGE_JULY 

ICE_15000_JULY 

ICE_13000_JULY 

LSG_CTRL_FLUX_CORR 

LSG_SCENARIO_A 

LSG_SCENARIO_D 

LSG_DOUBLE_CO2 

LSG_MONTE_CARLO_38 



PYC_CTRL_FLUX_CORR 

PYC_SCENARIO_A 

PYC_DOUBLE_CO2 

PYC_SCENARIO_D 

Table 7 Available Experiments now (20/05/92) 

(Sheet 2 of 2) 


on tape 

73001EISB_YYMM 

73002JU18_YYMM 



XXKOPE17__YYMM 

CAKOPE17__YYMM 

CDKOPE17__YYMM 

YYKOPE17__YYMM 

AHKOPE38__YYMM 

AHKOPE68__YYMM 

BHKOPE98__YYMM 

05007ATM__YYMM 





H.Borgert 0107 - 0312 

0107 - 0312 

0107 - 0312 

0107 - 0312 

U.Cubasch 0401 -10812 

0901 -10812 

0901 -10812 

0901 -10812 

3901 - 8812 

6901 -11812 

9901 -14812 

F.Lunkeit 1001 -12912 

3001 -12912 

3001 -12912 

3001 -12912 

ECHAM 

Version 

1 

1 

1 

1 

1 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

2 

1 

1 

1 

1 

1 

1 

1 

1 

1 

1 

1

Experiment Mnemonic 

PYC_CTRL_FLUX_CORR_EXTR 

PYC_SCENARIO_A_EXTR 

PYC_DOUBLE_CO2_EXTR 

PYC_SCENARIO_D_EXTR 

CONTROL_2_EXTR 

GAGO_2_EXTR 


LSG_CTRL_FLUX_CORR_MEAN 

LSG_SCENARIO_A_MEAN 

LSG_SCENARIO_D_MEAN 

LSG_DOUBLE_CO2_MEAN 

LSG_MONTE_CARLO_38_MEAN 



PYC_CTRL_FLUX_CORR_MEAN 

PYC_SCENARIO_A_MEAN 

PYC_DOUBLE_CO2_MEAN 

PYC_SCENARIO_D_MEAN 


PERM_JAN_1 

DRY_SPAIN_JAN_1 

PERM_APR_1 

AERED1_JUL_2 


Table 8 Data with some important codes only 


on tape 

05007EXTR_YYMM 






A.3 


M.Ponater 

“ 

“ 

“ 

“ 

“ 

Table 9 Monthly mean data 


on tape 

CTRLMONMEA.YY00 

SZAAMONMEA.YY00 

SZDDMONMEA.YY00 

CO22MONMEA.YY00 

MC38MONMEA.YY00 



05007G_YY00 

05009G_YY00 

05010G_YY00 

05011G_YY00 

3001 -12912 

3001 - 9912+ 

0000 - 0000+ 

3001 - 9912+ 

0401 - 2312 

0301 - 2112 


U.Cubasch 0400 -10800 

0900 -10800 

0900 -10800 

0900 -10800 

3900 - 8800 

6900 -11800 

9900 -14800 

F.Lunkeit 1000 -12900 

3000 -12900 

3000 -12900 

3000 -12900 

Table 10 Data on cartridges removed from the storage system 


on tape 

56006PJA_YYMM 

56007DSP_YYMM 

56008PAP_YYMM 

56011SRR1_YYMM 


D.Schriever 0103 - 0302 

0103 - 0504 

0104 - 0303 

0107 - 0302 

ECHAM 

Version 

1 

1 

1 

1 

1 

1 

ECHAM 

Version 

1 

1 

1 

1 

1 

1 

1 

1 

1 

1 

1 

ECHAM 

Version 

GAGO_1 03002GAGO_YYMM E.Kirk 0301 - 2112 1 

XXKOPE12 

XYKOPE12 

XXKOPE12__YYMM 

XYKOPE12__YYMM 

U.Cubasch 0401 - 2812 

0401 - 2906 

STERLKOPF 31008KOPF_YYMM A.Sterl 0101 - 2012 2 

1 

1 

1 

2 

1 

1


A.4

Technical Report No. ? - DKRZ

Create successful ePaper yourself

Delete template?

Save as template?