COSP-RTTOV

.github/workflows/containerized-ci.yml

@@ -78,6 +78,7 @@ jobs:
         cd driver/run
         ./cosp2_test cosp2_input_nl.txt
         ./cosp2_test cosp2_input_nl.um_global.txt
+        ./cosp2_test cosp2_swath_input_nl.um_global.txt
     ###############################################################################
     # Compare results against known good outputs. As above,
     # we split it in as many steps as tests.
@@ -99,6 +100,15 @@ jobs:
         TST=data/outputs/UKMO/cosp2_output.um_global.nc
         STATS=data/outputs/UKMO/cosp2_output.um_global.${{ matrix.compiler }}.out
         python compare_to_kgo.py ${KGO} ${TST} --atol=${ATOL} --rtol=${RTOL} --stats_file=${STATS}
+    # 3. UM global snapshot with swathing.
+    - name: UM global with swathing against known good output (KGO)
+      if: always()
+      run: |
+        cd driver
+        KGO=data/outputs/UKMO/cosp2_output.um_global.${{ matrix.compiler }}.kgo.$KGO_VERSION.nc
+        TST=data/outputs/UKMO/cosp2_swath_output.um_global.nc
+        STATS=data/outputs/UKMO/cosp2_output.um_global.${{ matrix.compiler }}.out
+        python compare_to_kgo.py ${KGO} ${TST} --atol=${ATOL} --rtol=${RTOL} --stats_file=${STATS}
     ###############################################################################
     # Produce plots when it fails during global snapshot tests,
     # and create a tarball with outputs.
@@ -112,7 +122,7 @@ jobs:
         fi
         cd data/outputs/UKMO
         tar --ignore-failed-read -czf outputs.${{ matrix.compiler }}.UKMO.tgz cosp2_output.um_global.nc \
-          cosp2_output_um.nc *.png cosp2_output*.${{ matrix.compiler }}.out
+          cosp2_output_um.nc cosp2_swath_output.um_global.nc *.png cosp2_output*.${{ matrix.compiler }}.out
         ls -lh
     ###############################################################################
     # Make output files available if any test fails

.github/workflows/continuous_integration.yml

@@ -102,6 +102,7 @@ jobs:
         cd driver/run
         ./cosp2_test cosp2_input_nl.txt
         ./cosp2_test cosp2_input_nl.um_global.txt
+        ./cosp2_test cosp2_swath_input_nl.um_global.txt
     # 2. UM global snapshot. Diagnostics on model levels.
     - name: UM global snapshot. Diagnostics on model levels.
       run: |
@@ -134,6 +135,14 @@ jobs:
         KGO=data/outputs/UKMO/cosp2_output.um_global_model_levels.${F90_SHORT_NAME}.kgo.$KGO_VERSION.nc
         TST=data/outputs/UKMO/cosp2_output.um_global_model_levels.nc
         python compare_to_kgo.py ${KGO} ${TST} --atol=${ATOL} --rtol=${RTOL}
+    # 4. UM global snapshot. 
+    - name: UM global with swathing against known good output (KGO)
+      if: always()
+      run: |
+        cd driver
+        KGO=data/outputs/UKMO/cosp2_output.um_global.${F90_SHORT_NAME}.kgo.$KGO_VERSION.nc
+        TST=data/outputs/UKMO/cosp2_swath_output.um_global.nc
+        python compare_to_kgo.py ${KGO} ${TST} --atol=${ATOL} --rtol=${RTOL}
     ###############################################################################
     # Produce plots when it fails during global snapshot tests,
     # and create a tarball with outputs.
@@ -151,7 +160,7 @@ jobs:
         fi
         cd data/outputs/UKMO
         tar --ignore-failed-read -czf outputs.${{ matrix.compiler }}.UKMO.tgz cosp2_output.um_global.nc \
