COSP-RTTOV integration with CAM #1327

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

jshaw35 wants to merge 53 commits into ESCOMP:cam_development from jshaw35:cam6_3_144_cosprttov

.gitmodules

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -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.1

            fxDONOTUSEurl = https://github.com/CFMIP/COSPv2.0

    [submodule "clubb"]

    	path = src/physics/clubb

bld/config_files/definition.xml

-Original file line number
+Diff line change
@@ Expand Up @@
     <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.
+=> link COSP with RTTOV when building.
+    </entry>
     <entry id="fv3core_libdir" value="">
     Directory containing FV3CORE library.
     </entry>
@@ Expand Down @@

bld/configure

-Original file line number
+Diff line change
@@ Expand Up / @@ -76,6 +76,7 @@ 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.
          -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.
@@ Expand Down Expand Up / @@ -245,6 +246,7 @@ GetOptions( @@
         "co2_cycle"                 => \$opts{'co2_cycle'},
         "cosp"                      => \$opts{'cosp'},
         "cosp_libdir=s"             => \$opts{'cosp_libdir'},
+        "rttov"                     => \$opts{'rttov'},
         "cppdefs=s"                 => \$opts{'cppdefs'},
         "cpl=s"                     => \$opts{'cpl'},
         "debug"                     => \$opts{'debug'},
@@ Expand Down Expand Up / @@ -1008,6 +1010,17 @@ if (defined $opts{'cosp'}) { @@
     }
     my $cosp = $cfg_ref->get('cosp');
+    # Option to build COSP with RTTOV
+    if ( $cosp and defined $opts{'rttov'}) {
+       $cfg_ref->set('rttov', $opts{'rttov'});
+       print "COSP-RTTOV enabled$eol";
+    }
+    elsif ( defined $opts{'rttov'} ) {
+       die "configure ERROR: rttov defined but cosp undefined. \n";
+    }
+    my $rttov = $cfg_ref->get('rttov');
     # 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";
@@ Expand Down Expand Up / @@ -1850,6 +1863,15 @@ if ($cosp) { @@
             die "** Could not create the cosp build directory: $bld_dir\n";
         }
+        # Turn on RTTOV.
+        # NOTE: Specialized linking with RTTOV is handled here and in buildlib. A single, unified linking
+        if ($rttov) {
+          # Add the rttov library dependencies to the ldflags. The cosp-rttov Makefile links these libraries to the $cosp_libdir path.
+          # A more functional code would read these ldflags from Makefile.rttov in the COSP2 directory in CAM instead of hardcoding.
+          $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 ";
+          $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");
@@ Expand Down @@

bld/namelist_files/namelist_definition.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -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"
@@ Expand All / @@ -2463,6 +2472,168 @@ 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/) if an absolute path is not provided (recommended). Each namelist file
+    contains information specifying the simulated instrument, channels, and
+    outputs. Templates and instructions can be found in src/physics/cosp2/COSP-RTTOV_examples/.
+    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"
@@ Expand Down @@

cime_config/buildlib

-Original file line number
+Diff line change
@@ Expand Up / @@ -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")
@@ Expand Down Expand Up / @@ -138,14 +163,14 @@ def _build_cam(caseroot, libroot, bldroot): @@
                 expect(os.path.isfile(libfms), "FMS library not found {}".format(libfms))
                 shutil.copy(libfms, libroot)
-            # -------------------------------------------------------
             # 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)
@@ Expand Down @@

cime_config/config_component.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -414,6 +414,7 @@ @@
         <desc>User mods to apply to specific compset matches. </desc>
       </entry>
       <help>
         =========================================
         CAM naming conventions
@@ Expand Down @@

cime_config/testdefs/testlist_cam.xml

-Original file line number
+Diff line change
@@ Expand Up / @@ -1138,6 +1138,15 @@ @@
         </options>
       </test>
+      <test compset="QPC7" grid="ne3_ne3_mg37" name="ERC_D_Ln9" testmods="cam/outfrq9s_rttov">
+        <machines>
+          <machine name="derecho" compiler="intel" category="aux_cam"/>
+        </machines>
+        <options>
+          <option name="comment" >CAM7 aquaplanet w/ RTTOV</option>
+          <option name="wallclock">00:20:00</option>
+        </options>
+      </test>
       <test compset="QPC6" grid="f19_f19_mt232" name="ERC_D_Ln9" testmods="cam/outfrq3s_cosp">
         <machines>
           <machine name="derecho" compiler="intel" category="aux_cam"/>
@@ Expand Down @@

cime_config/testdefs/testmods_dirs/cam/outfrq9s_rttov/shell_commands

-Original file line number
+Diff line change
@@ -0,0 +1,4 @@
+    ./xmlchange --append CAM_CONFIG_OPTS="-cosp -rttov"
+    ./xmlchange ROF_NCPL=\$ATM_NCPL
+    ./xmlchange GLC_NCPL=\$ATM_NCPL
+    ./xmlchange FORCE_BUILD_SMP="TRUE"

cime_config/testdefs/testmods_dirs/cam/outfrq9s_rttov/user_nl_cam

-Original file line number
+Diff line change
@@ -0,0 +1,8 @@
+    mfilt=1,1,1,1,1,1
+    ndens=1,1,1,1,1,1
+    nhtfrq=9,9,9,9,9,9
+    write_nstep0=.true.
+    inithist='ENDOFRUN'
+    cosp_lrttov_sim=.true.
+    cosp_rttov_Ninstruments=1
+    cosp_rttov_instrument_namelists='/glade/campaign/cesm/community/amwg/rttov/RTTOV/namelists/cosp2_rttov_inst_CESM.txt'

cime_config/testdefs/testmods_dirs/cam/outfrq9s_rttov/user_nl_clm

-Original file line number
+Diff line change
@@ -0,0 +1,27 @@
+    !----------------------------------------------------------------------------------
+    ! Users should add all user specific namelist changes below in the form of
+    ! namelist_var = new_namelist_value
+    !
+    ! Include namelist variables for drv_flds_in ONLY if -megan and/or -drydep options
+    ! are set in the CLM_NAMELIST_OPTS env variable.
+    !
+    ! EXCEPTIONS:
+    ! Set use_cndv           by the compset you use and the CLM_BLDNML_OPTS -dynamic_vegetation setting
+    ! Set use_vichydro       by the compset you use and the CLM_BLDNML_OPTS -vichydro           setting
+    ! Set use_cn             by the compset you use and CLM_BLDNML_OPTS -bgc  setting
+    ! Set use_crop           by the compset you use and CLM_BLDNML_OPTS -crop setting
+    ! Set spinup_state       by the CLM_BLDNML_OPTS -bgc_spinup      setting
+    ! Set irrigate           by the CLM_BLDNML_OPTS -irrig           setting
+    ! Set dtime              with L_NCPL                             option
+    ! Set fatmlndfrc         with LND_DOMAIN_PATH/LND_DOMAIN_FILE    options
+    ! Set finidat            with RUN_REFCASE/RUN_REFDATE/RUN_REFTOD options for hybrid or branch cases
+    !                        (includes $inst_string for multi-ensemble cases)
+    ! Set glc_grid           with CISM_GRID                          option
+    ! Set glc_smb            with GLC_SMB                            option
+    ! Set maxpatch_glcmec    with GLC_NEC                            option
+    ! Set glc_do_dynglacier  with GLC_TWO_WAY_COUPLING               env variable
+    !----------------------------------------------------------------------------------
+    hist_nhtfrq = 9
+    hist_mfilt  = 1
+    hist_ndens  = 1

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

COSP-RTTOV integration with CAM #1327

Uh oh!

Diff view

Diff view

There are no files selected for viewing

nusbaume Apr 30, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

COSP-RTTOV integration with CAM #1327

Are you sure you want to change the base?

Uh oh!

COSP-RTTOV integration with CAM #1327

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

nusbaume Apr 30, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!