HPSCTerrSys · jjokella · Oct 24, 2025 · Oct 24, 2025 · Oct 24, 2025 · Oct 27, 2025
diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -6,5 +6,6 @@ Wolfgang Kurtz
 Stefan Poll
 Mukund Pondkule
 Prabhakar Shrestha
+Anne Springer
 Lukas Strebel
 
diff --git a/Makefile b/Makefile
@@ -138,7 +138,8 @@ SRC_PDAF_GEN = 	PDAF_analysis_utils.F90 \
 		PDAFlocalomi_put_state_nondiagR.F90 \
 		PDAFlocalomi_put_state_nondiagR_si.F90 \
 		PDAFlocalomi_put_state_si.F90 \
-		PDAF_correlation_function.F90
+		PDAF_correlation_function.F90 \
+		PDAF_reset_dim_p.F90
 
 # Specific PDAF-routines for SEIK
 SRC_SEIK =	PDAF_seik_init.F90 \

diff --git a/docs/_toc.yml b/docs/_toc.yml
@@ -28,6 +28,7 @@ parts:
       - file: users_guide/running_tsmp_pdaf/input_cmd
       - file: users_guide/running_tsmp_pdaf/input_obs
       - file: users_guide/running_tsmp_pdaf/input_enkfpf
+      - file: users_guide/running_tsmp_pdaf/tsmp_pdaf_omi
 
     - file: users_guide/debugging_tsmp_pdaf/README
       title: Debugging TSMP-PDAF

diff --git a/docs/users_guide/running_tsmp_pdaf/input_cmd.md b/docs/users_guide/running_tsmp_pdaf/input_cmd.md
@@ -51,6 +51,15 @@ Details: <https://pdaf.awi.de/trac/wiki/WhichFiltertouse>
 `subtype` (integer) Parameter subtype, different options for each
 filter. See [](cmd:command-line-examples).
 
+## use_omi ##
+
+`use_omi` (logical) Controls whether to use OMI interface.
+
+- `.true.`: OMI interface is used
+- `.false.`: OMI interface is not used
+
+See [](omi:tsmp-pdaf-with-pdaf-omi).
+
 ## obs_filename ##
 
 `obs_filename` (string) Prefix for observation files.

diff --git a/docs/users_guide/running_tsmp_pdaf/tsmp_pdaf_omi.md b/docs/users_guide/running_tsmp_pdaf/tsmp_pdaf_omi.md
@@ -0,0 +1,14 @@
+(omi:tsmp-pdaf-with-pdaf-omi)=
+# TSMP-PDAF with PDAF-OMI
+
+PDAF-OMI for multivariate data assimiliaton.
+It is design to handle different observation types (currently soil moisture and TWS) automatically.
+Additional to current observation files, the observation type has to be included (SM, GRACE).
+
+See also create observation script for details: https://icg4geo.icg.kfa-juelich.de/ExternalRepos/tsmp-pdaf/tsmp-pdaf-observation-scripts/-/tree/main/omi_obs_data?ref_type=heads
+
+Both global and local filters can be used. To enable multi-scale data assimilation, different localization radii for different observation types can be passed. Note that the localization radius for SM is currently in km and for GRACE in #gridcells.
+
+The framework generates a state vector for each type individually before the assimilation, some things would need to be adapted when mutliple observation types are assimilated at the same timestep. Currently, one observation file only consists of one observation type. As SM observations are usually assimilated at noon and GRACE observations are assimilated at the end of the month at midnight, this should not provide any problems.
+
+If questions arise contact ewerdwalbesloh@geod.uni-bonn.de
diff --git a/interface/framework/Makefile b/interface/framework/Makefile
@@ -75,10 +75,17 @@ MOD_ASSIM = 	mod_parallel_pdaf.o \
 		parser_mpi.o \
 		mod_read_obs.o
 