-          cosp2_output_um.nc cosp2_output.um_global_model_levels.nc *.png \
+          cosp2_output_um.nc cosp2_swath_output.um_global.nc cosp2_output.um_global_model_levels.nc *.png \
           cosp2_output.um_global.out
         ls -lh
     ###############################################################################

build/Makefile

@@ -9,6 +9,13 @@ ISCCP_PATH   = $(SIM_PATH)/icarus
 MISR_PATH    = $(SIM_PATH)/MISR_simulator
 MODIS_PATH   = $(SIM_PATH)/MODIS_simulator
 PARASOL_PATH = $(SIM_PATH)/parasol
+
+# Makefile.rttov needed to define the following: 
+# RTTOVDIR, FFLAGS, LIBDIR, LIBS, LLIBS, LDFLAGS_NETCDF, LDFLAGS_HDF5, LDFLAGS_ARCH
+ifdef RTTOV
+include Makefile.rttov
+endif
+
 VPATH = $(SRC_PATH):$(HOOKS):$(SIM_PATH):$(RT_PATH):$(RS_PATH):$(CS_PATH):$(ISCCP_PATH):$(MISR_PATH):$(MODIS_PATH):$(PARASOL_PATH)
 
 # Example subcolumn generaton and mapping to optical properties, following COSP 1.4
@@ -26,6 +33,11 @@ LDFLAGS  += $(NC_LIB) -lnetcdff
 
 LDFLAGS += -L. -lcosp -lsubcol
 
+# Need additional load flags from Makefile.rttov when linking to RTTOV. May remove with improved linking.
+ifdef RTTOV
+LDFLAGS += $(LLIBS) $(LDFLAGS_NETCDF) $(LDFLAGS_HDF5) $(LDFLAGS_ARCH) $(LDFLAGS_LAPACK)
+endif
+
 # Rules
 %.o: %.F90
 	$(F90) $(F90FLAGS) -c $<
@@ -34,19 +46,37 @@ LDFLAGS += -L. -lcosp -lsubcol
 	$(F90) $(F90FLAGS) -c $<
 
 %: %.o
-	$(F90) $(F90FLAGS) -o $@ $^ $(LDFLAGS) $(LIBS)
+	$(F90) $(F90FLAGS) -o $@ $^ $(LDFLAGS)
 
+# Special rules for the RTTOV files.
+cosp_rttov_interface_v13.o : cosp_rttov_interface_v13.F90 
+	$(F90) $(F90FLAGS) $(FFLAGS) -c $<
+
+cosp_rttov_v13.o : cosp_rttov_v13.F90 
+	$(F90) $(F90FLAGS) $(FFLAGS) -c $<
+
+cosp_rttov_util.o : cosp_rttov_util.F90 
+	$(F90) $(F90FLAGS) $(FFLAGS) -c $<
 #
 # The COSP library
 #
 COSP_OBJS = cosp.o cosp_config.o cosp_stats.o cosp_constants.o cosp_errorHandling.o cosp_kinds.o \
             cosp_isccp_interface.o icarus.o cosp_misr_interface.o MISR_simulator.o               \
             cosp_modis_interface.o  modis_simulator.o cosp_parasol_interface.o  parasol.o        \
             cosp_calipso_interface.o  lidar_simulator.o cosp_cloudsat_interface.o quickbeam.o    \
-            cosp_rttov_interfaceSTUB.o cosp_rttovSTUB.o cosp_grLidar532_interface.o cosp_atlid_interface.o
+            cosp_grLidar532_interface.o cosp_atlid_interface.o
+
+# Add RTTOV files appropriately.
+ifdef RTTOV
+COSP_OBJS += cosp_rttov_interface_v13.o cosp_rttov_v13.o cosp_rttov_util.o
+else
+COSP_OBJS += cosp_rttov_interfaceSTUB.o cosp_rttovSTUB.o cosp_rttov_utilSTUB.o
+endif
+
 
 LIBRARY = libcosp.a
 
