var_utils Namespace Reference

Functions
def	ensSuffix (member)
def	splitObsVarGrp (WholeVarGrp)
def	splitIntSuffix (var)
def	appendSuffix (var, suf)
def	varAttributes (var)
def	groupSLASHvar (var, group)
def	varATgroup (var, group)
def	base2dbVar (baseVar, varName, fileFormat, outerIter=None)
def	modelVarAttributes (var)

Variables
float	miss_f = -88888.8
int	miss_i = -88888
string	miss_s = 'null'
string	csvSEP = ';'
string	obsVarAlt = 'altitude'
	NC variable names for MPAS-JEDI. More...
string	obsVarACI = 'asymmetric_cloud_impact'
string	obsVarBT = 'brightness_temperature'
string	obsVarBTClear = obsVarBT+'_assuming_clear_sky'
string	obsVarCldFrac = 'cloud_area_fraction'
string	obsVarDT = 'datetime'
string	obsVarGlint = 'glint'
string	obsVarLT = 'LocalTime'
string	obsVarLandFrac = 'land_area_fraction'
string	obsVarLat = 'latitude'
string	obsVarLon = 'longitude'
string	obsVarNormErr = 'dσ\N{SUPERSCRIPT MINUS}\N{SUPERSCRIPT ONE}'
string	obsVarPrs = 'air_pressure'
string	obsVarQC = 'QCflag'
string	obsVarSCI = 'symmetric_cloud_impact'
string	obsVarSenZen = 'sensor_zenith_angle'
string	obsVarSenAzi = 'sensor_azimuth_angle'
string	obsVarSolZen = 'solar_zenith_angle'
string	obsVarSolAzi = 'solar_azimuth_angle'
string	degree = u'\N{DEGREE SIGN}'
dictionary	varDictObs
string	obsRegionBinVar = 'ObsRegion'
string	vNameStr = 'varName'
string	vChanStr = 'varCHAN'
string	hofxGroup = 'hofx'
string	qcGroup = 'EffectiveQC'
string	errorGroup = 'EffectiveError'
string	bgIter = '0'
string	obsGroup = 'ObsValue'
string	metaGroup = 'MetaData'
string	depGroup = 'depIter'
string	diagGroup = 'ObsDiag'
string	geoGroup = 'GeoVaLs'
string	selfObsValue = 'selfObsValue'
string	selfDepValue = 'selfDepValue'
string	selfHofXValue = 'selfHofXValue'
string	selfQCValue = 'selfQCValue'
string	selfErrorValue = 'selfErrorValue'
string	bgHofXValue = 'bgHofXValue'
string	altMeta = 'altMeta'
string	cldfracMeta = 'cldfracMeta'
string	datetimeMeta = 'datetimeMeta'
string	latMeta = 'latMeta'
string	lonMeta = 'lonMeta'
string	prsMeta = 'prsMeta'
string	senzenMeta = 'senzenMeta'
string	senaziMeta = 'senaziMeta'
string	solzenMeta = 'solzenMeta'
string	solaziMeta = 'solaziMeta'
string	landfracGeo = 'landfracGeo'
string	clrskyBTDiag = 'clrskyBTDiag'
dictionary	ObsGroups = {}
dictionary	ObsVars = {}
string	intSufSeparator = '_'
string	mean = 'mean'
string	ensemble = 'ensemble'
string	ensSuffixBase = "&&&mem"
string	ncFileFormat = 'nc'
string	hdfFileFormat = 'hdf'
dictionary	IODAVarCtors
dictionary	BaseVars = {}
string	modVarPrs = 'pressure_p'
	NC variable names for MPAS-Model modVarAlt = 'zgrid' # --> needs to be interpolated to nVertLevels instead of nVertLevelsP1. More...
string	modVarLat = 'latCell'
string	modVarLon = 'lonCell'
string	modVarLev = 'model_level'
string	kgm3 = 'kg/m\N{SUPERSCRIPT THREE}'
dictionary	varDictModel
string	noBinVar = 'all'
	add dummy variable for no binning More...
string	modelRegionBinVar = 'ModelRegion'
list	modVarNames2d = ['t2m','surface_pressure','q2','u10','v10']
list	modVarNames3d = ['theta','temperature','rho','pressure','uReconstructZonal','uReconstructMeridional','qv','w']
	deg2rad = np.pi / np.float(180.0)
	rad2deg = np.float(180.0) / np.pi
	varDictAll = deepcopy(varDictObs)

Function Documentation

appendSuffix()

def var_utils.appendSuffix	(		var,
			suf
	)