+# Routines of observation handling (PDAF-OMI)
+MOD_USER_PDAFOMI = obs_GRACE_pdafomi.o \
+		obs_SM_pdafomi.o
+
 # Model routines used with PDAF
 OBJ_MODEL_PDAF =pdaf_terrsysmp.o\
 		integrate_pdaf.o
 
+# Routines of observation handling (PDAF-OMI)
+OBJ_USER_PDAFOMI = callback_obs_pdafomi.o
+
 # Interface to PDAF - model sided
 OBJ_PDAF_INT =  init_parallel_pdaf.o \
 		finalize_pdaf.o \
@@ -121,7 +128,7 @@ OBJ_USER_LOCAL = init_n_domains_pdaf.o \
 		localize_covar_pdaf.o
 
 # Full list of user-supplied routines for online modes
-OBJ_PDAF_USER = $(OBJ_USER_GEN) $(OBJ_USER_SEIK) $(OBJ_USER_ENKF) $(OBJ_USER_LOCAL)
+OBJ_PDAF_USER = $(OBJ_USER_GEN) $(OBJ_USER_SEIK) $(OBJ_USER_ENKF) $(OBJ_USER_LOCAL) $(OBJ_USER_PDAFOMI)
 
 ######################################################
 
@@ -143,10 +150,12 @@ info:
 
 
 $(PROG) : $(LIBMODEL) libpdaf-d.a \
-	$(MODULES) $(MOD_ASSIM) $(OBJ_MODEL_PDAF) $(OBJ_PDAF_INT) $(OBJ_PDAF_USER) 
+	$(MODULES) $(MOD_ASSIM) $(MOD_USER_PDAFOMI) \
+	$(OBJ_MODEL_PDAF) $(OBJ_PDAF_INT) $(OBJ_PDAF_USER)
 	$(PREP_C) $(LD)  $(OPT_LNK)  -o $@ \
-	$(MODULES) $(MOD_ASSIM) $(OBJ_MODEL_PDAF) $(OBJ_PDAF_INT) $(OBJ_PDAF_USER) \
-	-L$(BASEDIR)/lib -lpdaf-d $(LIBMODEL) $(LIBS) $(LINK_LIBS)
+	$(MODULES) $(MOD_ASSIM) $(MOD_USER_PDAFOMI) \
+	$(OBJ_MODEL_PDAF) $(OBJ_PDAF_INT) $(OBJ_PDAF_USER) \
+	-L$(BASEDIR)/lib $(LIBMODEL) -lpdaf-d $(LIBS) $(LINK_LIBS)
 
 ######################################################
 

diff --git a/interface/framework/assimilate_pdaf.F90 b/interface/framework/assimilate_pdaf.F90
@@ -45,7 +45,14 @@ SUBROUTINE assimilate_pdaf()
        ONLY: abort_parallel, mype_world
   USE mod_assimilation, &      ! Variables for assimilation
        ONLY: filtertype
-  ! USE PDAF_interfaces_module   ! Check consistency of PDAF calls
+  USE mod_assimilation, ONLY: use_omi
+#ifdef CLMFIVE
+  USE PDAF_interfaces_module, &   ! Check consistency of PDAF calls
+      ONLY: PDAFomi_assimilate_local, PDAFomi_assimilate_global, &
+      PDAFomi_assimilate_lenkf, PDAF_get_localfilter, &
+      PDAFomi_assimilate_enkf_nondiagR, &
+      PDAFomi_assimilate_global_nondiagR, PDAFomi_assimilate_local_nondiagR
+#endif
 
   IMPLICIT NONE
 
@@ -57,6 +64,7 @@ SUBROUTINE assimilate_pdaf()
 
 ! Local variables
   INTEGER :: status_pdaf       ! PDAF status flag
+  INTEGER :: localfilter          ! Flag for domain-localized filter (1=true)
 
 
 ! ! External subroutines
