COSP-RTTOV integration with CAM

.gitmodules

@@ -92,12 +92,12 @@
 	fxDONOTUSEurl = https://github.com/MPAS-Dev/MPAS-Model.git
 
 [submodule "cosp2"]
-	path = src/physics/cosp2/src
-	url = https://github.com/CFMIP/COSPv2.0
+        path = src/physics/cosp2/src
+        url = https://github.com/CFMIP/COSPv2.0
         fxrequired = AlwaysRequired
         fxsparse = ../.cosp_sparse_checkout
-        fxtag = v2.1.9
-	fxDONOTUSEurl = https://github.com/CFMIP/COSPv2.0
+        fxtag = v2.2.0
+        fxDONOTUSEurl = https://github.com/CFMIP/COSPv2.0
 
 [submodule "clubb"]
 	path = src/physics/clubb

bld/config_files/definition.xml

@@ -282,6 +282,14 @@ Switch to enable building COSP simulator package.  1 => build COSP.
 <entry id="cosp_libdir" value="">
 Directory containing COSP library.
 </entry>
+<entry id="rttov" valid_values="0,1" value="0">
+Switch to enable building the RTTOV radiative transfer model. With COSP.
+1 => link COSP with RTTOV with building.
+</entry>
+<entry id="rttov_libdir" value="">
+Directory containing RTTOV libraries. For example:
+/glade/u/home/jonahshaw/w/RTTOV2/hdfseries_build/lib/
+</entry>
 <entry id="fv3core_libdir" value="">
 Directory containing FV3CORE library.
 </entry>

bld/configure

@@ -75,6 +75,8 @@ OPTIONS
      -co2_cycle         This option modifies the CAM configuration by
                         increasing the number of advected constituents by 4.
      -cosp              Enable the COSP simulator.
+     -rttov             Enable RTTOV within the COSP simulator.
+     -rttov_libdir <str>A string containing a path to the RTTOV install.
      -cppdefs <string>  A string of user specified CPP defines.  Appended to
                         Makefile defaults.  E.g. -cppdefs '-DVAR1 -DVAR2'
      -cpl               Coupling framework [mct | nuopc].  Default: mct.
