pyPDAF - A Python interface to Parallel Data Assimilation Framework

pyPDAF

pyPDAF is a Python interface to the Parallel Data Assimilation Framwork (PDAF) library written in Fortran. The latest pyPDAF supports PDAF-V2.1.

With a variety of packages in Python, it allows a simpler coding style for user-supplied functions, such as I/O of observations and post-processing. This is helpful for prototyping data assimilation systems, offline data assimilation systems. It can also benefit many Python-based numerical models, or models that can be interfaced with Python, with parallel and efficient data assimilation capability.

The core DA algorithm is as efficient as Fortran implementation in the interface. The efficiency of the Python-based user supplied functions can be improved if sufficient optimisations are used.

Contents:

• Installation
• Userguide
  • Naming conventions
  • Arguments conventions
• Design Details
  • pyPDAF wrapper to Fortran call
  • Treatment of arguments
    • Treatment of scalar arguments
    • Treatment of array arguments
    • Treatment of procedure arguments (user-supplied routines)
  • Note
• API reference
  • pyPDAF.PDAF
    • add_increment()
    • assimilate_3dvar()
    • assimilate_en3dvar_estkf()
    • assimilate_en3dvar_lestkf()
    • assimilate_enkf()
    • assimilate_estkf()
    • assimilate_etkf()
    • assimilate_hyb3dvar_estkf()
    • assimilate_hyb3dvar_lestkf()
    • assimilate_lenkf()
    • assimilate_lestkf()
    • assimilate_letkf()
    • assimilate_lknetf()
    • assimilate_lnetf()
    • assimilate_lseik()
    • assimilate_netf()
    • assimilate_pf()
    • assimilate_prepost()
    • assimilate_seek()
    • assimilate_seik()
    • deallocate()
    • diag_crps()
    • diag_effsample()
    • diag_ensstats()
    • diag_histogram()
    • enkf_omega()
    • eofcovar()
    • estkf_omegaa()
    • etkf_tleft()
    • force_analysis()
    • gather_dim_obs_f()
    • gather_obs_f()
    • gather_obs_f2()
    • gather_obs_f2_flex()
    • gather_obs_f_flex()
    • generate_obs()
    • get_assim_flag()
    • get_ensstats()
    • get_localfilter()
    • get_memberid()
    • get_obsmemberid()
    • get_smootherens()
    • get_state()
    • global_except_hook()
    • incremental()
    • init()
    • local_weight()
    • local_weights()
    • omi_add_obs_error_cb()
    • omi_assimilate_3dvar()
    • omi_assimilate_en3dvar_estkf()
    • omi_assimilate_en3dvar_lestkf()
    • omi_assimilate_global()
    • omi_assimilate_hyb3dvar_estkf()
    • omi_assimilate_hyb3dvar_lestkf()
    • omi_assimilate_lenkf()
    • omi_assimilate_local()
    • omi_deallocate_obs()
    • omi_g2l_obs_cb()
    • omi_gather_obs()
    • omi_gather_obsstate()
    • omi_generate_obs()
    • omi_get_interp_coeff_lin()
    • omi_get_interp_coeff_lin1d()
    • omi_get_interp_coeff_tri()
    • omi_init()
    • omi_init_dim_obs_l()
    • omi_init_obs_f_cb()
    • omi_init_obs_l_cb()
    • omi_init_obscovar_cb()
    • omi_init_obserr_f_cb()
    • omi_init_obsvar_cb()
    • omi_init_obsvar_l_cb()
    • omi_likelihood_cb()
    • omi_likelihood_hyb_l_cb()
    • omi_likelihood_l_cb()
    • omi_localize_covar()
    • omi_obs_op_adj_gridavg()
    • omi_obs_op_adj_gridpoint()
    • omi_obs_op_adj_interp_lin()
    • omi_obs_op_gridavg()
    • omi_obs_op_gridpoint()
    • omi_obs_op_interp_lin()
    • omi_prodrinva_cb()
    • omi_prodrinva_hyb_l_cb()
    • omi_prodrinva_l_cb()
    • omi_put_state_3dvar()
    • omi_put_state_en3dvar_estkf()
    • omi_put_state_en3dvar_lestkf()
    • omi_put_state_generate_obs()
    • omi_put_state_global()
    • omi_put_state_hyb3dvar_estkf()
    • omi_put_state_hyb3dvar_lestkf()
    • omi_put_state_lenkf()
    • omi_put_state_local()
    • omi_set_debug_flag()
    • omi_set_disttype()
    • omi_set_doassim()
    • omi_set_domain_limits()
    • omi_set_domainsize()
    • omi_set_icoeff_p()
    • omi_set_id_obs_p()
    • omi_set_ncoord()
    • omi_set_obs_err_type()
    • omi_set_use_global_obs()
    • prepost()
    • print_info()
    • put_state_3dvar()
    • put_state_en3dvar_estkf()
    • put_state_en3dvar_lestkf()
    • put_state_enkf()
    • put_state_estkf()
    • put_state_etkf()
    • put_state_generate_obs()
    • put_state_hyb3dvar_estkf()
    • put_state_hyb3dvar_lestkf()
    • put_state_lenkf()
    • put_state_lestkf()
    • put_state_letkf()
    • put_state_lknetf()
    • put_state_lnetf()
    • put_state_lseik()
    • put_state_netf()
    • put_state_pf()
    • put_state_prepost()
    • put_state_seek()
    • put_state_seik()
    • reset_forget()
    • sampleens()
    • seik_omega()
    • seik_ttimesa()
    • set_debug_flag()
    • set_ens_pointer()
    • set_memberid()
    • set_smootherens()
  • pyPDAF.UserFunc
    • global_except_hook()
    • py__add_obs_err_pdaf()
    • py__collect_state_pdaf()
    • py__cvt_adj_ens_pdaf()
    • py__cvt_adj_pdaf()
    • py__cvt_ens_pdaf()
    • py__cvt_pdaf()
    • py__dist_stateinc_pdaf()
    • py__distribute_state_pdaf()
    • py__g2l_obs_pdaf()
    • py__g2l_state_pdaf()
    • py__get_obs_f_pdaf()
    • py__init_dim_l_pdaf()
    • py__init_dim_obs_f_pdaf()
    • py__init_dim_obs_l_pdaf()
    • py__init_dim_obs_pdaf()
    • py__init_ens_pdaf()
    • py__init_n_domains_p_pdaf()
    • py__init_obs_covar_pdaf()
    • py__init_obs_f_pdaf()
    • py__init_obs_l_pdaf()
    • py__init_obs_pdaf()
    • py__init_obserr_f_pdaf()
    • py__init_obsvar_l_pdaf()
    • py__init_obsvar_pdaf()
    • py__l2g_state_pdaf()
    • py__likelihood_hyb_l_pdaf()
    • py__likelihood_l_pdaf()
    • py__likelihood_pdaf()
    • py__localize_covar_pdaf()
    • py__next_observation_pdaf()
    • py__obs_op_adj_pdaf()
    • py__obs_op_f_pdaf()
    • py__obs_op_lin_pdaf()
    • py__obs_op_pdaf()
    • py__prepoststep_pdaf()
    • py__prodrinva_hyb_l_pdaf()
    • py__prodrinva_l_pdaf()
    • py__prodrinva_pdaf()