Using the MAPL Orbital Component with SatSim: Difference between revisions

(5 intermediate revisions by the same user not shown)

Line 1:

The MAPL_OrbGridComp module is a gridded component that creates satellite ground tracts. From these tracks, masks on the ~~imput~~ grid are created. The component has been integrated in the GEOS5 GCM and is a child of the AGCM gridded component. Thus far it has been interfaced with the SatSim gridded component. Exports of the SatSim component can be masked and the masked fields can be output via the History ~~componnent~~. To use this capability the user must provide two resource files that follow the standards of ESMF resource files. The first is MAPL_OrbGridComp.rc

The MAPL_OrbGridComp module is a gridded component that creates satellite ground tracts. From these tracks, masks on the input grid are created. These masks represent which grid cell boxes were passed over by the satellite in a timestep of the model. The component has been integrated in the GEOS5 GCM and is a child of the AGCM gridded component and creates masks on the atmospheric grid at each timestep in the model run. The mask represents the ground track or swath of the particular satellite between the current model time and the current model time plus the heartbeat. For example, if the model heartbeat is 30 minutes and we start the model at 21z, at the first timestep the masks exported by MAPL_OrbGridComp represent the ground track or swath seen between 21:00 and 21:30. At the 2nd timestep the exports now represent the track or swath between 21:30 and 22:00.

Thus far the MAPL_OrbGridComp module has been interfaced with the SatSim gridded component. Exports of the SatSim component can be masked and the masked fields can be output via the History as an export of SatSim. To use this capability the user must provide two resource files that follow the standards of ESMF resource files. The first is MAPL_OrbGridComp.rc, which defines the satellites and the swath of the instruments to simulate in the model run.

An example MAPL_OrbGridComp.rc is shown below:

Line 6:

Line 7:

# Mask Definitions

# ----------------

verbose: .false.

debug: .false.

Nominal_Orbits::

# Swath

Line 37:

Line 40:

Satellite - This is the satellite name. Currently the valid satellites are TERRA, AQUA, AURA, CALIPSO, and CLOUDSAT.

Swath - This the the size of the swath in kilometers. Note the ~~actual swath size is twice this~~ since this is the size of the swath on either side of the groud track. If this is 0 you will just get the ground track of the actual satellite.

Swath - This the the size of the swath in kilometers. Note the ACTUAL SWATH SIZE IS TWICE THIS since this is the size of the swath on either side of the groud track. If this is 0 you will just get the ground track of the actual satellite.

Halo - This allows one to had a halo around the swath where the number is the number of extra grid points to swath outside of the generated sattellite swath

Line 43:

Line 46:

Long Name - this parameter is not read but you can place additional text after the Halo for information

The second resource file you need is called SatSim.rc and an example SatSim.rc is shown below:

The second resource file you need is called SatSim.rc and describes which exports of SatSim to mask with the possible masks produced by the MAPL_OrbGridComp module. An example SatSim.rc is shown below:

<pre>

Line 59:

Line 62:

3. Name of new variable. This is what the new masked export will be name. The variable of this name can now be exported via the History from the SatSim component like any of the native exports of SatSim.

Finally any mask defined in the MAPL_OrbGridComp.rc file can be exported in History as a standard 2D field with the same name as the instrument from the 'ORBIT' component. For example to output TERRA and MOPITT masks defined in the example MAPL_OrbGridComp.rc define a collection with the fields attribute like so:

<pre>

collection_name.fields: 'TERRA' , 'ORBIT' ,

'MOPITT' , 'ORBIT' ,

::

</pre>

@@ Line 1: / Line 1: @@
-The MAPL_OrbGridComp module is a gridded component that creates satellite ground tracts. From these tracks, masks on the imput grid are created. The component has been integrated in the GEOS5 GCM and is a child of the AGCM gridded component. Thus far it has been interfaced with the SatSim gridded component. Exports of the SatSim component can be masked and the masked fields can be output via the History componnent. To use this capability the user must provide two resource files that follow the standards of ESMF resource files. The first is MAPL_OrbGridComp.rc
+The MAPL_OrbGridComp module is a gridded component that creates satellite ground tracts. From these tracks, masks on the input grid are created. These masks represent which grid cell boxes were passed over by the satellite in a timestep of the model. The component has been integrated in the GEOS5 GCM and is a child of the AGCM gridded component and creates masks on the atmospheric grid at each timestep in the model run. The mask represents the ground track or swath of the particular satellite between the current model time and the current model time plus the heartbeat. For example, if the model heartbeat is 30 minutes and we start the model at 21z, at the first timestep the masks exported by MAPL_OrbGridComp represent the ground track or swath seen between 21:00 and 21:30. At the 2nd timestep the exports now represent the track or swath between 21:30 and 22:00.
+Thus far the MAPL_OrbGridComp module has been interfaced with the SatSim gridded component. Exports of the SatSim component can be masked and the masked fields can be output via the History as an export of SatSim. To use this capability the user must provide two resource files that follow the standards of ESMF resource files. The first is MAPL_OrbGridComp.rc, which defines the satellites and the swath of the instruments to simulate in the model run.
 An example MAPL_OrbGridComp.rc is shown below:
@@ Line 6: / Line 7: @@
 #                            Mask Definitions
 #                            ----------------
+verbose: .false.
+debug: .false.
 Nominal_Orbits::
 #                              Swath
@@ Line 37: / Line 40: @@
 Satellite - This is the satellite name. Currently the valid satellites are TERRA, AQUA, AURA, CALIPSO, and CLOUDSAT.
-Swath - This the the size of the swath in kilometers. Note the actual swath size is twice this since this is the size of the swath on either side of the groud track. If this is 0 you will just get the ground track of the actual satellite.
+Swath - This the the size of the swath in kilometers. Note the ACTUAL SWATH SIZE IS TWICE THIS since this is the size of the swath on either side of the groud track. If this is 0 you will just get the ground track of the actual satellite.
 Halo - This allows one to had a halo around the swath where the number is the number of extra grid points to swath outside of the generated sattellite swath
@@ Line 43: / Line 46: @@
 Long Name - this parameter is not read but you can place additional text after the Halo for information
-The second resource file you need is called SatSim.rc and an example SatSim.rc is shown below:
+The second resource file you need is called SatSim.rc and describes which exports of SatSim to mask with the possible masks produced by the MAPL_OrbGridComp module. An example SatSim.rc is shown below:
 <pre>
@@ Line 59: / Line 62: @@
 . Name of new variable. This is what the new masked export will be name. The variable of this name can now be exported via the History from the SatSim component like any of the native exports of SatSim.
+Finally any mask defined in the MAPL_OrbGridComp.rc file can be exported in History as a standard 2D field with the same name as the instrument from the 'ORBIT' component. For example to output TERRA and MOPITT masks defined in the example MAPL_OrbGridComp.rc define a collection with the fields attribute like so:
+<pre>
+collection_name.fields: 'TERRA'  ,  'ORBIT' ,
+                        'MOPITT' ,  'ORBIT' ,
+::
+</pre>