Using the SatSim Gridded Component: Difference between revisions

 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page describes how to use the SatSim gridded component, which implements the CFMIP observational simulator package (COSP).  This package simulates the cloud observations from the satellite instruments CloudSat, CALIPSO, MISR, and PARASOL, and the International Satellite Cloud Climatology Project (ISCCP).  The SatSim gridded component is compiled by default into Fortuna 2.3 and later, but the latest version usually requires updating to the latest development tag.
This page describes how to use the SatSim gridded component, which implements the CFMIP observational simulator package (COSP).  This package simulates the cloud observations from the satellite instruments CloudSat, CALIPSO, MISR, and PARASOL, and the International Satellite Cloud Climatology Project (ISCCP).  The SatSim gridded component is compiled by default into Fortuna 2.3 and later.


== Compile-Time Options ==
== Compile-Time Options ==
Line 7: Line 7:
  src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSradiation_GridComp/GEOSsatsim_GridComp
  src/GEOSgcs_GridComp/GEOSgcm_GridComp/GEOSagcm_GridComp/GEOSphysics_GridComp/GEOSradiation_GridComp/GEOSsatsim_GridComp


The other files in this directory are provided with COSP.  Bugfixes and updates have been applied since the Fortuna-2_5 tag, so you should update the directory by cding to it and entering
The other files in this directory are provided with COSP.  
 
cvs upd -r afe_F2_5_satimdev_20111208
 
before compiling.


By default the gridded component runs the ISCCP, Cloudsat (radar), CALIPSO (lidar), PARASOL, MISR and MODIS simulators.  Individual simulators, particularly the radar and lidar simulators, may be switched off for performance purposes.  This may be done by commenting out the lines that toggle the switches to true, under the comment indicating "Switches".  Another option is the use of preprocessing directive, <code>#define USE_MAPL_UNDEF</code>.  This sets all of the "undefined" values to MAPL_UNDEF from the values used by COSP and the simulator routines, preventing problems in the GEOS-5 post-processing.
By default the gridded component runs the ISCCP, Cloudsat (radar), CALIPSO (lidar), PARASOL, MISR and MODIS simulators.  Individual simulators, particularly the radar and lidar simulators, may be switched off for performance purposes.  This may be done by commenting out the lines that toggle the switches to true, under the comment indicating "Switches".  Another option is the use of preprocessing directive, <code>#define USE_MAPL_UNDEF</code>.  This sets all of the "undefined" values to MAPL_UNDEF from the values used by COSP and the simulator routines, preventing problems in the GEOS-5 post-processing.
Line 33: Line 29:
             'geosgcm_isccp'
             'geosgcm_isccp'
             'geosgcm_misr'
             'geosgcm_misr'
=== CALIPSO/PARASOL ===


The following are exports from the lidar routine, which simulates data from the CALIPSO and PARASOL satellites.  As with all of the collections here, effort has been made to conform to the fields and short names specified in the CFMIP documents.  The exports with names beginning respectively with CFADLIDARSR532 and PARASOLREFL and ending with a number are not CFMIP-compliant as they are supposed to be single multidimensional fields.  This is due to limitations that MAPL places on the structure of exports.  Exports from the Moist gridded component are provided for comparison and diagnostics.  The vertical levels are intended to conform to CFMIP specifications -- the <code>levels</code> entry should be on one line in the HISTORY.rc file.
The following are exports from the lidar routine, which simulates data from the CALIPSO and PARASOL satellites.  As with all of the collections here, effort has been made to conform to the fields and short names specified in the CFMIP documents.  The exports with names beginning respectively with CFADLIDARSR532 and PARASOLREFL and ending with a number are not CFMIP-compliant as they are supposed to be single multidimensional fields.  This is due to limitations that MAPL places on the structure of exports.  Exports from the Moist gridded component are provided for comparison and diagnostics.  The vertical levels are intended to conform to CFMIP specifications -- the <code>levels</code> entry should be on one line in the HISTORY.rc file.
Line 93: Line 91:




 
===Cloudsat===


