#################################################### ### A Python Class for the Mars Climate Database ### ### ---------------------------------------------### ### Aymeric SPIGA 17-21/04/2012 ### ### ---------------------------------------------### ### (see mcdtest.py for examples of use) ### #################################################### import numpy as np import fmcd import matplotlib.pyplot as mpl import myplot class mcd: def __repr__(self): # print out a help string when help is invoked on the object whatprint = 'MCD object. \"help(mcd)\" for more information\n' return whatprint ######################## ### Default settings ### ######################## def __init__(self): # default settings ## 0. general stuff self.name = "MCD v4.3 output" self.dset = '/home/aymeric/Science/MCD_v4.3/data/' ## 1. spatio-temporal coordinates self.lat = 0. self.lon = 0. self.loct = 0. self.xdate = 0. # see datekey self.xz = 10. # see zkey ## 1bis. related settings self.zkey = 3 # specify that xz is the altitude above surface (m) self.datekey = 1 # 0 = "Earth time": xdate is given in Julian days (localtime must be set to zero) # 1 = "Mars date": xdate is the value of Ls ## 2. climatological options self.dust = 2 #our best guess MY24 scenario, with solar average conditions self.hrkey = 1 #set high resolution mode on (hrkey=0 to set high resolution off) ## 3. additional settings for advanced use self.extvarkey = 1 #extra output variables (1: yes, 0: no) self.perturkey = 0 #integer perturkey ! perturbation type (0: none) self.seedin = 1 #random number generator seed (unused if perturkey=0) self.gwlength = 0. #gravity Wave wavelength (unused if perturkey=0) ## outputs. just to define attributes. ## --> in update self.pres = None ; self.dens = None ; self.temp = None ; self.zonwind = None ; self.merwind = None ; self.meanvar = None ; self.extvar = None self.seedout = None ; self.ierr = None ## --> in prepare self.xcoord = None ; self.ycoord = None self.prestab = None ; self.denstab = None ; self.temptab = None self.zonwindtab = None ; self.merwindtab = None ; self.meanvartab = None ; self.extvartab = None def viking1(self): self.name = "Viking 1 site. MCD v4.3 output" ; self.lat = 22.48 ; self.lon = -49.97 ; self.xdate = 97. def viking2(self): self.name = "Viking 2 site. MCD v4.3 output" ; self.lat = 47.97 ; self.lon = -225.74 ; self.xdate = 117.6 def getextvarlab(self,num): whichfield = { \ 91: "Pressure (Pa)", \ 92: "Density (kg/m3)", \ 93: "Temperature (K)", \ 94: "W-E wind component (m/s)", \ 95: "S-N wind component (m/s)", \ 1: "Radial distance from planet center (m)",\ 2: "Altitude above areoid (Mars geoid) (m)",\ 3: "Altitude above local surface (m)",\ 4: "orographic height (m) (surface altitude above areoid)",\ 5: "Ls, solar longitude of Mars (deg)",\ 6: "LST local true solar time (hrs)",\ 7: "Universal solar time (LST at lon=0) (hrs)",\ 8: "Air heat capacity Cp (J kg-1 K-1)",\ 9: "gamma=Cp/Cv Ratio of specific heats",\ 10: "density RMS day to day variations (kg/m^3)",\ 11: "[not defined]",\ 12: "[not defined]",\ 13: "scale height H(p) (m)",\ 14: "GCM orography (m)",\ 15: "surface temperature (K)",\ 16: "daily maximum mean surface temperature (K)",\ 17: "daily minimum mean surface temperature (K)",\ 18: "surf. temperature RMS day to day variations (K)",\ 19: "surface pressure (high resolution if hireskey=1)",\ 20: "GCM surface pressure (Pa)",\ 21: "atmospheric pressure RMS day to day variations (Pa)",\ 22: "surface pressure RMS day to day variations (Pa)",\ 23: "temperature RMS day to day variations (K)",\ 24: "zonal wind RMS day to day variations (m/s)",\ 25: "meridional wind RMS day to day variations (m/s)",\ 26: "vertical wind component (m/s) >0 when downwards!",\ 27: "vertical wind RMS day to day variations (m/s)",\ 28: "small scale perturbation (gravity wave) (kg/m^3)",\ 29: "q2: turbulent kinetic energy (m2/s2)",\ 30: "[not defined]",\ 31: "thermal IR flux to surface (W/m2)",\ 32: "solar flux to surface (W/m2)",\ 33: "thermal IR flux to space (W/m2)",\ 34: "solar flux reflected to space (W/m2)",\ 35: "surface CO2 ice layer (kg/m2)",\ 36: "DOD: Dust column visible optical depth",\ 37: "Dust mass mixing ratio (kg/kg)",\ 38: "DOD RMS day to day variations",\ 39: "DOD total standard deviation over season",\ 40: "Water vapor column (kg/m2)",\ 41: "Water vapor vol. mixing ratio (mol/mol)",\ 42: "Water ice column (kg/m2)",\ 43: "Water ice mixing ratio (mol/mol)",\ 44: "O3 ozone vol. mixing ratio (mol/mol)",\ 45: "[CO2] vol. mixing ratio (mol/mol)",\ 46: "[O] vol. mixing ratio (mol/mol)",\ 47: "[N2] vol. mixing ratio (mol/mol)",\ 48: "[CO] vol. mixing ratio (mol/mol)",\ 49: "R: Molecular gas constant (J K-1 kg-1)",\ 50: "Air viscosity estimation (N s m-2)" } if num not in whichfield: myplot.errormess("Incorrect subscript in extvar.") return whichfield[num] def convertlab(self,num): ## a conversion from text inquiries to extvar numbers. to be completed. if num == "p": num = 91 elif num == "rho": num = 92 elif num == "t": num = 93 elif num == "u": num = 94 elif num == "v": num = 95 elif num == "tsurf": num = 15 elif num == "topo": num = 4 elif num == "h": num = 13 elif num == "ps": num = 19 elif num == "tau": num = 36 elif num == "mtot": num = 40 elif num == "icetot": num = 42 elif num == "ps_ddv": num = 22 elif num == "h2ovap": num = 41 elif num == "h2oice": num = 43 elif num == "cp": num = 8 elif num == "rho_ddv": num = 10 elif num == "tsurfmx": num = 16 elif num == "tsurfmn": num = 17 elif num == "lwdown": num = 31 elif num == "swdown": num = 32 elif num == "lwup": num = 33 elif num == "swup": num = 34 elif num == "o3": num = 44 elif num == "o": num = 46 elif num == "co": num = 48 elif num == "visc": num = 50 elif num == "co2ice": num = 35 elif not isinstance(num, np.int): myplot.errormess("field reference not found.") return num ################### ### One request ### ################### def update(self): # retrieve fields from MCD (call_mcd). more info in fmcd.call_mcd.__doc__ (self.pres, self.dens, self.temp, self.zonwind, self.merwind, \ self.meanvar, self.extvar, self.seedout, self.ierr) \ = \ fmcd.call_mcd(self.zkey,self.xz,self.lon,self.lat,self.hrkey, \ self.datekey,self.xdate,self.loct,self.dset,self.dust, \ self.perturkey,self.seedin,self.gwlength,self.extvarkey ) ## we use the end of extvar (unused) to store meanvar. this is convenient for getextvar(lab) self.extvar[90] = self.pres ; self.extvar[91] = self.dens self.extvar[92] = self.temp ; self.extvar[93] = self.zonwind ; self.extvar[94] = self.merwind def printset(self): # print main settings print "zkey",self.zkey,"xz",self.xz,"lon",self.lon,"lat",self.lat,"hrkey",self.hrkey, \ "xdate",self.xdate,"loct",self.loct,"dust",self.dust def getnameset(self): # set a name referring to settings [convenient for databases] name = str(self.zkey)+str(self.xz)+str(self.lon)+str(self.lat)+str(self.hrkey)+str(self.datekey)+str(self.xdate)+str(self.loct)+str(self.dust) return name def printcoord(self): # print requested space-time coordinates print "LAT",self.lat,"LON",self.lon,"LOCT",self.loct,"XDATE",self.xdate def printmeanvar(self): # print mean MCD variables print "Pressure = %5.3f pascals. " % (self.pres) print "Density = %5.3f kilograms per cubic meter. " % (self.dens) print "Temperature = %3.0f kelvins (%4.0f degrees celsius)." % (self.temp,self.temp-273.15) print "Zonal wind = %5.3f meters per second." % (self.zonwind) print "Meridional wind = %5.3f meters per second." % (self.merwind) def printextvar(self,num): # print extra MCD variables num = self.convertlab(num) print self.getextvarlab(num) + " ..... " + str(self.extvar[num-1]) def printallextvar(self): # print all extra MCD variables for i in range(50): self.printextvar(i+1) def htmlprinttabextvar(self,tabtodo): print "Results from the Mars Climate Database" print "