Definition at line 193 of file var_utils.py.

base2dbVar()

def var_utils.base2dbVar	(		baseVar,
			varName,
			fileFormat,
			outerIter = None
	)

Definition at line 228 of file var_utils.py.

Here is the call graph for this function:

ensSuffix()

def var_utils.ensSuffix

(

member

)

Definition at line 161 of file var_utils.py.

groupSLASHvar()

def var_utils.groupSLASHvar	(		var,
			group
	)

Definition at line 207 of file var_utils.py.

modelVarAttributes()

def var_utils.modelVarAttributes

(

var

)

Definition at line 294 of file var_utils.py.

Here is the call graph for this function:

splitIntSuffix()

def var_utils.splitIntSuffix

(

var

)

Definition at line 182 of file var_utils.py.

Here is the call graph for this function:

Here is the caller graph for this function:

splitObsVarGrp()

def var_utils.splitObsVarGrp

(

WholeVarGrp

)

Definition at line 169 of file var_utils.py.

Here is the caller graph for this function:

varATgroup()

def var_utils.varATgroup	(		var,
			group
	)

Definition at line 210 of file var_utils.py.

varAttributes()

def var_utils.varAttributes

(

var

)

Definition at line 197 of file var_utils.py.

Here is the call graph for this function:

Variable Documentation

altMeta

string var_utils.altMeta = 'altMeta'

Definition at line 101 of file var_utils.py.

BaseVars

dictionary var_utils.BaseVars = {}

Definition at line 222 of file var_utils.py.

bgHofXValue

string var_utils.bgHofXValue = 'bgHofXValue'

Definition at line 100 of file var_utils.py.

bgIter

string var_utils.bgIter = '0'

Definition at line 81 of file var_utils.py.

cldfracMeta

string var_utils.cldfracMeta = 'cldfracMeta'

Definition at line 102 of file var_utils.py.

clrskyBTDiag

string var_utils.clrskyBTDiag = 'clrskyBTDiag'

Definition at line 112 of file var_utils.py.

csvSEP

string var_utils.csvSEP = ';'

Definition at line 13 of file var_utils.py.

datetimeMeta

string var_utils.datetimeMeta = 'datetimeMeta'

Definition at line 103 of file var_utils.py.

deg2rad

var_utils.deg2rad = np.pi / np.float(180.0)

Definition at line 303 of file var_utils.py.

degree

string var_utils.degree = u'\N{DEGREE SIGN}'

Definition at line 40 of file var_utils.py.

depGroup

string var_utils.depGroup = 'depIter'

Definition at line 88 of file var_utils.py.

diagGroup

string var_utils.diagGroup = 'ObsDiag'

Definition at line 91 of file var_utils.py.

ensemble

string var_utils.ensemble = 'ensemble'

Definition at line 159 of file var_utils.py.

ensSuffixBase

string var_utils.ensSuffixBase = "&&&mem"

Definition at line 160 of file var_utils.py.

errorGroup

string var_utils.errorGroup = 'EffectiveError'

Definition at line 80 of file var_utils.py.

geoGroup

string var_utils.geoGroup = 'GeoVaLs'

Definition at line 92 of file var_utils.py.

hdfFileFormat

string var_utils.hdfFileFormat = 'hdf'

Definition at line 214 of file var_utils.py.

hofxGroup

string var_utils.hofxGroup = 'hofx'

Definition at line 78 of file var_utils.py.

intSufSeparator

string var_utils.intSufSeparator = '_'

Definition at line 146 of file var_utils.py.

IODAVarCtors

dictionary var_utils.IODAVarCtors

Initial value:

=  {
  ncFileFormat: varATgroup,
  hdfFileFormat: groupSLASHvar,
}

Definition at line 215 of file var_utils.py.

kgm3

string var_utils.kgm3 = 'kg/m\N{SUPERSCRIPT THREE}'

Definition at line 259 of file var_utils.py.

landfracGeo

string var_utils.landfracGeo = 'landfracGeo'

Definition at line 111 of file var_utils.py.

latMeta

string var_utils.latMeta = 'latMeta'

Definition at line 104 of file var_utils.py.

lonMeta

string var_utils.lonMeta = 'lonMeta'

Definition at line 105 of file var_utils.py.

mean

string var_utils.mean = 'mean'

Definition at line 158 of file var_utils.py.

metaGroup

string var_utils.metaGroup = 'MetaData'

Definition at line 85 of file var_utils.py.

miss_f

float var_utils.miss_f = -88888.8

Definition at line 10 of file var_utils.py.

miss_i

int var_utils.miss_i = -88888

