Changeset 1838 in lmdz_wrf for trunk/tools/generic_tools.py

Timestamp:

Mar 22, 2018, 6:13:46 PM (7 years ago)

Author:

lfita

Message:

Adding:

• `CFcorValues': Function to provide CF information about a given coordinate

File:

• trunk/tools/generic_tools.py (modified) (2 diffs)

trunk/tools/generic_tools.py

@@ -55 +55 @@
 # Capturing: Class to capture the standard output from a function
 # CF_gribequiv: Function to provide the GRIB variable code number from a CF name
+# CFcorValues: Function to provide CF information about a given coordinate
 # CFmonthU_daysU: Function to transform from a CF date series with units as 'months since [DATE]' to 'days since [DATE]'
 # CFvar_DIAGvar: Function to provide which model diagnostic values can provide a CF-variable from ASCII file
@@ -12670 +12671 @@
     return xtrm
 
+def CFcorValues(name):
+    """ Function to provide CF information about a given coordinate
+      name: name of dimension, axis, ....
+    >>> CFcorValues('lon')
+   {'units': 'degrees_east', '_CoordinateAxisType': 'Lon', 'stdn': 'longitude', 
+     'axis': 'X', 'longname': 'Longitude'}
+    >>> CFcorValues('T')
+   {'stdn': 'time', 'longname': 'Time', 'units': '[t] since [date]', 
+     '_CoordinateAxisType': 'Time', 'calendar': '[calendar]', 'axis': 'T'}
+    """ 
+    fname = 'CFDIMvalues'
+
+    # Dictionary for each dimension
+    CFlon= {'stdn': 'longitude', 'longname': 'Longitude', 'units': 'degrees_east',   \
+      'axis': 'X', '_CoordinateAxisType': 'Lon'}
+    CFlat= {'stdn': 'latitude', 'longname': 'Latitude', 'units': 'degrees_north',    \
+      'axis': 'Y', '_CoordinateAxisType': 'Lat'}
+    CFpress= {'stdn': 'pressure', 'longname': 'Pressure', 'units': 'Pa', 'axis': 'Z',\
+      '_CoordinateAxisType': 'Pres', 'positive': 'down'}
+    CFheight= {'stdn': 'height', 'longname': 'Height', 'units': 'm', 'axis': 'Z',    \
+      '_CoordinateAxisType': 'Height', 'positive': 'up'}
+    CFtime= {'stdn': 'time', 'longname': 'Time', 'units': '[t] since [date]',        \
+      'axis': 'T', '_CoordinateAxisType': 'Time', 'calendar': '[calendar]'}
+
+    # names to search for
+    lonn = ['lon', 'X', 'Longitude', 'longitude', 'x']
+    latn = ['lat', 'Y', 'Latitude', 'latitude', 'y']
+    pressn = ['press', 'P', 'Press', 'Pressure', 'pressure', 'p']
+    heightn = ['height', 'Z', 'Height', 'z']
+    timen = ['time', 'T', 'Time', 'TIME', 't']
+
+    if searchInlist(lonn, name):
+        cdfim = CFlon
+    elif searchInlist(latn, name):
+        cdfim = CFlat
+    elif searchInlist(pressn, name):
+        cdfim = CFpress
+    elif searchInlist(heightn, name):
+        cdfim = CFheight
+    elif searchInlist(timen, name):
+        cdfim = CFtime
+    else:
+        print errormsg
+        print '  ' + fname + ": coordinate name '" + name + "' not ready !!"
+        print "    available ones for 'X':", lonn
+        print "    available ones for 'Y':", latn
+        print "    available ones for 'Z' [pressure]:", pressn
+        print "    available ones for 'Z' [height]:", heightn
+        print "    available ones for 'T':", timen
+        quit(-1)
+
+    return cdfim
+
 #quit()