+# Jonah tried to link in RTTOV to libcosp.a rather than cosp2_test. It didn't work.
 $(LIBRARY): $(COSP_OBJS)
 	ar -rvs $(LIBRARY) $(COSP_OBJS)
 
@@ -62,44 +92,62 @@ driver:
 	make cosp2_test
 	mv cosp2_test ../driver/run
 
-# Dependencies for libary
-cosp.o : cosp_kinds.o cosp_modis_interface.o cosp_constants.o  cosp_rttov_interfaceSTUB.o \
-	cosp_misr_interface.o cosp_isccp_interface.o cosp_calipso_interface.o             \
-	cosp_cloudsat_interface.o  cosp_stats.o                                           \
-	cosp_parasol_interface.o cosp_rttovSTUB.o \
-        cosp_rttov_interfaceSTUB.o quickbeam.o MISR_simulator.o lidar_simulator.o         \
-        parasol.o icarus.o cosp_grLidar532_interface.o cosp_atlid_interface.o
+# Dependencies for normal COSP libary
+cosp.o : cosp_kinds.o cosp_modis_interface.o cosp_constants.o                              \
+         cosp_misr_interface.o cosp_isccp_interface.o cosp_calipso_interface.o             \
+         cosp_cloudsat_interface.o  cosp_stats.o                                           \
+         cosp_parasol_interface.o                                                          \
+         quickbeam.o MISR_simulator.o lidar_simulator.o                                    \
+         parasol.o icarus.o cosp_grLidar532_interface.o cosp_atlid_interface.o
+
+# Conditionally add dependencies on the STUB or actual RTTOV simulator.
+ifdef RTTOV
+cosp.o                      : cosp_rttov_interface_v13.o cosp_rttov_v13.o cosp_rttov_util.o
+cosp_stats.o                : cosp_kinds.o cosp_config.o cosp_constants.o cosp_rttov_util.o
+else
+cosp.o                      : cosp_rttov_interfaceSTUB.o cosp_rttovSTUB.o cosp_rttov_utilSTUB.o
+cosp_stats.o                : cosp_kinds.o cosp_config.o cosp_constants.o cosp_rttov_utilSTUB.o
+endif
+
 cosp_constants.o            : cosp_kinds.o
 cosp_config.o               : cosp_kinds.o
 cosp_errorHandling.o        : cosp_kinds.o
-cosp_stats.o                : cosp_kinds.o cosp_config.o cosp_constants.o
-cosp_isccp_interface.o      : cosp_kinds.o icarus.o
-icarus.o	            : cosp_kinds.o cosp_constants.o  cosp_stats.o
-cosp_misr_interface.o       : cosp_kinds.o
+cosp_isccp_interface.o      : cosp_kinds.o icarus.o cosp_stats.o
+icarus.o                    : cosp_kinds.o cosp_constants.o  cosp_stats.o
+cosp_misr_interface.o       : cosp_kinds.o cosp_stats.o
 MISR_simulator.o            : cosp_kinds.o cosp_config.o cosp_stats.o
-cosp_modis_interface.o      : cosp_kinds.o cosp_config.o modis_simulator.o
+cosp_modis_interface.o      : cosp_kinds.o cosp_config.o modis_simulator.o cosp_stats.o
 modis_simulator.o           : cosp_kinds.o cosp_config.o cosp_stats.o
-cosp_parasol_interface.o    : cosp_kinds.o
+cosp_parasol_interface.o    : cosp_kinds.o cosp_stats.o
 parasol.o                   : cosp_kinds.o cosp_config.o cosp_constants.o
-cosp_calipso_interface.o    : cosp_kinds.o lidar_simulator.o
+cosp_calipso_interface.o    : cosp_kinds.o lidar_simulator.o cosp_stats.o
 lidar_simulator.o           : cosp_kinds.o cosp_config.o cosp_stats.o