@@ -102,6 +110,19 @@ SUBROUTINE assimilate_pdaf()
 !   EXTERNAL :: likelihood_hyb_l_pdaf, & ! Compute local likelihood awith hybrid weight for an ensemble member
 !        prodRinvA_hyb_l_pdaf            ! Provide product R^-1 A for some matrix A including hybrid weight
 
+  ! Interface to PDAF-OMI for local and global filters
+  EXTERNAL :: init_dim_obs_pdafomi, & ! Get dimension of full obs. vector for PE-local domain
+    obs_op_pdafomi, &              ! Obs. operator for full obs. vector for PE-local domain
+    init_dim_obs_l_pdafomi, &      ! Get dimension of obs. vector for local analysis domain
+    localize_covar_pdafomi, &      ! Apply localization to covariance matrix in LEnKF
+    add_obs_err_pdafomi, &         ! Add obs. error covariance R to HPH in EnKF
+    init_obscovar_pdafomi, &       ! Initialize obs error covar R in EnKF
+    prodRinvA_pdafomi, &           ! Provide product R^-1 A for some matrix A
+    prodRinvA_l_pdafomi            ! Provide product R^-1 A for some local matrix A
+
+
+
+
 ! *** Switch on debug output ***
 ! *** for main process        ***
 #ifdef PDAF_DEBUG
@@ -112,6 +133,43 @@ SUBROUTINE assimilate_pdaf()
 ! *** Call assimilation routine ***
 ! *********************************
 
+  OMI: IF (use_omi) THEN
+#ifdef CLMFIVE
+    CALL PDAF_get_localfilter(localfilter)
+
+    IF (localfilter == 1) THEN
+
+      CALL PDAFomi_assimilate_local_nondiagR(collect_state_pdaf, distribute_state_pdaf, &
+       init_dim_obs_pdafomi, obs_op_pdafomi, prepoststep_ens_pdaf, init_n_domains_pdaf, &
+       init_dim_l_pdaf, init_dim_obs_l_pdafomi, prodRinvA_l_pdafomi, g2l_state_pdaf, &
+       l2g_state_pdaf, next_observation_pdaf, status_pdaf)
+
+
+    ELSE
+
+      IF (filtertype == 8) THEN
+        ! LEnKF has its own OMI interface routine
+        CALL PDAFomi_assimilate_lenkf(collect_state_pdaf, distribute_state_pdaf, &
+          init_dim_obs_pdafomi, obs_op_pdafomi, prepoststep_ens_pdaf, &
+          localize_covar_pdafomi, next_observation_pdaf, status_pdaf)
+
+      ELSEIF (filtertype == 2) then ! non diagonal R for EnKF has its own callback routine
+        CALL PDAFomi_assimilate_enkf_nondiagR(collect_state_pdaf, distribute_state_pdaf, &
+          init_dim_obs_pdafomi, obs_op_pdafomi, add_obs_err_pdafomi, init_obscovar_pdafomi, &
+          prepoststep_ens_pdaf, next_observation_pdaf, status_pdaf)
+
+      ELSE
+
+        CALL PDAFomi_assimilate_global_nondiagR(collect_state_pdaf, distribute_state_pdaf, &
+          init_dim_obs_pdafomi, obs_op_pdafomi, prodRinvA_pdafomi, &
+          prepoststep_ens_pdaf, next_observation_pdaf, status_pdaf)
+
+      ENDIF
+
+    ENDIF
+#endif
+  ELSE OMI
+
   ! IF (filtertype == 1) THEN
   !    CALL PDAF_assimilate_seik(collect_state_pdaf, distribute_state_pdaf, &
   !         init_dim_obs_pdaf, obs_op_pdaf, init_obs_pdaf, prepoststep_ens_pdaf, &
@@ -182,6 +240,8 @@ SUBROUTINE assimilate_pdaf()
   !         likelihood_pdaf, next_observation_pdaf, status_pdaf)
   END IF
 
+  END IF OMI
+
   ! Check for errors during execution of PDAF
 
   IF (status_pdaf /= 0) THEN