Changes between Version 36 and Version 37 of ImplementationofAnalysisStep

Timestamp:

May 24, 2025, 3:22:42 PM (6 months ago)

Author:

lnerger

Comment:

--

ImplementationofAnalysisStep

@@ -1 +1 @@
 = Implementing the analysis step =
+
+[[PageOutline(2-3,Contents of this page)]]
 
 {{{
@@ -49 +51 @@
 }}}
 
-The implementation of the analysis step requires that the user-supplied routines whose names are given in the call to the filter-specific put-state routine are implemented with full functionality. 
+The implementation of the analysis step requires that the user-supplied routines that are arguments in the call to the routine for the analysis step are implemented with full functionality. 
 
-With PDAF-OMI many of the routines are general and hence usable for all filter algorithms. There are some differences between the local and global filters and the LEnKF.  The general routines will be repeated, but they are marked as general.
+While different routines are used for the online and offline modes of PDAF, the implementation of the analysis is generally generic. As such we combine this here for both the online and offline modes.
 
 
+== Ensemble filter methods ==
 
-There is a universal routine that calls the filter analysis step for all filter methods.
- * [ImplementFilterAnalysisOverview General overview] of routines required to implement the analysis step for ensemble filters.
- 1. [ImplementAnalysisUniversal Implementation of the analysis]
+To get an overview of the required routines for the analysis step see:
+ * [ImplementFilterAnalysisOverview General overview of routines required to implement the analysis step for ensemble filters].
+
+
+There are universal routines that call the filter analysis step for all ensemble filter methods.
+ * [ImplementAnalysisUniversal Implementation of the analysis using the universal routines.]
+
+For more specific cases, there are further routines
+ * [wiki:ImplementAnalysisUniversalLocal Implementation with user-provided routines for transfer between global and local state vectors (g2l_state_pdaf/l2g_state_pdaf) in local filters]
+ * [wiki:ImplementanalysisGlobalPDAF3 Implemenation exclusively for global filters and LEnKF] 
 
 
@@ -64 +74 @@
  1. [ImplementAnalysislenkfOmi Implementation of the analysis for the LEnKF using covariance localization]
 
-For the application of the 3D-Var methods there are separate routines (added with PDAF 2.0):
- * [wiki:Implement3DVarAnalysisOverview General overview] of routines required to implement the analysis step for 3D-Var.
+
+== 3D-Var methods ==
+
+To get an overview of the required routines for the analysis step of 3D-Var methods see:
+ * [wiki:Implement3DVarAnalysisOverview General overview of routines required to implement the analysis step for 3D-Var].
+
+For the application of the 3D-Var methods there are universal routines for all methods:
+ * [wiki:Implement3DVarAnalysisUniversal Implementation of the analysis using the universal routines.]
+
+For more specific cases, there are further routines
+
  1. [wiki:ImplementAnalysis_3DVar Implementation of the analysis for 3D-Var with parameterized background covariance matrix]
  1. [wiki:ImplementAnalysis_3DEnVar Implementation of the analysis for 3D Ensemble Var ]
@@ -71 +90 @@
 
 
-== Implementation of the analysis step without OMI ==
+== Implementation Variants before PDAF3 ==
 
-PDAF-OMI was introduced with version 1.16 of PDAF. While we recommend using OMI, the [wiki:OfflineImplementationofAnalysisStep_noOMI implementation of the analysis step without OMI] is still possible.
+=== Implementation of the analysis step using PDAF-OMI without PDAFlocal ===
 
+Before releasing PDAF V3.0 with its now PDAF3-interface routines for the analysis step, using the PDAF Observation Module Interface (PDAF-OMI) was recommended. PDAFlocal was introduced with PDAF V2.3 in September 2024 as an add-on to PDAF-OMI. With PDAFlocal we simplified the localization of the state vector. Implementations done before the release of PDAF V2.3 likely use PDAF-OMI without PDAFlocal.
+
+|| For reference we provide the documentation on the  **[wiki:ImplementAnalysisLocal_untilPDAF221 implementation of the analysis step with PDAF-OMI not using PDAFlocal].** ||
+
+=== Implementation of the analysis step using PDAF's full interface ===
+
+The full interface omits the use of PDAF-OMI for the observation handling, and PDAFlocal for the simplified handling of localization. Using the full interface is an 'expert mode' because it requires to implement a larger number of call-back routines. Nonetheless, assimilation systems implemented before the introduction of PDAF-OMI with Version 1.16 in November 2020 might still use this approach.
+
+|| For reference we provide the documentation on the  **[wiki:OfflineImplementationofAnalysisStep_noOMI implementation of the analysis step without OMI]**, which is still possible. ||
 
 == Testing the full implementation ==