The following provides exports from the radar routine which simulates CloudSat data.  The numbered export fields with names beginning with CLOUDSATCFAD are not CFMIP-compliant for the same reasons as those in the lidar collection.
The following provides exports from the radar routine which simulates CloudSat data.  The numbered export fields with names beginning with CLOUDSATCFAD are not CFMIP-compliant for the same reasons as those in the lidar collection.
Line 105: Line 103:
   geosgcm_radar.vunit:    'm',
   geosgcm_radar.vunit:    'm',
   geosgcm_radar.vvars:    'ZL' , 'DYN'          ,
   geosgcm_radar.vvars:    'ZL' , 'DYN'          ,
   geosgcm_radar.levels:    240 720 1200 1680 2160 2640 3120 3600 4080 4560 5040 5520 6000 6480 6960 7440 7920 8400 8880 9360 9840 10320 10800 11280  
   geosgcm_radar.levels:    240 720 1200 1680 2160 2640 3120 3600 4080 4560 5040 5520 6000 6480 6960 7440 7920 8400 8880 9360 9840 10320 10800 11280 11760 12240 12720 13200 13680 14160 14640 15120 15600 16080 16560 17040 17520 18000 18480 18960
11760 12240 12720 13200 13680 14160 14640 15120 15600 16080 16560 17040 17520 18000 18480 18960
   geosgcm_radar.fields:  'RADARLTCC' , 'SATSIM'    ,
   geosgcm_radar.fields:  'RADARLTCC' , 'SATSIM'    ,
                         'CLCALIPSO2' , 'SATSIM'    ,
                         'CLCALIPSO2' , 'SATSIM'    ,
Line 137: Line 134:
                         'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                         'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                         ::
                         ::
===ISCCP===


The following collection provides the fields from the icarus (ISCPP) routine.  The CFMIP documents stipulate that ISCCP output be in a 7x7 matrix of 2D fields; these fields are broken out individually here in the exports with names that start with ISCCP.  The rest of the names follow the codes outlined in the ISCCP routines for cloud type and then height (for that cloud type, increasing with U/M/O) and optical depth (A/B).     
The following collection provides the fields from the icarus (ISCPP) routine.  The CFMIP documents stipulate that ISCCP output be in a 7x7 matrix of 2D fields; these fields are broken out individually here in the exports with names that start with ISCCP.  The rest of the names follow the codes outlined in the ISCCP routines for cloud type and then height (for that cloud type, increasing with U/M/O) and optical depth (A/B).     


To achive partial compliance with CFMIP data specifications (to be amended in post-processing), the fields are also grouped in seven exports <code>ISCCP1</code> through <code>ISCCP7</code>, each with the increasing pressure level bands of the ISCCP data.  Each export contains seven fields of increasing optical depth in that pressure band.
To achive partial compliance with CFMIP data specifications (to be amended in post-processing), the fields are also grouped in seven exports <code>ISCCP1</code> through <code>ISCCP7</code>, each with the increasing pressure level bands of the ISCCP data.  Each export contains seven fields of increasing optical depth in that pressure band.  These fields must be in a separate HISTORY collection from regular two and three dimensional fields, and it is generally unrecommended that you use them unless you have particular reason to.


   geosgcm_isccp.template:  '%y4%m2%d2_%h2%n2z.nc4',
   geosgcm_isccp.template:  '%y4%m2%d2_%h2%n2z.nc4',
Line 152: Line 151:
                         'ALBISCCP'      , 'SATSIM'    ,
                         'ALBISCCP'      , 'SATSIM'    ,
                         'CTPISCCP'      , 'SATSIM'    ,
                         'CTPISCCP'      , 'SATSIM'    ,
                        'ISCCP1'  , 'SATSIM'    ,
                        'ISCCP2'  , 'SATSIM'    ,
                        'ISCCP3'  , 'SATSIM'    ,
                        'ISCCP4'  , 'SATSIM'    ,
                        'ISCCP5'  , 'SATSIM'    ,
                        'ISCCP6'  , 'SATSIM'    ,
                        'ISCCP7'  , 'SATSIM'    ,
                         'ISCCP_CU_OA'  , 'SATSIM'    ,
                         'ISCCP_CU_OA'  , 'SATSIM'    ,
                         'ISCCP_CU_OB'  , 'SATSIM'    ,
                         'ISCCP_CU_OB'  , 'SATSIM'    ,
Line 215: Line 207:
                         'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                         'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                           ::
                           ::
===MODIS===


MODIS here.  Note that the exports with "WTR" replace the earlier, otherwise identical ones with "H2O", which are still present but deprecated.
MODIS here.  Note that the exports with "WTR" replace the earlier, otherwise identical ones with "H2O", which are still present but deprecated.
Line 296: Line 290:
                       'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                       'SLRTP'    , 'SOLAR'        , 'RADSWT'    ,
                           ::
                           ::
===MISR===


And MISR:
And MISR: