| | |
- get_data(fdesc, traname, category, tracer)
- find data according to criteria of traname, category and tracer ID
Inputs:
-------------------------------------
1. fdesc:<gcfdesc_cl>: file access
2. traname:<str>: tracer name
3. category:<str>: category
4. tracer:<int>: tracer ID
Returns:
---------------------------------------------
found_data_lst:<list, t:array>: selected data set
- get_mod_gp(fdesc, traname='CO2', category=None, tracer=None)
- get model profile for selected variables
Inputs:
-------------------------------------
1. fdesc:<gcfdesc_cl>: file access
2. traname:<str>: tracer name
3. category:<str>: category
4. tracer:<int>: tracer ID
Returns:
---------------------------------------------
gp_lst:<array>: selected data set
Notes:
--------------------------------------------------
1. if fdesc.data_lst contains list of profile, gp_lst will be an array in the shape
of [nobs, nlvl, ntracer (nem)] or shape of [nobs, ntracer]
- get_mod_pres(fdesc, **keywords)
- Calculate or find model pressure
Inputs:
----------------------------------
1. fdesc:<gcfdesc_cl>: file descript to GEOS-Chem
2. keywords:<dict>: for extra inputs
---reserved keys:
---traname:<str>: traname for pressure or sp
---use_sp:<T/F>: True, surface pressure will be used to calculate pressures
---geos_ver:<int>: GEOS-Chem version
---use_reduced:<int>: 1 means reduced model vertical grid is used
---Reserved keys:
---category:<str>: category of the surface pressure or pressure
---tracer:<int>: tracer ID of surface pressure or model pressure
---tau:<float>: time of surface pressure or model pressure
returns:
--------------------------------------------------
1. mod_pres:<array>: model pres
- get_mod_sp(fdesc, sp_traname='PSURF', sp_category=None, sp_tracer=None)
- get model surface pressure
- open_enr_file(datapath, flnm, ftracerinfo, fdiaginfo, yyyy, mm, dd, categorys=None, tracers=None, taus=None, tranames=None, is_enr_file=True, **fio_keywords)
- setup fdesc for GEOS-Chem ensemble runs
Inputs:
--------------------------------------------------------------
1. datapath:<str>: path
2. flnm:<str>: file name
3, ftracerinfo:<str>: name for tracerinfo file
4. fdiaginfo:<str>: name for diaginfo file
5. categorys:<list, t:str>: list of categorys to be read
6. tracers:<list,t:int>: list of tracers to be read
7. taus:<list, t:float>: list of taus to be read
8. tranames:<list, t:str>:list of tracer name
9. is_enr_file:<T/F>: True if it is for ensemble run file
10. fio_keywords: <dict>: extra inputs for file IO
---Reserved keywords:
--->enr_yst_lst:<list, t:int>:list of years for ensemble run
--->enr_dst_lst:<list, t:int> list of doy for ensemble run
--->enr_step_lst:<list, int>: list of step for ensemble run
--->enr_emst_lst:<list, int>: list of start ensemble for ensemble run
--->enr_emend_lst:<list, int>: list of start ensemble for ensemble run
Returns:
--------------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
- open_ts_file(datapath, flnm, ftracerinfo, fdiaginfo, yyyy, mm, dd, categorys=None, tracers=None, taus=None, tranames=None, **fio_keywords)
- setup fdesc for GEOS-Chem outputs
Inputs:
--------------------------------------------------------------
1. datapath:<str>: path
2. flnm:<str>: file name
3, ftracerinfo:<str>: name for tracerinfo file
4. fdiaginfo:<str>: name for diaginfo file
5. categorys:<list, t:str>: list of categorys to be read
6. tracers:<list,t:int>: list of tracers to be read
7. taus:<list, t:float>: list of taus to be read
8. tranames:<list, t:str>:list of tracer name
9. fio_keywords: <dict>: extra inputs for file IO
---Reserved keywords:
--
Returns:
--------------------------------------------------------
1. fdesc:<file_desc_cl>: class for file access
- setup_daily_field(fdesc, yyyy, mm, dd, olon, olat, ext='', **keywords)
- set up the model field from time-series files
Inputs:
----------------------------------------------------------------------------------
1. yyyy, mm,dd:<int>: year, month, day
2. olat, olon:<array, (nobs)>: obsvervation location
3. ext:<str>: extension for filname
8. keywords:<dict>: extra inputs:
- setup_daily_profile(fdesc, yyyy, mm, dd, olon, olat, ext='', **keywords)
- set up the model profiles from time-series files
Inputs:
----------------------------------------------------------------------------------
1. yyyy, mm,dd:<int>: year, month, day
2. olat, olon:<array, (nobs)>: obsvervation location
3. ext:<str>: extension for filname
8. keywords:<dict>: extra inputs:
- setup_enr_daily_field(fdesc, yyyy, mm, dd, olon, olat, enr_yst_lst, enr_dst_lst, enr_step_lst, enr_em_st_lst, enr_em_end_lst, **keywords)
- set up model field ensemble from time-series outputs of ensemble runs
Inputs:
----------------------------------------------------------------------------------
1. fdesc:<gcfdesc_cl>: file access
2. yyyy, mm,dd:<int>: year, month, day
3. olat, olon:<array, (nobs)>: obsvervation location
4. enr_yyyy_lst:<int>: year for ensemble run start.
5. enr_doy_lst:<int>: doy for ensemble run start.
6. enr_step_lst:<int>: step for ensemble run.
7. enr_em_st_st:<int>: firt one in the ensemble.
8. enr_em_end_lst:<int>: last one in the ensemble.
9. keywords:<dict>: extra inputs:
- setup_enr_daily_profile(fdesc, yyyy, mm, dd, olon, olat, enr_yst_lst, enr_dst_lst, enr_step_lst, enr_em_st_lst, enr_em_end_lst, **keywords)
- set up model profile ensemble from time-series outputs of ensemble runs
Inputs:
----------------------------------------------------------------------------------
1. fdesc:<gcfdesc_cl>: file access
2. yyyy, mm,dd:<int>: year, month, day
3. olat, olon:<array, (nobs)>: obsvervation location
4. enr_yyyy_lst:<int>: year for ensemble run start.
5. enr_doy_lst:<int>: doy for ensemble run start.
6. enr_step_lst:<int>: step for ensemble run.
7. enr_em_st_st:<int>: firt one in the ensemble.
8. enr_em_end_lst:<int>: last one in the ensemble.
9. keywords:<dict>: extra inputs:
|