1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
|
!!$pgf90 -I/work/NetCDF/5.1/include -L/work/NetCDF/5.1/lib -l netcdf -L. -l cmor Test/test_dimensionless.f90 -IModules -o cmor_test
!!$pgf90 -g -I/pcmdi/charles_work/NetCDF/include -L/pcmdi/charles_work/NetCDF/lib -lnetcdf -module Modules -IModules -L. -lcmor -I/pcmdi/charles_work/Unidata/include -L/pcmdi/charles_work/Unidata/lib -ludunits Test/test_dimensionless.f90 -o cmor_test
MODULE local_subs
USE cmor_users_functions
PRIVATE
PUBLIC read_coords, read_time, read_3d_input_files, read_2d_input_files
CONTAINS
SUBROUTINE read_coords(alats, alons, plevs, bnds_lat, bnds_lon)
IMPLICIT NONE
DOUBLE PRECISION, INTENT(OUT), DIMENSION(:) :: alats
REAL, INTENT(OUT), DIMENSION(:) :: alons
DOUBLE PRECISION, INTENT(OUT), DIMENSION(:) :: plevs
DOUBLE PRECISION, INTENT(OUT), DIMENSION(:,:) :: bnds_lat
REAL, INTENT(OUT), DIMENSION(:,:) :: bnds_lon
INTEGER :: i
DO i = 1, SIZE(alons)
alons(i) = (i-1)*360./SIZE(alons)
bnds_lon(1,i) = (i - 1.5)*360./SIZE(alons)
bnds_lon(2,i) = (i - 0.5)*360./SIZE(alons)
END DO
DO i = 1, SIZE(alats)
alats(i) = (size(alats)+1-i)*10
bnds_lat(1,i) = (size(alats)+1-i)*10 + 5.
bnds_lat(2,i) = (size(alats)+1-i)*10 - 5.
END DO
DO i = 1, SIZE(plevs)
plevs(i) = i*1.0e4
END DO
plevs = (/100000., 92500., 85000., 70000.,&
60000., 50000., 40000., 30000., 25000., 20000.,&
15000., 10000., 7000., 5000., 3000., 2000., 1000., 500., 100. /)
RETURN
END SUBROUTINE read_coords
SUBROUTINE read_time(it, time, time_bnds)
IMPLICIT NONE
INTEGER, INTENT(IN) :: it
DOUBLE PRECISION, INTENT(OUT) :: time
DOUBLE PRECISION, INTENT(OUT), DIMENSION(2,1) :: time_bnds
time = (it-0.5)*30.
time_bnds(1,1) = (it-1)*30.
time_bnds(2,1) = it*30.
RETURN
END SUBROUTINE read_time
include "reader_2D_3D.f90"
END MODULE local_subs
PROGRAM ipcc_test_code
!
! Purpose: To serve as a generic example of an application that
! uses the "Climate Model Output Rewriter" (CMOR)
! CMOR writes CF-compliant netCDF files.
! Its use is strongly encouraged by the IPCC and is intended for use
! by those participating in many community-coordinated standard
! climate model experiments (e.g., AMIP, CMIP, CFMIP, PMIP, APE,
! etc.)
!
! Background information for this sample code:
!
! Atmospheric standard output requested by IPCC are listed in
! tables available on the web. Monthly mean output is found in
! tables A1a and A1c. This sample code processes only two 3-d
! variables listed in table A1c ("monthly mean atmosphere 3-D data"
! and only four 2-d variables listed in table A1a ("monthly mean
! atmosphere + land surface 2-D (latitude, longitude) data"). The
! extension to many more fields is trivial.
!
! For this example, the user must fill in the sections of code that
! extract the 3-d and 2-d fields from his monthly mean "history"
! files (which usually contain many variables but only a single time
! slice). The CMOR code will write each field in a separate file, but
! many monthly mean time-samples will be stored together. These
! constraints partially determine the structure of the code.
!
!
! Record of revisions:
! Date Programmer(s) Description of change
! ==== ========== =====================
! 10/22/03 Rusty Koder Original code
! 1/28/04 Les R. Koder Revised to be consistent
! with evolving code design
! include module that contains the user-accessible cmor functions.
USE cmor_users_functions
USE local_subs
IMPLICIT NONE
! dimension parameters:
! ---------------------------------
INTEGER, PARAMETER :: ntimes = 2 ! number of time samples to process
INTEGER, PARAMETER :: lon = 4 ! number of longitude grid cells
INTEGER, PARAMETER :: lat = 3 ! number of latitude grid cells
INTEGER, PARAMETER :: lev = 5 ! number of standard pressure levels
INTEGER, PARAMETER :: lev2 =19 ! number of standard pressure levels
INTEGER, PARAMETER :: n2d = 4 ! number of IPCC Table A1a fields to be
! output.
INTEGER, PARAMETER :: n3d = 3 ! number of IPCC Table A1c fields to
! be output.
! Tables associating the user's variables with IPCC standard output
! variables. The user may choose to make this association in a
! different way (e.g., by defining values of pointers that allow him
! to directly retrieve data from a data record containing many
! different variables), but in some way the user will need to map his
! model output onto the Tables specifying the MIP standard output.
! ----------------------------------
! My variable names for IPCC Table A1c fields
CHARACTER (LEN=5), DIMENSION(n3d) :: &
varin3d=(/'CLOUD', 'U ', 'T '/)
! Units appropriate to my data
CHARACTER (LEN=5), DIMENSION(n3d) :: &
units3d=(/ '% ', 'm s-1', 'K ' /)
! Corresponding IPCC Table A1c entry (variable name)
CHARACTER (LEN=2), DIMENSION(n3d) :: entry3d = (/ 'cl', 'ua', 'ta' /)
! My variable names for IPCC Table A1a fields
CHARACTER (LEN=8), DIMENSION(n2d) :: &
varin2d=(/ 'LATENT ', 'TSURF ', 'SOIL_WET', 'PSURF ' /)
! Units appropriate to my data
CHARACTER (LEN=6), DIMENSION(n2d) :: &
units2d=(/ 'W m-2 ', 'K ', 'kg m-2', 'Pa ' /)
CHARACTER (LEN=4), DIMENSION(n2d) :: &
positive2d= (/ 'down', ' ', ' ', ' ' /)
! Corresponding IPCC Table A1a entry (variable name)
CHARACTER (LEN=5), DIMENSION(n2d) :: &
entry2d = (/ 'hfls ', 'tas ', 'mrsos', 'ps ' /)
! uninitialized variables used in communicating with CMOR:
! ---------------------------------------------------------
INTEGER :: error_flag
INTEGER :: znondim_id, zfactor_id
INTEGER, DIMENSION(n2d) :: var2d_ids
INTEGER, DIMENSION(n3d) :: var3d_ids
REAL, DIMENSION(lon,lat) :: data2d
REAL, DIMENSION(lon,lat,lev2) :: data3d
DOUBLE PRECISION, DIMENSION(lat,1,lon) :: scramble
DOUBLE PRECISION, DIMENSION(lat) :: alats
REAL, DIMENSION(lon) :: alons
DOUBLE PRECISION, DIMENSION(lev2) :: plevs
DOUBLE PRECISION, DIMENSION(1) :: time
DOUBLE PRECISION, DIMENSION(2,1):: bnds_time
DOUBLE PRECISION, DIMENSION(2,lat) :: bnds_lat
REAL, DIMENSION(2,lon) :: bnds_lon
DOUBLE PRECISION, DIMENSION(lev) :: zlevs
DOUBLE PRECISION, DIMENSION(lev+1) :: zlev_bnds
REAL, DIMENSION(lev) :: a_coeff
REAL, DIMENSION(lev) :: b_coeff
REAL :: p0
REAL, DIMENSION(lev+1) :: a_coeff_bnds
REAL, DIMENSION(lev+1) :: b_coeff_bnds
INTEGER :: ilon, ilat, ipres, ilev, itim, ilon2,ilat2,itim2
INTEGER :: iht
! Other variables:
! ---------------------
INTEGER :: it, m, i, j
double precision bt
bt=0.
! ================================
! Execution begins here:
! ================================
! Read coordinate information from model into arrays that will be passed
! to CMOR.
! Read latitude, longitude, and pressure coordinate values into
! alats, alons, and plevs, respectively. Also generate latitude and
! longitude bounds, and store in bnds_lat and bnds_lon, respectively.
! Note that all variable names in this code can be freely chosen by
! the user.
! The user must write the subroutine that fills the coordinate arrays
! and their bounds with actual data. The following line is simply a
! a place-holder for the user's code, which should replace it.
! *** possible user-written call ***
call read_coords(alats, alons, plevs, bnds_lat, bnds_lon)
! Specify path where tables can be found and indicate that existing
! netCDF files should not be overwritten.
error_flag = cmor_setup(inpath='Test', netcdf_file_action='replace')
! Define dataset as output from the GICC model (first member of an
! ensemble of simulations) run under IPCC 2xCO2 equilibrium
! experiment conditions, and provide information to be included as
! attributes in all CF-netCDF files written as part of this dataset.
error_flag = cmor_dataset_json("Test/CMOR_input_example.json")
! Define all axes that will be needed
ilat = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='latitude', &
units='degrees_north', &
length=lat, &
coord_vals=alats, &
cell_bounds=bnds_lat)
ilon = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='longitude', &
length=lon, &
units='degrees_east', &
coord_vals=alons, &
cell_bounds=bnds_lon)
ipres = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='plev19', &
units='Pa', &
length=lev2, &
coord_vals=plevs)
ilat2 = cmor_axis( &
table='Tables/CMIP6_Lmon.json', &
table_entry='latitude', &
units='degrees_north', &
length=lat, &
coord_vals=alats, &
cell_bounds=bnds_lat)
ilon2 = cmor_axis( &
table='Tables/CMIP6_Lmon.json', &
table_entry='longitude', &
length=lon, &
units='degrees_east', &
coord_vals=alons, &
cell_bounds=bnds_lon)
itim2 = cmor_axis( &
table='Tables/CMIP6_Lmon.json', &
table_entry='time', &
units='days since 2030-1-1', &
length=ntimes, &
interval='1 month')
iht = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='height2m', &
units='m', &
length=1, &
coord_vals=(/3.0/))
! note that the time axis is defined next, but the time coordinate
! values and bounds will be passed to cmor through function
! cmor_write (later, below).
itim = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='time', &
units='days since 2030-1-1', &
length=ntimes, &
interval='1 month')
! define model eta levels (although these must be provided, they will
! actually be replaced by a+b before writing the netCDF file)
zlevs = (/ 0.1, 0.3, 0.55, 0.7, 0.9 /)
zlev_bnds=(/ 0.,.2, .42, .62, .8, 1. /)
ilev = cmor_axis( &
table='Tables/CMIP6_Amon.json', &
table_entry='standard_hybrid_sigma', &
length=lev, &
units='1',&
coord_vals=zlevs, &
cell_bounds=zlev_bnds)
! define z-factors needed to transform from model level to pressure
p0 = 1.e5
a_coeff = (/ 0.1, 0.2, 0.3, 0.22, 0.1 /)
b_coeff = (/ 0.0, 0.1, 0.2, 0.5, 0.8 /)
a_coeff_bnds=(/0.,.15, .25, .25, .16, 0./)
b_coeff_bnds=(/0.,.05, .15, .35, .65, 1./)
error_flag = cmor_zfactor( &
zaxis_id=ilev, &
zfactor_name='p0', &
units='Pa', &
zfactor_values = p0)
error_flag = cmor_zfactor( &
zaxis_id=ilev, &
zfactor_name='b', &
axis_ids= (/ ilev /), &
zfactor_values = b_coeff, &
zfactor_bounds = b_coeff_bnds )
error_flag = cmor_zfactor( &
zaxis_id=ilev, &
zfactor_name='a', &
axis_ids= (/ ilev /), &
zfactor_values = a_coeff, &
zfactor_bounds = a_coeff_bnds )
zfactor_id = cmor_zfactor( &
zaxis_id=ilev, &
zfactor_name='ps', &
axis_ids=(/ ilon, ilat, itim /), &
units='Pa' )
! Define the only field to be written that is a function of model level
! (appearing in IPCC table A1c)
var3d_ids(1) = cmor_variable( &
table='Tables/CMIP6_Amon.json', &
table_entry=entry3d(1), &
units=units3d(1), &
axis_ids=(/ ilon, ilat, ilev, itim /), &
missing_value=1.0e28, &
original_name=varin3d(1))
! Define variables appearing in IPCC table A1c that are a function of pressure
! (3-d variables)
bt = 1.e28
DO m=2,n3d
var3d_ids(m) = cmor_variable( &
table='Tables/CMIP6_Amon.json', &
table_entry=entry3d(m), &
units=units3d(m), &
axis_ids=(/ ilon, ilat, ipres, itim /), &
missing_value=1.0e28, &
original_name=varin3d(m))
ENDDO
! Define variables appearing in IPCC table A1a (2-d variables)
DO m=1,n2d
IF (m==2) THEN
var2d_ids(m) = cmor_variable( &
table='Tables/CMIP6_Amon.json', &
table_entry=entry2d(m), &
units=units2d(m), &
axis_ids=(/ ilat, iht, ilon, itim /), &
missing_value=bt, &
positive=positive2d(m), &
original_name=varin2d(m))
ELSE IF (m==3) THEN
var2d_ids(m) = cmor_variable( &
table='Tables/CMIP6_Lmon.json', &
table_entry=entry2d(m), &
units=units2d(m), &
axis_ids=(/ ilon2, ilat2, itim2 /), &
missing_value=1.0e28, &
positive=positive2d(m), &
original_name=varin2d(m))
ELSE
var2d_ids(m) = cmor_variable( &
table='Tables/CMIP6_Amon.json', &
table_entry=entry2d(m), &
units=units2d(m), &
axis_ids=(/ ilon, ilat, itim /), &
missing_value=1.0e28, &
positive=positive2d(m), &
original_name=varin2d(m))
ENDIF
ENDDO
PRINT*, ' '
PRINT*, 'completed everything up to writing output fields '
PRINT*, ' '
! Loop through history files (each containing several different fields,
! but only a single month of data, averaged over the month). Then
! extract fields of interest and write these to netCDF files (with
! one field per file, but all months included in the loop).
time_loop: DO it=1, ntimes
! In the following loops over the 3d and 2d fields, the user-written
! subroutines (read_3d_input_files and read_2d_input_files) retrieve
! the requested IPCC table A1c and table A1a fields and store them in
! data3d and data2d, respectively. In addition a user-written code
! (read_time) retrieves the time and time-bounds associated with the
! time sample (in units of 'days since 1970-1-1', consistent with the
! axis definitions above). The bounds are set to the beginning and
! the end of the month retrieved, indicating the averaging period.
! The user must write a code to obtain the times and time-bounds for
! the time slice. The following line is simply a place-holder for
! the user's code, which should replace it.
call read_time(it, time(1), bnds_time)
call read_3d_input_files(it, varin3d(1), data3d)
print*, 'shape(data3d)',shape(data3d),varin3d(1)
error_flag = cmor_write( &
var_id = var3d_ids(1), &
data = data3d, &
ntimes_passed = 1, &
time_vals = time, &
time_bnds = bnds_time )
call read_2d_input_files(it, varin2d(4), data2d)
print*, 'shape(data2d)',shape(data2d),varin2d(4)
error_flag = cmor_write( &
var_id = zfactor_id, &
data = data2d, &
ntimes_passed = 1, &
time_vals = time, &
time_bnds = bnds_time, &
store_with = var3d_ids(1) )
! Cycle through the 3-d fields (stored on pressure levels),
! and retrieve the requested variable and append each to the
! appropriate netCDF file.
DO m=2,n3d
! The user must write the code that fills the arrays of data
! that will be passed to CMOR. The following line is simply a
! a place-holder for the user's code, which should replace it.
call read_3d_input_files(it, varin3d(m), data3d)
! append a single time sample of data for a single field to
! the appropriate netCDF file.
print*, 'shape(data3d)',shape(data3d),varin3d(m)
error_flag = cmor_write( &
var_id = var3d_ids(m), &
data = data3d, &
ntimes_passed = 1, &
time_vals = time, &
time_bnds = bnds_time )
IF (error_flag < 0) THEN
! write diagnostic messages to standard output device
write(*,*) ' Error encountered writing IPCC Table A1c ' &
// 'field ', entry3d(m), ', which I call ', varin3d(m)
write(*,*) ' Was processing time sample: ', time
END IF
END DO
! Cycle through the 2-d fields, retrieve the requested variable and
! append each to the appropriate netCDF file.
DO m=1,n2d
print*, 'writing:',entry2d(m),m
! The user must write the code that fills the arrays of data
! that will be passed to CMOR. The following line is simply a
! a place-holder for the user's code, which should replace it.
call read_2d_input_files(it, varin2d(m), data2d)
! append a single time sample of data for a single field to
! the appropriate netCDF file.
IF (m == 2) THEN
DO j=1,lat
DO i=1,lon
scramble(j,1,i) = data2d(i,j)
END DO
END DO
error_flag = cmor_write( &
var_id = var2d_ids(2), &
data = scramble(:,1,:), &
ntimes_passed = 1, &
time_vals = time, &
time_bnds = bnds_time )
ELSE
error_flag = cmor_write( &
var_id = var2d_ids(m), &
data = data2d, &
ntimes_passed = 1, &
time_vals = time, &
time_bnds = bnds_time )
IF (error_flag < 0) THEN
! write diagnostic messages to standard output device
write(*,*) ' Error encountered writing IPCC Table A1a ' &
// 'field ', entry2d(m), ', which I call ', varin2d(m)
write(*,*) ' Was processing time sample: ', time
END IF
END IF
END DO
END DO time_loop
! Close all files opened by CMOR.
error_flag = cmor_close()
print*, ' '
print*, '******************************'
print*, ' '
print*, 'ipcc_test_code executed to completion '
print*, ' '
print*, '******************************'
END PROGRAM ipcc_test_code
|