-cosp_grLidar532_interface.o : cosp_kinds.o
-cosp_atlid_interface.o      : cosp_kinds.o
-cosp_cloudsat_interface.o   : cosp_kinds.o cosp_config.o quickbeam.o
+cosp_grLidar532_interface.o : cosp_kinds.o cosp_stats.o
+cosp_atlid_interface.o      : cosp_kinds.o cosp_stats.o
+cosp_cloudsat_interface.o   : cosp_kinds.o cosp_config.o quickbeam.o cosp_stats.o
 quickbeam.o                 : cosp_kinds.o cosp_stats.o
-cosp_rttov_interfaceSTUB.o  : cosp_kinds.o cosp_config.o cosp_rttovSTUB.o
+
+# RTTOV Simulator code dependencies (only one interface and one RTTOV simulator are used at a time)
+cosp_rttov_interface_v13.o  : cosp_kinds.o cosp_config.o cosp_rttov_v13.o cosp_rttov_util.o
+cosp_rttov_v13.o            : cosp_kinds.o cosp_config.o cosp_constants.o
+cosp_rttov_interfaceSTUB.o  : cosp_kinds.o cosp_config.o cosp_rttovSTUB.o cosp_rttov_utilSTUB.o
 cosp_rttovSTUB.o            : cosp_kinds.o cosp_config.o cosp_constants.o
+# RTTOV utility code dependencies
+cosp_rttov_util.o           : cosp_kinds.o
+cosp_rttov_utilSTUB.o       : cosp_kinds.o
+
 
 # Example subcolumn generaton and mapping to optical properties, following COSP 1.4
 SUBCOL_OBJS = mo_rng.o scops.o prec_scops.o cosp_utils.o cosp_optics.o quickbeam_optics.o array_lib.o math_lib.o mrgrnk.o optics_lib.o cosp_errorHandling.o
 libsubcol.a: $(SUBCOL_OBJS) libcosp.a
 	ar -rvs libsubcol.a $(SUBCOL_OBJS)
 
+
 array_lib.o       : cosp_kinds.o
 mrgrnk.o          : cosp_kinds.o
 math_lib.o        : cosp_kinds.o cosp_errorHandling.o
 optics_lib.o      : cosp_kinds.o cosp_errorHandling.o
-quickbeam_optics.o: cosp_kinds.o cosp_errorHandling.o cosp_constants.o cosp_config.o mrgrnk.o array_lib.o optics_lib.o math_lib.o quickbeam.o
+quickbeam_optics.o: cosp_kinds.o cosp_errorHandling.o cosp_constants.o cosp_config.o mrgrnk.o array_lib.o optics_lib.o math_lib.o quickbeam.o cosp_stats.o
 scops.o      : cosp_kinds.o cosp_errorHandling.o mo_rng.o
 prec_scops.o : cosp_kinds.o cosp_config.o
 cosp_utils.o : cosp_kinds.o cosp_config.o

build/Makefile.rttov

