Changeset 1863 in lmdz_wrf for trunk

Timestamp:

Mar 26, 2018, 4:46:27 PM (7 years ago)

Author:

lfita

Message:

Adding:

• `CFvars': Function to adapt a given variable and file following CF-standards

Location:

trunk/tools

Files:

• CFvariables.dat (added)
• nc_var_tools.py (modified) (4 diffs)

trunk/tools/nc_var_tools.py

@@ -31 +31 @@
 # CDO_toCF: Function to pass a CDO output file to CF-conventions
 # CFmorzization: Function to provide a CF-compilation version of a variable within a file
+# CFvars: Function to adapt a given variable and file following CF-standards
 # changevartype: Function to change the type of a variable (when possible)
 # chdimname: Changing the name of the dimension
@@ -23090 +23091 @@
     return newdim, newvar, newvarv, nonCFattr
 
+def CFvars(cfvarn, vardims, varvalues, outnc):
+    """ Function to adapt a given variable and file following CF-standards
+      NOTE: reading information from 'CFvariables.dat'
+        cfvarn= provided CF name of the variabale
+        vardims= dimensions of the variable
+        varvalues= values of the variable
+        outnc= netCDF object for the output
+    """
+    fname = 'CFvars'
+    inCFvarfile = 'CFvariables.dat'
+    availactions = ['new_z_dim']
+
+    oCFf = open(inCFvarfile, 'r')
+    CFvars = {}
+    for line in oCFf:
+        if line[0:1] != '#' and len(line) > 1:
+            linevals = line.replace('\n','').replace('\t','').split(' ')
+            CFvars[linevals[0]] = linevals[1:len(linevals)]
+
+    if not CFvars.has_key(cfvarn):
+        print errormsg
+        print '  ' + fname + ": file '" + inCFvarfile + "' does not have CF " +      \
+          "variable: '" + cfvarn + "' !!"
+        print '    available ones:', CFvars.keys()
+        print '    Nothing will be changed'
+        return None, None
+    else:
+        # Processing variable and take actions
+        print infmsg
+        print '    ' + fname + ": processing variale '" + cfvarn + "' with values:", \
+          CFvars[cfvarn]
+        CFactions = CFvars[cfvarn]
+        action = CFactions[0]
+
+        # Adding z-dimension
+        if action == 'new_z_dim':
+            newdim = CFactions[1]
+            newvdim = CFactions[2]
+            newvvar = np.float(CFactions[3])
+            outnc.createDimension(newdim, 1)
+            dimvals = gen.CFcorValues(newdim)
+            if not gen.searchInlist(outnc.dimensions, newdim):
+                newdim = outnc.createDimension(newdim, 1)
+            if not outnc.variables.has_key(newvdim):
+                newvar = outnc.createVariable(newvdim, 'f8', (newdim))
+                basicvardef(newvar, dimvals['stdn'], dimvals['longname'],            \
+                  dimvals['units'])
+                newvar[:] = newvvar
+                for ivn in dimvals.keys():
+                    if ivn != 'dimn' and ivn != 'stdn' and ivn != 'longname' and \
+                      ivn != 'units' and ivn != 'maxrank' and ivn != 'length':
+                        set_attribute(newvar,ivn,dimvals[ivn])
+            newvdn = []
+            newvshape = []
+            idim = 0
+            for vdn in vardims:
+                if vdn == 'time':
+                    newvdn.append(vdn)
+                    newvshape.append(varvalues.shape[idim])
+                    newvdn.append(newdim)
+                    newvshape.append(1)
+                else:
+                    newvdn.append(vdn)
+                    newvshape.append(varvalues.shape[idim])
+                idim = idim + 1
+            newvarvalues = np.zeros(tuple(newvshape), dtype=np.float)
+            newvarvalues[:,0,:,:] = varvalues
+        else:
+            print errormsg
+            print '  ' + fname + ": action '" + action + "' not ready !!"
+            print '    available onees:', availactions
+            quit(-1)
+
+    return newvdn, newvarvalues
+
 def CFmorzization(values, ncfile, variable):
     """ Function to provide a CF-compilation version of a variable within a file
@@ -23562 +23638 @@
             print '    ' + fname + ": creation of variable '" + cfvarn + "(" +       \
               ', '.join(CFvardims) + ")' ..."
-            newvar=onewnc.createVariable(cfvarn, 'f4', tuple(CFvardims),             \
-              fill_value=gen.fillValueF)
-            basicvardef(newvar, stdvarn, longvarn, utsvarn)
-
             # Providing the right coordinates
             coorv = []
@@ -23573 +23645 @@
                 elif cdn == 'time': print ' '
                 else: coorv.append(cdn)
+            newVdims, newVvalues = CFvars(cfvarn, CFvardims, ovar[:], onewnc)
+            if newVdims is None:
+                newvar=onewnc.createVariable(cfvarn, 'f4', tuple(CFvardims),         \
+                  fill_value=gen.fillValueF)
+                basicvardef(newvar, stdvarn, longvarn, utsvarn)
+                # Setting values, but taking into account pre-existing masked values
+                varv = ovar[:]
+                if type(varv) == type(gen.mamat):
+                    imaskv = varv.fill_value
+                    varv = np.where(varv == fill_value, gen.fillValueF, varv)
+            else:
+                newvar=onewnc.createVariable(cfvarn, 'f4', tuple(newVdims),          \
+                  fill_value=gen.fillValueF)
+                basicvardef(newvar, stdvarn, longvarn, utsvarn)
+                # Setting values, but taking into account pre-existing masked values
+                if type(newVvalues) == type(gen.mamat):
+                    imaskv = varv.fill_value
+                    varv = np.where(varv == fill_value, gen.fillValueF, newVvalues)
+                else:
+                    varv = newVvalues
+
+            newvar[:] = varv[:]
             set_attribute(newvar, 'coordinates', ' '.join(coorv))
 
-            # Setting values, but taking into account pre-existing masked values
-            varv = ovar[:]
-            if type(varv) == type(gen.mamat):
-                imaskv = varv.fill_value
-                varv = np.where(varv == fill_value, gen.fillValueF, varv)
- 
-            newvar[:] = varv[:]
             set_attribute(newvar, 'grid_mapping', gattr['grid'])
             onewnc.sync()