ESA.atmosphere.compute_gc_grid
index
/home/lfeng/otool/ESA/atmosphere/compute_gc_grid.py

Functions to calculate GEOS-Chem model horizontal grids 
 
Authors: L. Feng, Edinburgh University
History: v0.5, 2012.06.28
History: v0.95, 2012.10.28
 
Functions
==============================================
1. get_model_resolution: get model resolution from sizes of longitude and latitude grid.  
2. get_model_lat: calculate model grid latitudes
 
3. get_model_lon: calculate model grid longitudes
 
4. get_model_lat_edge: calculate edges of model latitude grid.  
 
 
5. get_model_lon_edge: calculate edges of model longitude grid.
 
6. get_wnd_lons: get window longitude range
 
7. get_wnd_lats: get window latitude range
 
8. get_area: calculate areas for grid box

 
Modules
       
ESA.util.geo_constant
ESA.util.message_m
numpy
ESA.util.otool_obj

 
Functions
       
get_area(lon_edge, lat_edge)
calculate areas for grid box (in m2)
 
Inputs:
--------------------------------------
1. lon_edge:<array, (nx+1,)>: edges of the X (longitude) grid boxes
2. lat_edge:<array, (ny+1,)>: edges of the Y (latitude) grid boxes
 
Returns:
------------------------------
1. area:<array, (nx, ny)>: area of grid box in m^2
get_model_lat(model_res=None, nlat=0)
calculate model grid latitudes 
Inputs:
    -------------------------------------
    1. model_res: <string>: model_resolution
    2. nlat:     <integer>: number of latitudes
    
    Returns:
    1. lats: <array, (ny,)>: model grid centre latitudes
get_model_lat_edge(model_res=None, nlat=0)
calculate edges of model latitude grid.
 
Inputs:
-------------------------------------------------
1. model_res: <string>: model_resolution
2. nlat:     <integer>: number of latitudes
 
Returns:
---------------------------------------------------
1. lat: <array, (ny+1,)>: model grid edge latitudes
get_model_lon(model_res=None, nlon=0)
calculate model grid longitudes 
Inputs:
    -------------------------------------
    1. model_res: <string>: model_resolution
    2. nlon:     <integer>: number of longitudes
    
    Returns:
    1. lon: <array, (nx,)>: model grid center longitudes
get_model_lon_edge(model_res=None, nlon=0)
calculate model grid longitudes 
Inputs:
----------------------------------------------------
1. model_res: <string>: model_resolution
2. nlon:     <integer>: number of longitudes
 
Returns:
------------------------------------------------
1. lon: <array, (nx+1,)>: model grid edge longitudes
get_model_resolution(nx, ny)
Get_model_resolution: get model resolution from sizes of longitude and latitude grid
 
Inputs:
-------------------------------------------------
1. nx:<int>: size of longitude
2. ny:<int>: size of latitude
 
Returns:
--------------------------------------
1. model_res:<str>: model resolution
get_wnd_lats(glb_lats, jx, jfirst)
get window latitude range 
 
Inputs:
-------------------------------------
1. glb_lats: <array, (ny,)>: model grid latitudes
2. jx:     <integer>: window y (latitude) size
3. jfirst:  <integer>: window y shift
 
Returns:
----------------------------------------------
1. lats: <array, (jx)>: window latitudes
get_wnd_lons(glb_lons, ix, ifirst, centre180)
get window longitude range 
 
Inputs:
-------------------------------------
1. glb_lons: <array, (nx,)>: model grid longitudes
2. ix:     <integer>: window x (longitude) size
3. ifirst:  <integer>: window shift
4. center180:<integer>: 0==model grid starting from -180.0
 
Returns:
-----------------------------------------------
1. lons: <array, (ix)>: window longitudes