ESA.enkf.construct_state_vector
index
/home/lfeng/otool/ESA/enkf/construct_state_vector.py

this code is used to construct state vector 
Authors: L. Feng, Edinburgh University
History: v0.9, 2012.06.28
History: v0.95, 2013.02.15
 
Functions:
 
=================================================
1. construct_step_tag: Construct tag to identify ensemble run steps
2. add_step_prior: Adding apriori for one step into the state vector
3. hm_subtract_m1: subtracting reference values for response function

 
Modules
       
ESA.util.message_m
numpy
ESA.util.otool_descfile_io
ESA.util.otool_obj
ESA.util.otool_var_io
ESA.enkf.run_desc_m
ESA.enkf.run_desc_file_m
ESA.enkf.state_vector
ESA.util.time_module
ESA.enkf.x2flux_m

 
Functions
       
add_step_prior(yyyy, mm, dd, cl_run_desc, cl_stv, cl_x2flux=None, tag_fmt='XYYYYX.STXSTEPX', ftag=<function construct_step_tag>, fscale_m=None, **keywords)
Adding apriori for one step into the state vector
 
Inputs:
-------------------------------------------------
 
1. yyyy, mm, dd:<int>: date
2. cl_run_desc:<run_desc_cl>: class for ensemble run description 
3. cl_stv: <state_vector>: class for state vector 
4. cl_x2flux:<x2flux_cl>:  class for project x to fluxes 
5. tag_fmt:<str>:  format for tag used to identify format 
6. ftag   :<func>: function for generating tag 
7. fscale_m:<func>: for generating correlation 
8. keywords:<dict>: extra inputs
 
 
Returns:
--------------------------------------------------
1. iadd_x:<int>: number of state vector added
construct_step_tag(yyyy, mm, dd, step, fmt, **keywords)
Construct tag to identify ensemble run steps 
 
Inputs:
---------------------------------------------------
1. yyyy, mm, dd:<int>: date
2. step: <int>: ensemble run step 
3. fmt:<str>: format of the tag 
4. keywords:<dict>: extra inputs
 
 
Returns:
--------------------------------------------
1. tag:<str>: tag used to identify step
hm_subtract_m1(enr_yst_lst, enr_dst_lst, enr_step_lst, enr_em_st_lst, enr_em_end_lst, hm)