= Implementation Tutorials = 

== The tutorial model ==

The tutorial implementation uses a simple 2-dimensional model domain with a single model field. 
 * [http://pdaf.awi.de/files/pdaf_tutorial_the_model.pdf PDAF Tutorial: The tutorial model: non-parallel and parallel versions] (PDF, 0.6 MB)[[BR]]

== Implementing the online mode of PDAF ==

In the online mode of PDAF one couples PDAF to a model into a single assimilation program. With version 1.16 we introduced PDAF-OMI, the [wiki:PDAF_OMI_Overview Observation Module Infrastructure]. The tutorials are adapted for OMI, while tutorials describing the implementation without OMI are provided further below. The implementation is done from the templates provided in /templates/online of the source code package. Two implementations are demonstrated: The case that the model itself is not parallelized and the case that the model is parallelized (i.e. if field is decomposed over several processes).

Step-by-step descriptions of the required implementation steps are provided by the following slide sets (the described features are supported from PDAF 1.16): [[BR]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_onlineserial.pdf PDAF Tutorial: Implementation of the assimilation system with a model that is not parallelized] (PDF, 0.9 MB)[[BR]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_onlineparallel.pdf PDAF Tutorial: Implementation of the assimilation system with a parallelized model] (PDF, 0.9 MB)[[BR]]

== Implementing the offline analysis step ==

In the offline mode of PDAF one uses separate programs for the model and the data assimilation. The implementation is done from the templates provided in /templates/offline of the source code package. The tutorial describes the implementation with PDAF-OMI that was introduced with version 1.16.

A step-by-step description of the required implementation steps is provided by the following slide set (the described features are supported from PDAF 1.16): [[BR]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_offline.pdf PDAF Tutorial: Implementation of the analysis step in offline mode] (PDF, 0.8 MB)

== Implementing 3D-Var ==

With PDAF V2.0 we added 3D variational methods to PDAF. Templates for the implementation are provided in /templates/3dvar of the course package. Tutorial codes are in /tutorial/3dvar. The tutorial explains the particularities for the implementation of the 3D-Var methods:[[BR]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_3dvar.pdf PDAF Tutorial: Implementation of the analysis step for 3D-Var] (PDF, 1.8 MB)


== Implementing without using PDAF-OMI ==

With PDAF version 1.16 we introduced PDAF-OMI (Observation Module Infrastructure). We recommend to use this new way to implement observationhandling more efficiently. However, implementing without OMI is still possible and here we provide the tutorial slides for this case:

Step-by-step descriptions of the required implementation steps are provided by the following slide sets (the described features are supported from PDAF 1.16): [[BR]]
Online mode:[[br]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_onlineserial_classical.pdf PDAF Tutorial: Implementation of the assimilation system without OMI with a model that is not parallelized] (PDF, 0.9 MB)[[BR]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_onlineparallel_classical.pdf PDAF Tutorial: Implementation of the assimilation system without OMI with a parallelized model] (PDF, 0.9 MB)[[BR]]
Offline mode:[[br]]
 * [http://pdaf.awi.de/files/pdaf_tutorial_offline_classical.pdf PDAF Tutorial: Implementation of the analysis step in offline mode without OMI] (PDF, 1.0 MB)


== Full documentation ==

For the online implementation guide and full documentation on the use of PDAF visit:[[BR]]
   * [wiki:ImplementationGuide Implementation Guide for the online assimilation system]
   * [wiki:OfflineImplementationGuide Implementation Guide for the offline assimilation program]
   * [wiki:ImplementationofAnalysisStep  Implementing the analysis step]:
    * [wiki:ImplementFilterAnalysisOverview Overview on implementing the analysis for ensemble filters]
    * [wiki:Implement3DVarAnalysisOverview Overview on implementing the analysis step for 3D-Var methods]
   * [wiki:AvailableOptionsforInitPDAF Overview of filter-specific options]
   * [wiki:PDAF_OMI_Overview Overview of PDAF-OMI]
   * [wiki:WhichFiltertouse Which filter should one use?]
   * [wiki:AddFilterAlgorithm Adding a filter algorithm to PDAF]