@@ -0,0 +1,103 @@
+# Makefile specifics for linking with RTTOV.
+# From src/test/Makefile_examples
+# -----------------------------------------------------------------------------
+
+# You must update the following variables below according to the local RTTOV installation and compiler
+
+# RTTOV_VERSION   RTTOV version number
+# RTTOVDIR        root directory for RTTOV binaries, libraries, modules, includes
+
+# FC              compiler command name
+# FFLAGS          compiler specific flags: -I$(RTTOVDIR)/mod -I$(RTTOVDIR)/include are mandatory
+# LDFLAGS_ARCH    flags for linker
+
+# BINDIR          directory to store the binary file
+
+# If RTTOV was compiled against the HDF5 or external LAPACK libraries this is
+# handled automatically using the contents of Makefile.local.
+
+# -----------------------------------------------------------------------------
+
+
+# RTTOVDIR=../../
+# Cheyenne version (with HDF5)
+# RTTOVDIR=/glade/u/home/jonahshaw/w/RTTOV
+
+# Derecho version (without HDF5). Note: You need a copy of Makefile.local in the RTTOVDIR directory in a build/ subdirectory
+#RTTOVDIR=/glade/u/home/jonahshaw/w/RTTOV/alt_build
+
+#FC=gfortran
+#FFLAGS= -I$(RTTOVDIR)/mod -I$(RTTOVDIR)/include -fPIC -O3 -fopenmp -ffree-line-length-none
+#FFLAGS= -I$(RTTOVDIR)/mod -I$(RTTOVDIR)/include -fPIC -O3 -fopenmp
+#LDFLAGS_ARCH=-fopenmp
+
+# Original Derecho settings
+#RTTOVDIR=/glade/u/home/jonahshaw/w/RTTOV/alt_build
+#FC=gfortran
+#FFLAGS= -I$(RTTOVDIR)/mod -I$(RTTOVDIR)/include -fPIC -O3 -fopenmp
+#LDFLAGS_ARCH=-fopenmp
+
+# Derecho with debug changes (01/23/2024)
+# RTTOVDIR=/glade/u/home/jonahshaw/w/RTTOV2
+# Derecho with HDF
+RTTOVDIR=/glade/u/home/jonahshaw/w/RTTOV2/hdf_build
+FC=ifort
+FFLAGS= -I$(RTTOVDIR)/mod -I$(RTTOVDIR)/include -fPIC -O3 -fopenmp
+LDFLAGS_ARCH=-fopenmp
+
+RTTOV_VERSION=13
+EXT_BIN=.exe
+EXT_OBJ=.o
+EXT_LIB=.a
+OBJDIR=$(RTTOVDIR)/obj
+BINDIR=$(RTTOVDIR)/bin
+
+
+#### Do not edit beyond this line ####
+
+# JKS - Include settings used to build RTTOV
+include $(RTTOVDIR)/build/Makefile.local
+
+LIBDIR=$(RTTOVDIR)/lib
+
+# JKS this if statement depends on the contents of Makefile.local
+# but it doesn't seem to do anything.
+ifdef LDFLAGS_HDF5
+	LIBS=\
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_brdf_atlas$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_emis_atlas$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_mw_scatt$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_other$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_coef_io$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_hdf$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_parallel$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_main$(EXT_LIB)
+
+	LLIBS=-L$(LIBDIR) \
+	  -lrttov$(RTTOV_VERSION)_brdf_atlas \
+	  -lrttov$(RTTOV_VERSION)_emis_atlas \
+	  -lrttov$(RTTOV_VERSION)_mw_scatt \
+	  -lrttov$(RTTOV_VERSION)_other \
+	  -lrttov$(RTTOV_VERSION)_coef_io \
+	  -lrttov$(RTTOV_VERSION)_hdf \
+	  -lrttov$(RTTOV_VERSION)_parallel \
+	  -lrttov$(RTTOV_VERSION)_main
+else
+	LIBS=\
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_brdf_atlas$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_emis_atlas$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_mw_scatt$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_other$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_coef_io$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_parallel$(EXT_LIB) \
+	  $(LIBDIR)/librttov$(RTTOV_VERSION)_main$(EXT_LIB)
+
+	LLIBS=-L$(LIBDIR) \
+	  -lrttov$(RTTOV_VERSION)_brdf_atlas \
+	  -lrttov$(RTTOV_VERSION)_emis_atlas \
+	  -lrttov$(RTTOV_VERSION)_mw_scatt \
+	  -lrttov$(RTTOV_VERSION)_other \
+	  -lrttov$(RTTOV_VERSION)_coef_io \
+	  -lrttov$(RTTOV_VERSION)_parallel \
+	  -lrttov$(RTTOV_VERSION)_main
+endif

driver/run/cosp2_input_nl.txt

@@ -82,15 +82,7 @@
   !----------------------------------------------------------------------------------
   !-------------- RTTOV inputs
   !----------------------------------------------------------------------------------
