source: lmdz_wrf/trunk/tools/documentation/ncmanage/CFmorzization.html

Last change on this file was 1860, checked in by lfita, 7 years ago

Fixing format of the help
File size: 9.7 KB
Line 
1<HTML>
2  <HEAD>
3    <META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=utf-8">
4    <LINK REL="stylesheet" TYPE="text/css" HREF="../PyNCplot.css"/>
5  </HEAD>
6
7  </HEAD>
8  <BODY>
9    <DIV CLASS="valheader">
10      CFmorzization
11    </DIV>
12    <DIV CLASS="valimg">
13    <P STYLE="text-align:left;">
14      Provide a CF-compilation version of a variable within a file.
15      See further details at:
16      <UL>
17        <LI><A HREF="http://cordex.org/publications/report-and-document-archives/" TARGET="_blank" CLASS="lc">Christensen, Gutowski, Nikulin, and Legutke; 2013. CORDEX Archive Design</A></LI>
18        <LI><A HREF="http://cmip-pcmdi.llnl.gov/cmip5/output_req.html#metadata" TARGET="_bkan" CLASS="lc">Taylor, K., and C. Doutriaux, 2011. CMIP5 Model Output Requirements: File Contents and Format, Data Structure and Meta Data</A></LI>
19      </UL>
20    </P>
21    </DIV>
22    <DIV CLASS="valhelp">
23    varaddattr(values, ncfile, varn)<BR>
24    &nbsp;&nbsp;values=[dimvarns]:[globattrfile]:[projectfile]<BR>
25    &nbsp;&nbsp;&nbsp;&nbsp;[dimvarns]: ',' separated list for identification of axes, dimensions and <BR>
26    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variable-dimensions as '[AXIS]|[dimn]|[vardimn]'<BR>
27    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[AXIS]: axis of the file: 'X', 'Y', 'Z', or 'T'<BR>
28    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[dimn]: name of the current name of the dimension of the given axis<BR>
29    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[vardimn]: name of the current name of the variable-dimension of the <BR>
30    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;given axis<BR>
31    &nbsp;&nbsp;&nbsp;&nbsp;[globattrfilen]: name of ASCII file with the given metadata to be added as global attributes<BR>
32    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;with a line per attribute [attrname] [value](use '!' for spaces] (underparenthesis<BR>
33    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;for description)<BR>
34    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;use '#' for comments<BR>
35    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;File has to have at least:<BR>
36    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;institute_id [value] (CV)<BR>
37    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;institution  [value]<BR>
38    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;model_id [value] (CORDEX starts with &lt;institute_id&gt;-)<BR>
39    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;experiment_id [value] (same CV as CMIP5 with "evaluation" in addition)<BR>
40    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;experiment [value] (long version of "experiment_id")<BR>
41    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;contact [value] ([Name], [email] of contact person)<BR>
42    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;product [value] (single value: "output")<BR>
43    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Conventions [value] (later than CF1.4 if present / single value: "CF-1.4")<BR>
44    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;creation_date [value] ([YYYY-MM-DDTHH:MM:SSZ] format according to UNIDATA<BR>
45    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;conventions, same in CMIP5 & CORDEX)<BR>
46    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;frequency [value] (same CV as CMIP5 with "sem" in addition; 3hr highest <BR>
47    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;freq. in CORDEX; no "yr")<BR>
48    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;driving_model_id [value] (CMIP5 institute_id, &lt;CMIP5 institute_id&gt;-<BR>
49    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&lt;member in CMIP5 CV list of model_id&gt;)<BR>
50    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;driving_model_ensemble_member [value] (CMIP5 CV, e.g. "r1i1p1")<BR>
51    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;driving_experiment_name [value] ("evaluation" or &lt;member in CMIP5 CV <BR>
52    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;list of experiment_id&gt;)<BR>
53    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;driving_experiment [value] ("&lt;driving_model_id&gt;,&lt;driving_experiment_name&gt;,&lt;driving_model_ensemble_member&gt;", <BR>
54    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;members of the CMIP5 list of forcing agents are not necessarily<BR>
55    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;forcing agents of RCM (besides implicitly<BR>
56    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;in driving_experimnt)<BR>
57    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;rcm_version_id [value] (&lt;free text string&gt;; valid characters only <BR>
58    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;indicates model modifs during the project e.g.: parameterizations,<BR>
59    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;small upgrades)<BR>
60    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;project_id [value] (single value)<BR>
61    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CORDEX_domain [value] ((e.g.: "AFR-44", "AFR-44i", includes resolution acronym)<BR>
62    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;tracking_id [value] (not required or explained in ADD; it is, however, <BR>
63    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;strongly recommended to include it as prescribed CMIP5.)<BR>
64    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;basetime [value] (reference time "1949-12-01T00:00:00Z" formatted acording <BR>
65    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to UNIDATA conventions)<BR>
66    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;calendar [value] (CF conventions as in driving model)<BR>
67    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;grid [value] (according to CF conventions)<BR>
68    &nbsp;&nbsp;&nbsp;&nbsp;[projectfile]: ASCII file with all the CF-mandatory projection information. A line for each <BR>
69    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;attribute. Name of the variable to be used to refer the projection inside the file will <BR>
70    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;be the same as global attribute `grid'<BR>
71    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;See more information from: <A HREF="http://cfconventions.org/Data/cf-conventions/cf-conventions-1.7/build/ch05s06.html" TARGET="_blan" CLASS="lc">CF-conventions</A><BR>
72    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; (...) (specific projection attributes and values)<BR>
73    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; [name] [value] [kind] ('I': integer, 'R': float, 'D': double float, 'S': string)<BR>
74    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Add three more attributes for the resolution of the projection:<BR>
75    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; x_resolution [value] (resolution along x-axis)<BR>
76    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; y_resoltuion [value] (resolution along y-axis)<BR>
77    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; proj_units [value] (units of the resoltion of the projection)<BR>
78    &nbsp;&nbsp;ncfile= netCDF file to use<BR>
79    &nbsp;&nbsp;variable= ',' list of [varfn]@[method]@[Tbnds] to CF transform. A separated file will be <BR>
80    &nbsp;&nbsp;&nbsp;&nbsp;created for each variable<BR>
81    &nbsp;&nbsp;&nbsp;&nbsp;use [varfn]@instantaneous@None for instantaneous values<BR>
82    &nbsp;&nbsp;&nbsp;&nbsp;NOTE: CF values will be taken from 'variables_values.dat'<BR>
83    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[varfn]: name of the variable inside the file<BR>
84    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[method]: cell_method of the variable ('!' for spaces) uing, standard CF description:<BR> 
85    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<A HREF="http://cfconventions.org/cf-conventions/cf-conventions.html#_data_representative_of_cells" TARGET="_blank" CLASS="lc">CF-conventions cell representation</A><BR>
86    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[var_time_bnds]: variable with the time_bnds values, or:<BR>
87    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* 'WRFtime_bnds'|[tunit]|[quantity], to be computed directly from WRF for a <BR>
88    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;given period of time as:<BR>
89    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tunit]: unit of time: 'c' century, 'y' year, 'm' month, 'w' week, 'd' day, <BR>
90    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'h' hour, 'i' minute, 's' second<BR>
91    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[quantity] = amount (integer) of [tunit] to cover a period of time_bnds<BR>
92    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* 'Ctime_bnds'|[tvarn]|[tunit]|[quantity], to be computed directly from a <BR>
93    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;variable from a given period of time as:<BR>
94    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tvarn]: name of the variable<BR>
95    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tunit]: unit of time: 'c' century, 'y' year, 'm' month, 'w' week, 'd' day,<BR> 
96    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;'h' hour, 'i' minute, 's' second<BR>
97    &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[quantity] = amount (integer) of [tunit] to cover a period of time_bnds<BR>
98    </DIV>
99    <DIV CLASS="valins">
100      $ python ${pyHOME}/nc_var.py -o CFmorzization -S 'X|west_east|XLONG,Y|south_north|XLAT,T|Time|WRFtime,Z|<BR>
101&nbsp;&nbsp;bottom_top|ZNU:GlobalAttr1995.inf:proj1995.inf' -f ~/PY/wrfout_d01_1995-01-01_00\:00\:00 <BR>
102&nbsp;&nbsp;-v QFX@instantaneous@None<BR>
103      $ python ${pyHOME}/nc_var.py -o CFmorzization -S 'X|west_east|XLONG,Y|south_north|XLAT,T|Time|WRFtime,Z|<BR>
104&nbsp;&nbsp;bottom_top|ZNU:GlobalAttr1995.inf:proj1995.inf' -f ~/PY/wrfout_d01_1995-01-01_00\:00\:00 <BR>
105&nbsp;&nbsp;-v 'RAINC@time:!accumulation@WRFtime_bnds|h|3'
106    </DIV>
107  </BODY>
108</HTML>
109
Note: See TracBrowser for help on using the repository browser.