Definition at line 11 of file var_utils.py.

miss_s

string var_utils.miss_s = 'null'

Definition at line 12 of file var_utils.py.

modelRegionBinVar

string var_utils.modelRegionBinVar = 'ModelRegion'

Definition at line 288 of file var_utils.py.

modVarLat

string var_utils.modVarLat = 'latCell'

Definition at line 255 of file var_utils.py.

modVarLev

string var_utils.modVarLev = 'model_level'

Definition at line 257 of file var_utils.py.

modVarLon

string var_utils.modVarLon = 'lonCell'

Definition at line 256 of file var_utils.py.

modVarNames2d

list var_utils.modVarNames2d = ['t2m','surface_pressure','q2','u10','v10']

Definition at line 291 of file var_utils.py.

modVarNames3d

list var_utils.modVarNames3d = ['theta','temperature','rho','pressure','uReconstructZonal','uReconstructMeridional','qv','w']

Definition at line 292 of file var_utils.py.

modVarPrs

string var_utils.modVarPrs = 'pressure_p'

NC variable names for MPAS-Model modVarAlt = 'zgrid' # --> needs to be interpolated to nVertLevels instead of nVertLevelsP1.

Definition at line 254 of file var_utils.py.

ncFileFormat

string var_utils.ncFileFormat = 'nc'

Definition at line 213 of file var_utils.py.

noBinVar

string var_utils.noBinVar = 'all'

add dummy variable for no binning

Definition at line 285 of file var_utils.py.

obsGroup

string var_utils.obsGroup = 'ObsValue'

Definition at line 84 of file var_utils.py.

ObsGroups

dictionary var_utils.ObsGroups = {}

Definition at line 115 of file var_utils.py.

obsRegionBinVar

string var_utils.obsRegionBinVar = 'ObsRegion'

Definition at line 70 of file var_utils.py.

obsVarACI

string var_utils.obsVarACI = 'asymmetric_cloud_impact'

Definition at line 21 of file var_utils.py.

obsVarAlt

string var_utils.obsVarAlt = 'altitude'

NC variable names for MPAS-JEDI.

Definition at line 20 of file var_utils.py.

obsVarBT

string var_utils.obsVarBT = 'brightness_temperature'

Definition at line 22 of file var_utils.py.

obsVarBTClear

string var_utils.obsVarBTClear = obsVarBT+'_assuming_clear_sky'

Definition at line 23 of file var_utils.py.

obsVarCldFrac

string var_utils.obsVarCldFrac = 'cloud_area_fraction'

Definition at line 24 of file var_utils.py.

obsVarDT

string var_utils.obsVarDT = 'datetime'

Definition at line 25 of file var_utils.py.

obsVarGlint

string var_utils.obsVarGlint = 'glint'

Definition at line 26 of file var_utils.py.

obsVarLandFrac

string var_utils.obsVarLandFrac = 'land_area_fraction'

Definition at line 28 of file var_utils.py.

obsVarLat

string var_utils.obsVarLat = 'latitude'

Definition at line 29 of file var_utils.py.

obsVarLon

string var_utils.obsVarLon = 'longitude'

Definition at line 30 of file var_utils.py.

obsVarLT

string var_utils.obsVarLT = 'LocalTime'

Definition at line 27 of file var_utils.py.

obsVarNormErr

string var_utils.obsVarNormErr = 'dσ\N{SUPERSCRIPT MINUS}\N{SUPERSCRIPT ONE}'

Definition at line 31 of file var_utils.py.

obsVarPrs

string var_utils.obsVarPrs = 'air_pressure'

Definition at line 32 of file var_utils.py.

obsVarQC

string var_utils.obsVarQC = 'QCflag'

Definition at line 33 of file var_utils.py.

ObsVars

dictionary var_utils.ObsVars = {}

Definition at line 116 of file var_utils.py.

obsVarSCI

string var_utils.obsVarSCI = 'symmetric_cloud_impact'

Definition at line 34 of file var_utils.py.

obsVarSenAzi

string var_utils.obsVarSenAzi = 'sensor_azimuth_angle'

Definition at line 36 of file var_utils.py.

obsVarSenZen

string var_utils.obsVarSenZen = 'sensor_zenith_angle'

Definition at line 35 of file var_utils.py.

obsVarSolAzi

string var_utils.obsVarSolAzi = 'solar_azimuth_angle'

Definition at line 38 of file var_utils.py.

obsVarSolZen

string var_utils.obsVarSolZen = 'solar_zenith_angle'

Definition at line 37 of file var_utils.py.

prsMeta

