Changeset 579 for trunk/UTIL/PYTHON/planetoplot.py

Timestamp:

Mar 14, 2012, 1:22:19 AM (13 years ago)

Author:

aslmd

Message:

PYTHON UTIL. improved comments for the first part. corrected a bug: for 3D fields xyt it was necessary to add --vert 0 to have x,y,or t as abscissae, this is no longer the case.

File:

• trunk/UTIL/PYTHON/planetoplot.py (modified) (4 diffs)

trunk/UTIL/PYTHON/planetoplot.py

@@ -10 +10 @@
 ### A. Spiga     -- LMD --    12/2011 -- Added HTML animated page capability + general tests of consistency [winds, etc...] + consistent generic movie loop
 ### J. Leconte   -- LMD --    02/2012 -- Added area weighted averaging. Compatibility with terrestrial gcm.
+### A. Spiga     -- LMD --    03/2012 -- Cleaning and improved comments 
 def planetoplot (namefiles,\
            level=0,\
@@ -86 +87 @@
     #from singlet import singlet
 
-    ################################
-    ### Preliminary stuff
-    ################################
+#########################
+### PRELIMINARY STUFF ###
+#########################
+### we say hello
     print "********************************************"
     print "********** WELCOME TO PLANETOPLOT **********"
     print "********************************************"
+### we ensure namefiles and var are arrays
     if not isinstance(namefiles, np.ndarray): namefiles = [namefiles]
     if not isinstance(var, np.ndarray):       var = [var]
-    initime=-1
-
-    ################################
-    ### Which plot needs to be done?
-    ################################
-    sslon = None ; sslat = None
+### we initialize a few variables
+    initime=-1 ; sslon = None ; sslat = None
+    k = 0 ; firstfile = True ; count = 0
+### we avoid specific cases not yet implemented
+    if mrate is not None and len(var) > 1: errormess("multivar not allowed in movies. should be fixed soon!")
+### we prepare number of plot fields [zelen] and plot instances [numplot] according to user choices
+### --> we support multifile and multivar plots : files + vars separated by commas are on the same figure
     nlon, nlat, nvert, ntime, mapmode, nslices = determineplot(slon, slat, svert, stime)
-    if mrate is not None and len(var) > 1: errormess("multivar not allowed in movies. should be fixed soon!")
     zelen = len(namefiles)*len(var)
     numplot = zelen*nslices
     print "********** FILES, SLICES, VARS, TOTAL PLOTS: ", len(namefiles), nslices, len(var), numplot
+    print "********** MAPMODE: ", mapmode
+### we correct number of plot fields for possible operation (substract, etc...)
     if ope is not None:
         if fileref is not None:       zelen = zelen + 2
         elif "var" in ope:            zelen = zelen + 1
-    all_var  = [[]]*zelen ; all_var2  = [[]]*zelen ; all_title = [[]]*zelen ; all_varname = [[]]*zelen ; all_namefile = [[]]*zelen ; all_time = [[]]*zelen ; all_windu = [[]]*zelen ; all_windv = [[]]*zelen
+### we define the arrays for plot fields -- which will be placed within multiplot loops
+    all_var  = [[]]*zelen ; all_var2  = [[]]*zelen 
+    all_title = [[]]*zelen ; all_varname = [[]]*zelen ; all_namefile = [[]]*zelen ; all_time = [[]]*zelen 
+    all_windu = [[]]*zelen ; all_windv = [[]]*zelen
  
-    #################################################################################################
-    ### Loop over the files + vars initially separated by commas to be plotted on the same figure ###
-    #################################################################################################
-    k = 0 ; firstfile = True ; count = 0
+#############################
+### LOOP OVER PLOT FIELDS ###
+#############################
     for nnn in range(len(namefiles)):
      for vvv in range(len(var)): 
 
-      ######################
-      ### Load NETCDF object
+    ### we load each NETCDF objects in namefiles
       namefile = namefiles[nnn] 
       nc  = Dataset(namefile)
+    ### we explore the variables in the file
       varinfile = nc.variables.keys()
       if seevar: print varinfile ; exit()
-
-      ##################################
-      ### Initial checks and definitions
-      ### ... TYPEFILE
+    ### we define the type of file we have (gcm, meso, etc...)
       typefile = whatkindfile(nc)
+      if firstfile:                 typefile0 = typefile
+      elif typefile != typefile0:   errormess("Not the same kind of files !", [typefile0, typefile])
+    ### we care for input file being 1D simulations 
       if typefile in ['gcm'] and len(nc.variables["longitude"][:]) is 1 and len(nc.variables["latitude"][:]) is 1:       mapmode=0 ; winds=False
       elif typefile in ['earthgcm'] and len(nc.variables["lon"][:]) is 1 and len(nc.variables["lat"][:]) is 1:           mapmode=0 ; winds=False
+    ### we create default vert and time prescriptions if not here in case mapping mode is on (lat/lon maps)
       if redope is None and mapmode == 1:
           if svert is None:  svert = readslices(str(level)) ; nvert=1
@@ -135 +143 @@
              stime = readslices(str(0)) ; ntime=1 ## this is a default choice
              print "WELL... nothing about time axis. I took default: first time reference stored in file."
-
-      if firstfile: print "********** MAPMODE: ", mapmode
-      if firstfile:                 typefile0 = typefile
-      elif typefile != typefile0:   errormess("Not the same kind of files !", [typefile0, typefile])
-      ### ... VAR
+    ### we get the names of variables to be read. in case only one available, we choose this one.
       varname=var[vvv] 
       if ((varname not in nc.variables) and not ((typefile in ['meso']) and (varname in ['UV','uv','uvmet']))): 
           if len(varinfile) == 1:   varname = varinfile[0] 
           else:                     varname = False
-      ### ... WINDS
+    ### we get the names of wind variables to be read (if any)
       if winds:                                                    
          [uchar,vchar,metwind] = getwinddef(nc)             
          if uchar == 'not found': winds = False
+    ### we tell the user that either no var or no wind is not acceptable
       if not varname and not winds: errormess("please set at least winds or var",printvar=nc.variables)
-      ### ... COORDINATES, could be moved below
+    ### we get the coordinates lat/lon to be used
       [lon2d,lat2d] = getcoorddef(nc)
-      ### ... PROJECTION
+    ### we get an adapted map projection if none is provided by the user
       if proj == None:   proj = getproj(nc)                 
-
+    ### we define plot boundaries given projection or user choices
       if firstfile:
-         ##########################
-         ### Define plot boundaries
-         ### todo: possible areas in latinterv in argument (ex: "Far_South_Pole")
          if proj in ["npstere","spstere"]: [wlon,wlat] = polarinterv(lon2d,lat2d)
          elif proj in ["lcc","laea"]:      [wlon,wlat] = wrfinterv(lon2d,lat2d)
@@ -493 +495 @@
                         if not tile:  zeline='-'
                         else:         zeline=','
-                        if indexvert is not None or indextime is None:    plot(x,what_I_plot_frame,zeline,label=lbl)  ## regular plot
-                        else:                                             plot(what_I_plot_frame,x,zeline,label=lbl)  ## vertical profile
+                        this_is_a_regular_plot = (indexvert is not None) or (indextime is None) or (indexlat is None) or (indexlon is None)
+                        if this_is_a_regular_plot:   plot(x,what_I_plot_frame,zeline,label=lbl)  ## vertical profile
+                        else:                        plot(what_I_plot_frame,x,zeline,label=lbl)  ## regular plot
                         if nplot > 1: legend(loc='best')
                         if indextime is None and axtime is not None and xlab is None:    xlabel(axtime.upper()) ## define the right label