Changes between Version 54 and Version 55 of ReleaseNotes

Timestamp:

Sep 1, 2025, 8:53:40 AM (25 hours ago)

Author:

lnerger

Comment:

--

ReleaseNotes

@@ -1 +1 @@
 = Release notes for PDAF =
 
-
-== Version 3.0beta - May 30, 2025 ==
+== Version 3.0 - September 1, 2025 ==
+
+This is a major release and completes Version 3.0 based on the pre-release 3.0beta. This includes all changes of V3.0beta, which are listed further below.
+
+The completed release of PDAF V3.0 contains bug-fixes and also some additional features
+
+**Major additions**
+- Separating the initialization of parallelization variables from the initialization of PDAF variables. This allows to simplify the code structure and keep the parallelization variables inside init_parallel_pdaf. There are new routines 'PDAF3_init' and 'PDAF3_set_parallel'. Their use is optional (see https://pdaf.awi.de/trac/wiki/PDAF3_interface):
+ - 'PDAF3_set_parallel' is called in init_parallel_pdaf to provide the parallelization variables to PDAF.
+ - 'PDAF3_init' has a shortened interface compared to 'PDAF_init' as it does not include the variables concerning parallelization. 
+- When using exclusively a single MPI-process with the offline mode, it is now possible to use PDAF without calling 'init_parallel_pdaf' or 'PDAF3_set_parallel'. For localized filters one can use the OpenMP parallelization, while the user code does not need any operations of MPI.
+- Add EnOI-mode, in which only the state estimate is integrated, but the ensemble perturbations are fixed, to EnSRF and EAKF (filtertype=13 with subtype=10 for EnSRF; subtype=11 for EAKF)
+- Add support for IAU with the EnOI modes (ensemble optimal interpolation in which only the state estimate, but not the ensemble state are integrated; subtypes 10 and 11 available for some filters).
+- Linked to the above there are the new routines 'PDAF_iau_set_state_pointer' for use in EnOI mode and 'PDAF_iau_set_ens_pointer' (alias for 'PDAF_iau_set_pointer) for use in the regular mode integrating the ensemble.
+- Add external observation operator routine 'PDAFomi_obs_op_extern'. This observation operator allows to directly provide an observed model state from the ensemble. It can be used, e.g. if the model itself performs the proejection of the observation operator.
+
+**Corrections**
+- Revised the setting of 'dim_lag': In V3.0beta 'dim_lag' had to be set in the call to PDAF_init. Now using PDAF_set_iparam works correctly.
+- Corrected PDAF_diag_reliability_budget
+- Correction of template code for the analysis step to use subtype 10 and 11 for the EnOI mode
+- Corrected SEIK subtype=11 (fixed covariance matrix). It performed identical to subtype=10 (non-dynamic ensemble updated at analysis step). 
+- Corrected subtype=11 of ESTKF/LESTKF/ETKF/LESTKF, which procuded an incorrect analysis ensemble in V3.0beta due to the revision for IAU
+- Corrected EnKF and LEnKF: The filters stopped when one of the process sub-domain did not hold any observations 
+
+
+PDAF V3.0 includes the large set of changes from the pre-release PDAF V3.0beta as described below.
+
+----
+
+== Previous versions ==
+
+=== Version 3.0beta - May 30, 2025 ===
 
 This is a major release. The whole PDAF code was revised and modernized. Further, a new universal calling interface for the analysis step  and other new functionality was added.
 
-Important: 
+**Important:**
 1. We have marked this release as a beta-release mainly because of the large changes in the code. While we have tested this release carefully with different applications, we cannot exclude that there are issues that we didn't find. We like to motivate all users to test PDAF V3.0 and to let us know possible issues (using the Issues-function in Github or by email to pdaf\@awi.de). This will help us to fix such issues so that the final release for PDAF V3.0 can be done in 2-3 months. During this time, we will also finalize the documentation to reflect all changes.
 
@@ -15 +45 @@
 * New features: https://pdaf.awi.de/trac/wiki/PDAF3_new_functionality
 
-Major changes with effect on backward-compatibility
+**Major changes with effect on backward-compatibility**
 * New general module 'PDAF' replacing the optional module 'PDAF_interfaces_module'. In Fortran code, it is now required to include this module with 'USE PDAF'. 
 * Change for offline mode: It is no longer possible to specify the offline mode as 'subtype=5'. We have introduced a new interface 'PDAF_assim_offline' for the offline mode, which simplified the implementation. 
@@ -25 +55 @@
 * For information on how to adapt a program for PDAF V3.0, see https://pdaf.awi.de/trac/wiki/PortingToPDAF3
 
-Major changes and additions (see also https://pdaf.awi.de/trac/wiki/PDAF3_new_functionality):
+**Major changes and additions** (see also https://pdaf.awi.de/trac/wiki/PDAF3_new_functionality):
 * Incremental Analysis Updates (IAU): The previous IAU of PDAF was recoded. Now there is a fully featured IAU implementation.
 * Added ENSRF/EAKF: The ensemble square-root filter (ENSRF, Whitaker & Hamill, 2002) and ensemble adjustment filter with local linear regression (EAKF, Anderson, 2003) were added. These filters perform the analysis step through serial processing of individual observations.
@@ -48 +78 @@
 
 
-Other changes:
+**Other changes:**
 * The tutorial input files have been regenerated using Python scripts instead of the previous Matlab scripts. This changed their values.
 * Changed statistics for locally omitted observations: Now, these are only counted for analysis domains with observations.
@@ -56 +86 @@
 * Revision of PDAF file headers: It is now possible to use 'Doxygen' to generate a documentation and structure overview of PDAF.
 
-Bug corrections:
+**Bug corrections:**
 * Corrected a parallel race condition in the LKNETF NHK variant (subtype=0) in case of OpenMP parallelization
 * Corrected convergence check for the CG+ solver in the 3D-Var methods in case of parallelized control vector.
@@ -64 +94 @@
 
 
-----
-
-== Previous versions ==
 
 == Version 2.3.1 - November 25, 2024 ==