string var_utils.prsMeta = 'prsMeta'

Definition at line 106 of file var_utils.py.

qcGroup

string var_utils.qcGroup = 'EffectiveQC'

Definition at line 79 of file var_utils.py.

rad2deg

var_utils.rad2deg = np.float(180.0) / np.pi

Definition at line 304 of file var_utils.py.

selfDepValue

string var_utils.selfDepValue = 'selfDepValue'

Definition at line 96 of file var_utils.py.

selfErrorValue

string var_utils.selfErrorValue = 'selfErrorValue'

Definition at line 99 of file var_utils.py.

selfHofXValue

string var_utils.selfHofXValue = 'selfHofXValue'

Definition at line 97 of file var_utils.py.

selfObsValue

string var_utils.selfObsValue = 'selfObsValue'

Definition at line 95 of file var_utils.py.

selfQCValue

string var_utils.selfQCValue = 'selfQCValue'

Definition at line 98 of file var_utils.py.

senaziMeta

string var_utils.senaziMeta = 'senaziMeta'

Definition at line 108 of file var_utils.py.

senzenMeta

string var_utils.senzenMeta = 'senzenMeta'

Definition at line 107 of file var_utils.py.

solaziMeta

string var_utils.solaziMeta = 'solaziMeta'

Definition at line 110 of file var_utils.py.

solzenMeta

string var_utils.solzenMeta = 'solzenMeta'

Definition at line 109 of file var_utils.py.

varDictAll

var_utils.varDictAll = deepcopy(varDictObs)

Definition at line 308 of file var_utils.py.

varDictModel

dictionary var_utils.varDictModel

Initial value:

=  {
  modVarLev:                [ miss_s, 'ModLev'],
  modVarLat:                [ degree, 'lat'  ],
  modVarLon:                [ degree, 'lon'  ],
  modVarPrs:                [ 'Pa',   'PP'   ],
  'pressure':               [ 'Pa',   'P'    ],
  'q2':                     [ 'g/kg', 'Q2m'  ],
  'qv':                     [ 'g/kg', 'Qv'   ],
  'rho':                    [ kgm3,   'rho'  ],
  'surface_pressure':       [ 'Pa',   'Ps'   ],
  't2m':                    [ 'C',    'T2m'  ],
  'temperature':            [ 'C',    'T'    ],
  'theta':                  [ 'K',    'Theta'],
  'u':                      [ 'm/s',  'uedge'],
  'u10':                    [ 'm/s',  'U10m' ],
  'uReconstructZonal':      [ 'm/s',  'U'    ],
  'uReconstructMeridional': [ 'm/s',  'V'    ],
  'v10':                    [ 'm/s',  'V10m' ],
  'w':                      [ 'm/s',  'W'    ],
}

Definition at line 262 of file var_utils.py.

varDictObs

dictionary var_utils.varDictObs

Initial value:

=  {
    'air_temperature':        [ 'K',     'T'       ],
    'bending_angle':          [ '%',     'Bnd'     ],
    obsVarBT:                 [ 'K',     'BT'      ],
    'eastward_wind':          [ 'm/s',   'U'       ],
    'northward_wind':         [ 'm/s',   'V'       ],
    'refractivity':           [ '%',     'Ref'     ],
    'specific_humidity':      [ 'kg/kg', 'qv'      ],
    'surface_pressure':       [ 'Pa',    'Ps'      ],
    'virtual_temperature':    [ 'K',     'Tv'      ],
    obsVarAlt:                [ 'm',     'alt'     ],
    obsVarACI:                [ 'K',     'ACI'     ],
    obsVarCldFrac:            [ miss_s,  'cldfrac' ],
    obsVarLandFrac:           [ miss_s,  'landfrac'],
    obsVarLat:                [ degree,  'lat'     ],
    obsVarLon:                [ degree,  'lon'     ],
    obsVarLT:                 [ 'hr',    obsVarLT  ],
    obsVarNormErr:            [ miss_s,  obsVarNormErr ],
    obsVarPrs:                [ 'hPa',   'P'       ],
    obsVarQC:                 [ miss_s,  obsVarQC  ],
    obsVarSCI:                [ 'K',     'SCI'     ],
    obsVarSenZen:             [ degree,  'zenith'  ],
    obsVarGlint:              [ degree,  obsVarGlint  ],
}

Definition at line 43 of file var_utils.py.

vChanStr

string var_utils.vChanStr = 'varCHAN'

Definition at line 75 of file var_utils.py.

vNameStr

string var_utils.vNameStr = 'varName'

Definition at line 74 of file var_utils.py.