Merge pull request #984 from NCAR/nan_check_attributes

bug-fix: adds check to ensure attribute values that are NaNs are consistent across restarts

Author: hkershaw-brown

.gitignore

@@ -171,6 +171,7 @@ convert_amsu_L1
 convert_L2b
 convert_goes_ABI_L1b
 MOD29E1D_to_obs
+hf_to_obs
 
 # Test programs built by developer_tests
 rttov_test

CHANGELOG.rst

@@ -22,6 +22,18 @@ individual files.
 
 The changes are now listed with the most recent at the top.
 
+**November 13 2025 :: HF Radar converter. Tag 11.19.0**
+
+New features:
+
+- High Frequency (HF) Radar ocean observation converter
+- ROMS–Rutgers: Option to use Sea Surface Height from the template file, 
+  assuming the ensemble mean is provided in that file.
+
+Bug-fix:
+
+- Corrected consistency check across restarts when fill or missing attributes are NaN. 
+
 **November 11 2025 :: Aether Cube Sphere. Tag v11.18.0**
 
 - Aether cube sphere interface added to DART.

assimilation_code/modules/io/io_filenames_mod.f90

@@ -718,7 +718,12 @@ subroutine check_attribute_value_r4(ncFile, filename, ncVarID, att_string, spval
 real(r4) :: ret_spvalR4
 
 if ( nf90_get_att(ncFile, ncVarID, att_string, ret_spvalR4) == NF90_NOERR ) then
-   if (ret_spvalR4 /= ret_spvalR4) then 
+   if (ret_spvalR4 /= ret_spvalR4) then ! ret_spval is NaN
+      if (.not. (spvalR4 /= spvalR4)) then ! spval is not NaN, so they are not the same
+         write(msgstring,*) ' variable attribute, ', trim(att_string), ' in state', spvalR4, &
+                            ' does not match ', trim(att_string), ' ', ret_spvalR4, ' in ', trim(filename)
+         call error_handler(E_ERR, 'check_attribute_value_r4', msgstring, source)
+      end if
       return
    endif
    if (spvalR4 /= ret_spvalR4) then
@@ -746,7 +751,12 @@ subroutine check_attribute_value_r8(ncFile, filename, ncVarID, att_string, spval
 real(r8) :: ret_spvalR8
 
 if ( nf90_get_att(ncFile, ncVarID, att_string, ret_spvalR8) == NF90_NOERR ) then
-   if (ret_spvalR8 /= ret_spvalR8) then
+   if (ret_spvalR8 /= ret_spvalR8) then ! ret_spval is NaN
+      if (.not. (spvalR8 /= spvalR8)) then ! spval is not NaN, so they are not the same
+         write(msgstring,*) ' variable attribute, ', trim(att_string), ' in state', spvalR8, &
+                            ' does not match ', trim(att_string), ' ', ret_spvalR8, ' in ', trim(filename)
+         call error_handler(E_ERR, 'check_attribute_value_r8', msgstring, source)
+      end if
       return
    endif
    if (spvalR8 /= ret_spvalR8) then

conf.py

@@ -21,7 +21,7 @@
 author = 'Data Assimilation Research Section'
 
 # The full version, including alpha/beta/rc tags
-release = '11.18.0'
+release = '11.19.0'
 root_doc = 'index'
 
 # -- General configuration ---------------------------------------------------

guide/available-observation-converters.rst

@@ -25,6 +25,7 @@ Each directory has at least one converter:
 -  ``GRACE``: See ``DART/observations/obs_converters/GRACE``
 -  ``GSI2DART``: :doc:`../observations/obs_converters/GSI2DART/readme`
 -  ``GTSPP``: :doc:`../observations/obs_converters/GTSPP/GTSPP`
+-  ``HFradar``: :doc:`../observations/obs_converters/HFradar/readme`
 -  ``MADIS``: :doc:`../observations/obs_converters/MADIS/MADIS`
 -  ``MIDAS``: :doc:`../observations/obs_converters/MIDAS/MIDAS_to_obs`
 -  ``MODIS``: :doc:`../observations/obs_converters/MODIS/MOD15A2_to_obs`

observations/obs_converters/HFradar/hf_to_obs.f90

@@ -67,9 +67,9 @@ program hf_to_obs
 integer  :: num_copies = 1,   &   ! number of copies in sequence
             num_qc     = 1        ! number of QC entries
 
-character(len=30), dimension(3) :: obs_names = ['Eastward Sea Water Velocity' , &
+character(len=30), dimension(3) :: obs_names = ['Eastward Sea Water Velocity ' , &
                                                 'Northward Sea Water Velocity', & 
-                                                'Radial Sea Water Velocity'   ]
+                                                'Radial Sea Water Velocity   '   ]
 
 character(len=256)      :: next_infile, instrument
 character(len=512)      :: string1, string2, string3

observations/obs_converters/README.rst

@@ -377,7 +377,7 @@ converters) include:
 -  ``GRACE``: See ``./GRACE``
 -  ``GSI2DART``: :doc:`./GSI2DART/readme`
 -  ``GTSPP``: :doc:`./GTSPP/GTSPP`
--  ``HFradr``: :doc:`./HFradr/readme`
+-  ``HFradar``: :doc:`./HFradar/readme`
 -  ``MADIS``: :doc:`./MADIS/MADIS`
 -  ``MIDAS``: :doc:`./MIDAS/MIDAS_to_obs`
 -  ``MODIS``: :doc:`./MODIS/MOD15A2_to_obs`