@@ -244,6 +246,8 @@ GetOptions(
     "co2_cycle"                 => \$opts{'co2_cycle'},
     "cosp"                      => \$opts{'cosp'},
     "cosp_libdir=s"             => \$opts{'cosp_libdir'},
+    "rttov"                     => \$opts{'rttov'},
+    "rttov_libdir=s"            => \$opts{'rttov_libdir'},
     "cppdefs=s"                 => \$opts{'cppdefs'},
     "cpl=s"                     => \$opts{'cpl'},
     "debug"                     => \$opts{'debug'},
@@ -1007,6 +1011,22 @@ if (defined $opts{'cosp'}) {
 }
 my $cosp = $cfg_ref->get('cosp');
 
+# Option to build COSP with RTTOV
+if ($cosp and defined $opts{'rttov'} and defined $opts{'rttov_libdir'}) {
+   $cfg_ref->set('rttov', $opts{'rttov'});
+   $cfg_ref->set('rttov_libdir', $opts{'rttov_libdir'});
+   print "COSP-RTTOV enabled$eol";
+}
+elsif ( $cosp and defined $opts{'rttov'}) {
+   $cfg_ref->set('rttov', $opts{'rttov'});
+}
+elsif ( defined $opts{'rttov'} ) {
+   die "configure ERROR: rttov defined but cosp undefined. cosp_libdir also undefined \n";
+}
+
+my $rttov = $cfg_ref->get('rttov');
+my $rttov_libdir = $cfg_ref->get('rttov_libdir');
+
 # cosp is only implemented with the cam5, cam6, and cam7 physics packages
 if ($cosp and ($phys_pkg ne 'cam5' and $phys_pkg ne 'cam6' and $phys_pkg ne 'cam7')) {
         die "configure ERROR: cosp not implemented for the $phys_pkg physics package \n";
@@ -1849,6 +1869,15 @@ if ($cosp) {
         die "** Could not create the cosp build directory: $bld_dir\n";
     }
 
+    # Turn on RTTOV if passed the keyword. The cosp-rttov Makefile copies rttov libraries to the $cosp_libdir path
+    if ($rttov) {
+      # Current version when copying the RTTOV libraries for each build (both HDF5 and openmp are successfully linked now):
+      $ldflags .= " -L$cosp_libdir -lrttov13_wrapper -lrttov13_mw_scatt -lrttov13_brdf_atlas -lrttov13_emis_atlas -lrttov13_other -lrttov13_parallel -lrttov13_coef_io -lrttov13_hdf -lrttov13_main ";
+      # Let the RTTOV libraries stay where they are:
+      # A more functional code would read these from Makefile.rttov in the COSP2 directory in CAM instead of hardcoding, but I don't know how to do that yet.
+      $cfg_ref->set('ldflags', $ldflags);
+      print "Adding rttov libraries as dependencies in ldflags.\n";
+    }       
     # Create the COSP Makefile from a template and copy it into the cosp bld directory
     if ($print) { print "creating $cosp_libdir/Makefile\n"; }
     write_cosp_makefile("$cfgdir/../src/physics/cosp2/Makefile.in", "$cosp_libdir/Makefile");

bld/namelist_files/namelist_definition.xml

@@ -2454,6 +2454,15 @@ will be saved.
 Default: FALSE
 </entry>
 
+<entry id="cosp_lrttov_sim" type="logical"  category="cosp"
+       group="cospsimulator_nl" valid_values="">
+If true, RTTOV simulator will be run and output
+will be saved according to the appropriate RTTOV
+instrument namelist files in "rttov_instrument_namelists".
+
+Default: FALSE
+</entry>
+
 <!-- COSP input control parameters -->
 
 <entry id="cosp_ncolumns" type="integer"  category="cosp"
@@ -2463,6 +2472,169 @@ This default logical is set in cospsimulator_intr.F90
 Default: 50
 </entry>
 
+<entry id="cosp_rttov_Ninstruments" type="integer"  category="cosp"
+       group="cospsimulator_nl" valid_values="">
+Number of RTTOV instruments to simulate.
+This default logical is set in cospsimulator_intr.F90
+Default: 0
+</entry>
+
+<entry id="cosp_rttov_instrument_namelists" type="char*256(50)"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+List of RTTOV instrument namelist files to read when running RTTOV in COSP.
+File paths are read relative to the case run directory 
+(e.g. /glade/derecho/scratch/$USER/$CASENAME/run/). Each namelist file
+contains information specifying the simulated instrument, channels, and
+outputs. Templates and instructions can be found in the COSP-RTTOV 
+code repository.
+Default: none
+</entry>
+
+<!-- Swathing input control parameters. -->
+<entry id="cosp_N_SWATHS_ISCCP" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP ISCCP data.
+Default: none
+</entry>
+
+<entry id="cosp_N_SWATHS_MISR" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP MISR data.
+Default: none
+</entry>
+
+<entry id="cosp_N_SWATHS_MODIS" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP MODIS data.
+Default: none
+</entry>
+
+<entry id="cosp_N_SWATHS_CSCAL" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP CloudSat-CALIPSO data.
+Default: none
+</entry>
+
+<entry id="cosp_N_SWATHS_PARASOL" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP PARASOL data.
+Default: none
+</entry>
+
+<entry id="cosp_N_SWATHS_ATLID" type="integer*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Number of satellite sampling swaths used to mask COSP ATLID data.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_ISCCP" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP ISCCP data. The sampling 
+"local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_MISR" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP MISR data. The sampling 
+"local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_MODIS" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP MODIS data. The sampling 
+"local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_CSCAL" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP CloudSat-CALIPSO data. The  
+sampling "local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_PARASOL" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP PARASOL data. The sampling 
+"local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_LOCALTIMES_ATLID" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath localtimes (hours) for masking COSP ATLID data. The sampling 
+"local time" refers to a linear shift from UTC as a function of a 
+gridcell’s longitude (t_local = t_UTC − longitude * 24/360).
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_ISCCP" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP ISCCP data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_MISR" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP MISR data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_MODIS" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP MODIS data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_CSCAL" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP CSCAL data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_PARASOL" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP PARASOL data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
+<entry id="cosp_SWATH_WIDTHS_ATLID" type="real*10"  category="cosp"
+       group="cospsimulator_nl" valid_values="" >
+Swath widths (kilometers) for masking COSP ATLID data. The "swath width"
+determines the spatial region around each local time that is simulated. 
+Supplying a swath width in units of distance rather than radians produces
+a larger sampling density at higher latitudes that is consistent with
+observations.
+Default: none
+</entry>
+
 <!-- COSP output parameters -->
 
 <entry id="cosp_histfile_num" type="integer"  category="cosp"

cime_config/buildlib

@@ -71,7 +71,7 @@ def _build_fms(caseroot, libroot, bldroot):
 
 ###############################################################################
 def _build_cam(caseroot, libroot, bldroot):
-    ###############################################################################
+###############################################################################
 
     with Case(caseroot, read_only=False) as case:
 
@@ -91,15 +91,40 @@ def _build_cam(caseroot, libroot, bldroot):
         except:
             raise RuntimeError("CAM's 'buildcpp' script failed to run properly.")
 
+        #--------------------------------------------------------
+        # Check if RTTOV is being requested by the user,
+        # and if so, set a needed environment variable
+        # and update the CAM_LINKED_LIBS list:
+        #--------------------------------------------------------
+
+        env_vars = ''
+        config_opts  = case.get_value("CAM_CONFIG_OPTS")
+
+        if "-rttov" in config_opts:
+            # Set environment variable needed by COSP Makefile
+            env_vars = "env RTTOV=true "
+
+            hdf5_lib_path = os.environ.get("NCAR_LDFLAGS_HDF5")
+
+            # Add HDF5 library to CAM linked library list:
+            linked_libs = case.get_value("CAM_LINKED_LIBS",
+                                        subgroup="build_component_cam")
+            hdf5_link_opts = f"-L{hdf5_lib_path}"
+            hdf5_link_opts += " -lhdf5_fortran -lhdf5_hl_fortran -lhdf5"
+            case.set_value("CAM_LINKED_LIBS",
+                           linked_libs + hdf5_link_opts)
+
+
     with Case(caseroot) as case:
 
-        casetools = case.get_value("CASETOOLS")
-        srcroot = case.get_value("SRCROOT")
-        gmake_j = case.get_value("GMAKE_J")
-        gmake = case.get_value("GMAKE")
-        mach = case.get_value("MACH")
+        casetools    = case.get_value("CASETOOLS")
+        srcroot      = case.get_value("SRCROOT")
+        gmake_j      = case.get_value("GMAKE_J")
+        gmake        = case.get_value("GMAKE")
+        mach         = case.get_value("MACH")
+        config_opts  = case.get_value("CAM_CONFIG_OPTS")
         user_incldir = None
-        cam_dycore = case.get_value("CAM_DYCORE")
+        cam_dycore   = case.get_value("CAM_DYCORE")
         if cam_dycore == "fv3":
             slr = os.path.abspath(case.get_value("SHAREDLIBROOT"))
             compiler = case.get_value("COMPILER")
@@ -138,14 +163,32 @@ def _build_cam(caseroot, libroot, bldroot):
             expect(os.path.isfile(libfms), "FMS library not found {}".format(libfms))
             shutil.copy(libfms, libroot)
 
+        #--------------------------------------------------------
+        # Check if RTTOV is being requested by the user,
+        # and if so, set a needed environment variable
+        # and update the CAM_LINKED_LIBS list:
+        #--------------------------------------------------------
+
+        #env_vars = ''
+        #if "-rttov" in config_opts:
+            # Set environment variable needed by COSP Makefile
+        #    env_vars = "env RTTOV=true "
+
+            # Add HDF5 library to CAM linked library list:
+        #    hdf5_link_opts = "-L$(NCAR_LDFLAGS_HDF5)"
+        #    hdf5_link_opts += " -lhdf5_fortran -lhdf5_hl_fortran -lhdf5"
+        #    case.set_value("CAM_LINKED_LIBS",
+        #                   case.get_value("CAM_LINKED_LIBS") + hdf5_link_opts)
+
         # -------------------------------------------------------
         # build the library
         # -------------------------------------------------------
         complib = os.path.join(libroot, "libatm.a")
         makefile = os.path.join(casetools, "Makefile")
 
-        cmd = "{} complib -j {} COMP_NAME=cam COMPLIB={} -f {} {} ".format(
-            gmake, gmake_j, complib, makefile, get_standard_makefile_args(case)
+        cmd = "{}{} complib -j {} COMP_NAME=cam COMPLIB={} -f {} {} ".format(
+            env_vars, gmake, gmake_j, complib, makefile,
+            get_standard_makefile_args(case)
         )
         if cam_cppdefs:
             cmd += " USER_CPPDEFS='{}'".format(cam_cppdefs)

cime_config/config_component.xml

@@ -390,6 +390,22 @@
     <desc>User mods to apply to specific compset matches. </desc>
   </entry>
 
+  <entry id="CAM_LINKED_LIBS">
+    <type>char</type>
+    <valid_values></valid_values>
+    <default_value> </default_value>
+    <values match="last" modifier="additive">
+      <value> </value>
+    </values>
+    <group>build_component_cam</group>
+    <file>env_build.xml</file>
+    <desc>
+      CAM-SIMA linked libraries. The libraries are built by
+      CAM-SIMA's buildlib script and should be included
+      during linking of the model executable.
+    </desc>
+  </entry>
+
   <help>
     =========================================
     CAM naming conventions