-  rttov_Platform=1,    ! satellite platform
-  rttov_Satellite=15,  ! satellite
-  rttov_Instrument=5,  ! instrument
-  rttov_Nchannels=3,   ! Number of channels to be computed
-  rttov_Channels=1,2,3,        ! Channel numbers (please be sure that you supply Nchannels)
-  rttov_Surfem=0.0,0.0,0.0,  ! Surface emissivity (please be sure that you supply Nchannels)
-  rttov_ZenAng=50.0, ! Satellite Zenith Angle
-  CO2=5.241e-04, ! Mixing ratios of trace gases
-  CH4=9.139e-07,
-  N2O=4.665e-07,
-  CO=2.098e-07
+!  rttov_Ninstruments=1,
+!  rttov_instrument_namelists='instrument_nls/cosp2_rttov_inst1.txt',
+  rttov_verbose=.false.
 /

driver/run/cosp2_input_nl.um_global.txt

@@ -82,15 +82,7 @@
   !----------------------------------------------------------------------------------
   !-------------- RTTOV inputs
   !----------------------------------------------------------------------------------
-  rttov_Platform=1,    ! satellite platform
-  rttov_Satellite=15,  ! satellite
-  rttov_Instrument=5,  ! instrument
-  rttov_Nchannels=3,   ! Number of channels to be computed
-  rttov_Channels=1,2,3,        ! Channel numbers (please be sure that you supply Nchannels)
-  rttov_Surfem=0.0,0.0,0.0,  ! Surface emissivity (please be sure that you supply Nchannels)
-  rttov_ZenAng=50.0, ! Satellite Zenith Angle
-  CO2=5.241e-04, ! Mixing ratios of trace gases
-  CH4=9.139e-07,
-  N2O=4.665e-07,
-  CO=2.098e-07
+!  rttov_Ninstruments=1,
+!  rttov_instrument_namelists='instrument_nls/cosp2_rttov_inst1.txt',
+  rttov_verbose=.false.
 /

driver/run/cosp2_input_nl.um_global_model_levels.txt

@@ -82,15 +82,7 @@
   !----------------------------------------------------------------------------------
   !-------------- RTTOV inputs
   !----------------------------------------------------------------------------------
-  rttov_Platform=1,    ! satellite platform
-  rttov_Satellite=15,  ! satellite
-  rttov_Instrument=5,  ! instrument
-  rttov_Nchannels=3,   ! Number of channels to be computed
-  rttov_Channels=1,2,3,        ! Channel numbers (please be sure that you supply Nchannels)
-  rttov_Surfem=0.0,0.0,0.0,  ! Surface emissivity (please be sure that you supply Nchannels)
-  rttov_ZenAng=50.0, ! Satellite Zenith Angle
-  CO2=5.241e-04, ! Mixing ratios of trace gases
-  CH4=9.139e-07,
-  N2O=4.665e-07,
-  CO=2.098e-07
+!  rttov_Ninstruments=1,
+!  rttov_instrument_namelists='instrument_nls/cosp2_rttov_inst1.txt',
+  rttov_verbose=.false.
 /

driver/run/cosp2_output_nl.txt

@@ -132,8 +132,6 @@
   Llwpmodis=.true.,
   Liwpmodis=.true.,
   Lclmodis=.true.,
-  !- RTTOV
-  Ltbrttov=.false.,
   ! -CLOUDSAT precipitation frequency/occurence diagnostics
   Lptradarflag0=.true.,
   Lptradarflag1=.true.,

driver/run/cosp2_output_nl.um_global_model_levels.txt

@@ -132,8 +132,6 @@
   Llwpmodis=.true.,
   Liwpmodis=.true.,
   Lclmodis=.true.,
-  !- RTTOV
-  Ltbrttov=.false.,
   ! -CLOUDSAT precipitation frequency/occurence diagnostics
   Lptradarflag0=.false.,
   Lptradarflag1=.false.,