Professional Documents
Culture Documents
Orbiter Processing
Package (IPOPP)
User's Guide
Version 2.3
April 4, 2014
Table of Contents
1. General ...................................................................................................................... 1
2. Purpose...................................................................................................................... 1
3. Software Version ........................................................................................................ 1
4. IPOPP Installation ...................................................................................................... 2
5. IPOPP Operation........................................................................................................ 3
6. IPOPP Tools .............................................................................................................. 9
6.1 IPOPP Dashboard ................................................................................................ 9
6.2. Status/Event Logging System Console .............................................................. 11
6.3. Pass Manager ................................................................................................... 16
7. Installing/Updating/Configuring SPAs ....................................................................... 18
8. Diagnosing and Recovering from IPOPP Operational Errors .................................... 19
Appendix A. System Requirements ............................................................................ A-1
Appendix B. Science Processing Algorithms and Products ........................................ B-1
Appendix C. Location of Ancillaries and Data Products .............................................. C-1
Version 2.3
Page i
April 4, 2014
1. General
The International Polar Orbiter Processing Package (IPOPP) processes science data and derivative
products from the Suomi National Polar-orbiting Partnership (SNPP), Aqua, and Terra missions and,
in the future, the Joint Polar Satellite System (JPSS) mission. IPOPP was initially designed for realtime science data processing but has evolved into a more general data processing package equally
suited for both real-time and non-real-time science data processing. IPOPP's real-time data
processing capability maximizes the utility of Earth science data for real-time applications and
decision-making.
Please direct any comments or questions regarding this software to the DRL via the "Contact DRL"
mechanism at the DRL Web Portal:
http://directreadout.sci.gsfc.nasa.gov/?id=dspContent&cid=66
2. Purpose
This document provides instructions for installing and operating the IPOPP software. IPOPP can
ingest SNPP Raw Data Record (RDR) files and Terra/Aqua Production Data Set (PDS) files. It
automates multi-level processing of the ingested RDR/PDS files and produces SNPP Sensor Data
Records (SDRs), SNPP Environmental Data Records (EDRs), and Terra/Aqua Level-1 and Level-2
products. For a list of science algorithms and associated products included in this package, refer to
Appendix B, "Science Processing Algorithms and Products."
IPOPP can process both real time sensor data (e.g., direct broadcast downlink), and non-real time
sensor data (e.g., downloaded from global processing archives). A Front End System (FES) set up to
receive raw sensor data from a direct broadcast downlink can serve as a real-time source of SNPP
RDR files and/or Terra/Aqua PDS files. The FES is not part of this distribution; however, FES software
technologies (e.g., RT-STPS and Simulcast), along with IPOPP and SPAs, are available at the DRL
Web Portal for use by the commercial sector. A description of IPOPP architecture can be found at:
http://directreadout.sci.gsfc.nasa.gov/?id=dspContent&cid=68
3. Software Version
IPOPP Version 2.3 was developed by the Direct Readout Laboratory (DRL), NASA Goddard Space
Flight Center. This version includes the following enhancements:
A new beta version Dashboard GUI improves the user experience significantly for chain
process configuration and process monitoring. Graphical depiction of data handling agents,
Science Processing Algorithms (SPAs) and their input/output relationships makes
configuration easy and intuitive.
C-SDR_SPA has been updated to v1.6 (Mx8.0), and VIIRS-AF_SPA has been updated to
v1.2.9.
JPSS GTMImagery SPA (w/Near Constant Contrast) and MODIS Burnscar SPA are included
in IPOPP for the first time.
VIIRS SPAs have been updated to provide improved support for compressed and/or chunked
HDF5 input files. This will result in significant reduction of SPA execution times when
processing these input files.
The Users Guide has been updated to describe operation of the beta version Dashboard GUI
and other new features in Version 2.3, which is in direct response to user request.
Copyright 1999-2007, United States Government as represented by the Administrator for the National
Aeronautics and Space Administration. All Rights Reserved.
Version 2.3
Page 1
April 4, 2014
4. IPOPP Installation
Step 1: Download the IPOPP software package
a) Users must be registered with DRL to download IPOPP. New users must complete the
"MyDRL Registration Form" at http://directreadout.sci.gsfc.nasa.gov/?id=registration to request
an account.
b) Go to: http://directreadout.sci.gsfc.nasa.gov/?id=software and select "IPOPP" from the list of
available packages. Enter your registered email address and password and follow the specific
download and installation instructions, provided on the Web Portal, to download IPOPP.
Step 2: Setup the computer (new users only; skip to Step 3 if you are updating IPOPP)
A system administrator logged in as 'root' must complete the following instructions.
a) Ensure the target computer meets the system requirements stated in Appendix A, "System
Requirements"
b) Install and configure MySQL as required.
MySQL must be installed and configured to execute when the operating system boots.
MySQL must be executing with the root password set to "b28c935". To initially set the root
password, enter:
mysqladmin -u root password b28c935
To change an existing root password, enter:
mysqladmin -u root password -p b28c935
A password prompt will appear for the user to enter the existing password. Type in the existing
password and press Enter.
c) Create a user account with standard privileges for IPOPP.
This is the account where IPOPP will be installed and executed. This user will operate IPOPP.
d) Create the /raid directory with correct permissions.
The IPOPP user must own and have read/write access to /raid.
Step 3: Install IPOPP
The following steps must be completed by the IPOPP user. The instructions contained in this User's
Guide assume that $HOME is the home directory of the IPOPP user account (e.g., /home/ipopp).
a) Log in as the IPOPP user.
b) rm -r $HOME/IPOPP
cd $HOME/IPOPP
[Change directory]
h) ./uninstall_ipopp.sh
Version 2.3
April 4, 2014
./install_ipopp.sh
Installation takes several minutes. Wait for the message "IPOPP installation complete" to
ensure that installation is complete. You are now ready to start IPOPP processing. Refer to
Section 5, "IPOPP Operation."
5. IPOPP Operation
The following steps describe the steps required to operate IPOPP. IPOPP tools are also described in
more detail in Section 6, "IPOPP Tools."
Step 1: Configure IPOPP using the IPOPP Dashboard
a) $HOME/drl/tools/dashboard.sh
The IPOPP Dashboard has two modes: Configuration Editor Mode (see Figure 1a) and
Process Monitor Mode (see Figure 1b). The Dashboard opens in the Process Monitor Mode
when first invoked. IPOPP configuration is allowed only in the Configuration Editor Mode.
b) Click "Mode > IPOPP Configuration Editor"
Confirm the stopping of all SPA services on the dialog box that appears. SPA services will be
stopped to enter Configuration Editor Mode. Each square box on the Dashboard (see Figure
1a) represents an SPA station. The flow lines represent the hierarchical relationships among
the SPA stations. An SPA station is an IPOPP processing agent responsible for generating a
subset of the output products available from the SPA as a whole. An SPA may thus have
multiple stations. Each SPA Station on the Dashboard is labeled; the label includes the SPA
name to associate the station to its source SPA. Information on data products available from
each SPA station is available by clicking on the Product Information button labeled "i" on the
SPA Station. SPA stations are distributed in three tabs: (i) the "EOS" tab has stations that
process data from Terra/Aqua MODIS; (ii) the "SNPP-VIIRS" tab shows stations that process
SNPP VIIRS data; and (iii) the "SNPP-ATMS/CrIS/OMPS" tab shows SPA stations that
process SNPP ATMS, CrIS and OMPS data.
c) Enable/Disable SPA stations
Each SPA Station on the Dashboard acts as a toggle button to allow users to enable or
disable it. As you mouse-over each SPA Station, the immediate upstream and downstream
SPA stations are highlighted. Note that the immediate upstream stations may depend on their
own upstream stations, which in turn can have their own prerequisites. In order to correctly
enable a station you will need to follow the dependencies all the way up the processing chain
and enable all predecessor stations.
NOTE: VIIRS_C-SDR and VIIRS-SDR are mutually exclusive and therefore should not be
enabled simultaneously.
NOTE: In order to balance resource requirements, it is recommended to perform Aqua/Terra
MODIS and SNPP instrument processing on separate IPOPP installations.
Version 2.3
Page 3
April 4, 2014
Figure 1a. IPOPP Dashboard: Configuration Editor Mode (refer to Table 3 in Section 6.1 for detailed descriptions)
Version 2.3
Page 4
April 4, 2014
Figure 1b. IPOPP Dashboard: Process Monitor Mode (refer to Table 3 in Section 6.1 for detailed descriptions)
Version 2.3
Page 5
April 4, 2014
Click 'Yes' to save the Configuration just edited, and press 'OK' on the "IPOPP configuration
saved" prompt. The display will be synchronized before entering the Process Monitor Mode.
IPOPP utilities including the one that starts IPOPP services are only available in the Process
Monitor Mode. At this point all SPA stations (including the ones that were enabled in Step 1)
should report their status as "OFF".
b) Click "Actions> Start Services"
Confirm starting of IPOPP services. A progress bar dialog box shows progress until all
services are started. All SPA stations enabled in Step 1 should now appear as "ON" on the
Dashboard Window. IPOPP Services include SPA services, Ancillary Retrieval and
Registration Services, Ingest Services, File Management Services, Logging Services, and
Database Maintenance Services. "Network Unreachable" or other transient error messages
may be written to the SLS Console until the IPOPP Services completely initialize.
c) Wait about 2 minutes
This is required only if you are starting IPOPP services for the first time (i.e., after IPOPP
installation or IPOPP reset).
NOTE: The following IPOPP tools are available to monitor IPOPP activity:
i.
ii.
SLS Console
SLS Console opens up along with the Dashboard (SLS Console may be hidden behind the
Dashboard). Logs will appear on the SLS Console showing all IPOPP activity. Refer to Section
6.2, "Status/Event Logging System" for more details.
iii.
Check IPOPP Services is available when Dashboard is in Process Monitor mode. A dialog box
will report IPOPP status. If some services are reported as not running, use the Actions>Start
Services option to start all services. If the utility reports an error, refer to Section 6.1, "IPOPP
Dashboard," for more details.
b) Skip to Step c) if you are processing real-time instrument data.
For non-real-time processing of historical instrument data, users will need to ingest the
required ancillaries. The DRL maintains a Compressed Ancillary Archive at:
ftp://is.sci.gsfc.nasa.gov:/CompressedArchivedAncillary. Each Ancillary Archive tar file
contains ancillaries spanning an 11-day temporal period. The start time of the temporal period
is encoded into the tar file name as follows: DRLAncillary_YYYY-MM-DD.tgz. For example,
Version 2.3
Page 6
April 4, 2014
Identify the ancillary tar file(s) that are required for processing.
Identify the ancillary tar file that encompasses the instrument data start time as well as
the ancillary tar files that immediately precede and follow it. (Naming conventions for
RDR/PDS files are shown in Tables 1 and 2). For example, to process data from 200801-20, you would need: DRLAncillary_2008-01-17.tgz, DRLAncillary_2008-01-07.tgz
and DRLAncillary_2008-01-27.tgz.
ii.
iii.
$HOME/drl/reprocessing/ingest-ancillaries.sh
Wait for the message "Archived Ancillary files registration complete" to ensure that
ancillary registration is complete. Ancillaries ingested from archive tar files using the
ingest-ancillaries.sh script are always retained (unless IPOPP is reset). Real time
ancillaries are not retained beyond 14 days. Refer to Appendix C, "Location of
Ancillaries and Data Products," to locate the registered ancillaries.
iv.
rm /raid/pub/CompressedArchivedAncillary/*.tgz
This step will prevent re-registration of the same ancillaries in the future.
c) Place the SNPP RDR file or Terra/Aqua PDS (packet file and CSR) file pair in
/raid/dsm/nisfes_data
Tables 1 and 2 show the RDR/PDS files and naming conventions required for IPOPP ingest.
Field Terminal users can set up their Front End System (FES) to automatically push SNPP
RDR files or Terra/Aqua PDS file pairs into this directory as they become available. Other
users can initiate processing by manually placing the required files into this directory. Any
automatic or manual method must conform to the recommendations noted in "Important
Instructions" below. SNPP RDR files and Terra/Aqua PDS file pairs placed into this directory
are automatically discovered by IPOPP, which then proceeds to register and subsequently
process them.
If the registration step fails, IPOPP will move the file(s) to the
/raid/dsm/nisfes_data/FAILED subdirectory. All processing activity will be logged on the SLS
Console if it is running in LIVE Mode. Processed data products can be found under
/raid/pub/gsfcdata. Refer to Appendix C, "Location of Ancillaries and Data Products."
Important Instructions:
o The recommended method to transfer SNPP RDR files and Terra/Aqua PDS (packet file
and CSR) file pairs to the /raid/dsm/nisfes_data subdirectory is to first download the RDR
files and PDS file pairs to a different staging directory on the same disk as the
/raid/dsm/nisfes_data/ directory. Once the files are fully downloaded, use the 'mv'
command to move them to the /raid/dsm/nisfes_data/ directory. While transferring PDS file
pairs, make sure to transfer the larger packet file to /raid/dsm/nisfes_data/ before the
smaller CSR file. Following these instructions will protect against IPOPP prematurely
registering an incompletely transferred file.
o
SNPP RDR files and Terra/Aqua PDS (packet file and CSR) file pairs must have missioncompliant file names (as shown in Tables 1 and 2) in order to be correctly registered and
processed by IPOPP. The CRECBuilder package can be used to rename nonconforming
Aqua/Terra packet files and generate CSRs from packet files where CSRs are unavailable.
The
CRECBuilder
software
package
is
available
at:
http://directreadout.sci.gsfc.nasa.gov/?id=software
Version 2.3
Page 7
April 4, 2014
Table 1: SNPP RDR Files (and Naming Conventions) Required for IPOPP Ingest
RDR files required for
Required Naming convention
IPOPP ingest
VIIRS
VIIRS RDR
RNSCA-RVIRS_npp_dYYYYMMdd_thhmmssS_ehhmmssS_*.h5
ATMS
ATMS RDR
RATMS-RNSCA_npp_ dYYYYMMdd_thhmmssS_ehhmmssS _*.h5
CrIS
CRIS RDR
RCRIS-RNSCA_npp_ dYYYYMMdd_thhmmssS_ehhmmssS _*.h5
OMPS
OMPS ROTCS and
RNSCA-ROTCS_npp_ dYYYYMMdd_thhmmssS_ehhmmssS _*.h5
RONPS RDRs
RNSCA-RONPS_npp_ dYYYYMMdd_thhmmssS_ehhmmssS _*.h5
NOTE: 'YYYYMMdd' represents the date of the start of the swath (YYYY: 4 digit year; MM: month; dd: day of
month). The first and the second 'hhmmssS' represent the start and end of swath, respectively (hh: hour; mm:
th
minutes; ss: seconds; S: 10 of a second).
Sensor
Table 2: EOS PDS/CSR File Pairs (and naming conventions) required for IPOPP Ingest
Sensor
Terra
MODIS
Aqua
MODIS
P0420064AAAAAAAAAAAAAAyyDDDhhmmss001.PDS
P0420064AAAAAAAAAAAAAA yyDDDhhmmss000.PDS
P1540957AAAAAAAAAAAAAAyyDDDhhmmss001.PDS
P1540957AAAAAAAAAAAAAAyyDDDhhmmss000.PDS
P1540064AAAAAAAAAAAAAAyyDDDhhmmss001.PDS
P1540064AAAAAAAAAAAAAAyyDDDhhmmss000.PDS
NOTE: yyDDDhhmmss' represents the date/time of the start of the swath (yy: 2-digit year; DDD:
Julian day; hh: hour; mm: minutes; ss: seconds).
NOTE: SNPP RDR and Terra/Aqua PDS test data are available at the following locations:
VIIRS:
ATMS:
CrIS:
OMPS
Terra MODIS:
Aqua MODIS:
Aqua GBAD:
ftp://is.sci.gsfc.nasa.gov/gsfcdata/npp/viirs/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/npp/atms/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/npp/cris/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/npp/omps/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/terra/modis/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/aqua/modis/level0/
ftp://is.sci.gsfc.nasa.gov/gsfcdata/aqua/gbad/
Page 8
April 4, 2014
from an undesired state (refer to Section 6.1, "IPOPP Dashboard"); (ii) installing/updating/configuring
an SPA (refer to Section 7, "Installing/Updating/Configuring SPAs"); (iii) resetting IPOPP (refer to
Section 6.1); (iv) enabling/disabling an SPA that was previously disabled/enabled (refer to Section
6.1). If you perform any of these operations, return to Step 1 to restart IPOPP processing.
6. IPOPP Tools
6.1 IPOPP Dashboard
Purpose: The IPOPP Dashboard has two modes: Configuration Editor Mode and Process Monitor
Mode. In Configuration Editor Mode, the Dashboard allows you to enable or disable SPAs that are
already installed. In its Process Monitor Mode, the Dashboard allows you to perform IPOPP
operations (Start/Stop/Check/Reset), as well as Monitor the ON/OFF/Processing status of SPAs.
Invoking the Dashboard and Its Modes: The IPOPP Dashboard can be invoked with the following
command:
$HOME/drl/tools/dashboard.sh
This command opens up the IPOPP Dashboard in Process Monitor Mode. The Process Monitor
functionality and IPOPP utilities are available only in this mode. Enabling and disabling of SPAs can
be done by switching to the Configuration Editor Mode. Switching between modes is available via the
"Mode" Menu Item on the Dashboard Window.
Detailed Description: Table 3 contains descriptions of the GUI components. Please refer to Figures
1a and 1b depicting the IPOPP Dashboard in its two modes. Use the diagram indices to map the
corresponding GUI component to its location in the figures.
Table 3: IPOPP Dashboard Description
Diagram
Index
1
2
3
GUI Component
Mode> IPOPP
Configuration
Editor
Mode> IPOPP
Process Monitor
SPA Station
Description
Switch to the Configuration Editor Mode.
Version 2.3
Page 9
April 4, 2014
.h:mm:ss
.h:mm:ss
NOTE: Users must have SLS Console in LIVE Mode in order to view real-time
activity on the Process Monitor (its default mode; refer to Section 6.2 for
details).
4
Product
Information
Button
Clicking on this button will open up a dialog box identifying the data products
generated by the SPA station.
SPA
Relationship
Highlight
Only available in Configuration Editor Mode. Moving your mouse over an SPA
Station highlights the station's immediate upstream and downstream SPA
stations. Note that the immediate upstream stations may depend on their own
upstream stations, which in turn can have their own prerequisites. In order to
correctly enable a station you must follow the dependencies all the way up the
processing chain and enable all predecessor stations.
Mission/Sensor
Tabs
SPA stations are distributed in three tabs: (i) the "EOS" tab shows stations that
process data from Terra/Aqua MODIS; (ii) the "SNPP-VIIRS" tab shows stations
that process SNPP VIIRS data; and (iii) the "SNPP-ATMS/CrIS/OMPS" tab
shows SPA stations that process SNPP ATMS, CrIS and OMPS data.
Action>Save
Configuration
Version 2.3
Only available in Configuration Editor Mode. Allows you to save the current
Configuration.
Page 10
April 4, 2014
Ingest Display
Unit
Action>Start
1
Services
10
Action>Stop
2
Services
Only available in Process Monitor Mode. Clicking on this will stop all IPOPP
Services.
11
Action>Start
1
SPA Services
Only available in Process Monitor Mode. Clicking on this will start IPOPP's SPA
Services. Caution: Starting SPA Services will not start other IPOPP services
that are required for IPOPP processing. Use this option when you are sure that
other IPOPP Services are already running. If in doubt, use the "Action>Start
Services" option.
12
Action>Stop
2
SPA Services
Only available in Process Monitor Mode. Clicking on this will stop IPOPP's SPA
Services.
13
Action>Check
1
IPOPP Services
Only available in Process Monitor Mode. This will check the status of all IPOPP
services and determine System Health. It will list the services that are not
running. If System Errors are detected, it will provide an option for users to
restore IPOPP health. In that case, click 'OK' to restore System Health. This
should resolve the detected system errors and stop services. Users will be
provided an option to start services once the process is complete.
14
Action>Reset
IPOPP
Only available in Process Monitor Mode. Clicking on this will reset IPOPP. An
IPOPP reset can be used to recover from unexpected IPOPP errors. A reset will
stop the IPOPP Services, clear product registration from the IPOPP database
and remove ancillary and data product files.
NOTE: IPOPP reset deletes all data products. Copy data products that you
want to retain to another location before you reset IPOPP.
Only available in Process Monitor Mode. This unit reports the ON/OFF status of
the IPOPP Ingest Services. On the EOS tab it reports the status of the PDS
Ingest Services, while on the SNPP tabs it reports the status of the RDR Ingest
Services.
Only available in Process Monitor Mode. Clicking on this will start all IPOPP
Services.
NOTE: Log files created by any failing SPA in its corresponding run directory are cleared by "Actions>Start
Services", "Actions>Start SPA Services", or when restoring system health from "Actions> Check IPOPP
Services". Refer to Section 8, "Diagnosing and Recovering from IPOPP Operational Errors."
2
NOTE: Choose a time of data processing inactivity to stop IPOPP services or stop SPA services. The SLS
Console can be used to determine current data processing activity (refer to Section 6.2,. "Status/Event Logging
System Console").
The SLS allows system monitoring and provides indications of system problems or anomalies.
The SLS can serve as a diagnostic tool. Users who wish to find more information beyond the
top-level error/warning log can do so by using the Back Trace utility.
Log messages can be viewed in real time (LIVE Mode) or replayed from a selected time span.
Available message filters allow searching through logs.
Page 11
April 4, 2014
$HOME/drl/tools/dashboard.sh
This opens the IPOPP Dashboard and the SLS Console. The SLS Console may be hidden behind the
Dashboard. SLS Console is in LIVE Mode when it is first launched (refer to Table 4).
Detailed Description: The SLS Console is depicted in Figures 2a and 2b. Table 4 describes its GUI
components and how to use them to perform various operations. Use the diagram indices to map the
corresponding GUI component to its location in the figures.
Version 2.3
Page 12
April 4, 2014
Figure 2a: Status/Event Logging Console (Log Messages and Back Trace Controls)
Version 2.3
Page 13
April 4, 2014
Figure 2b: Status/Event Logging Console (Menu, Mode Panel, Filter and Playback Controls)
Version 2.3
Page 14
April 4, 2014
GUI
Component
Description
Log Messages
1
Log Message
Window
Back Trace
Examine Previous
Event/Examine
Next Event
Save Event
Details to File
[Available on the Event Details Window] Clicking on these buttons displays the
back trace text for the previous/next log or event respectively.
Close Event
Details
[Available on the Event Details Window] Clicking on this button closes the Event
Details Window.
6
7
8
File>Connect
File>Disconnect
File>IPOPP
Dashboard
File>Exit
Help>About
NSLS
9
10
Informational log messages are displayed over a white background. Warning log
messages are displayed over a yellow background, and error log messages are
displayed over a red background.
Back Trace Controls
Log Messages correspond to various events and include diagnostic back trace text.
Clicking on this button opens up the Event Details Window containing the back
trace text.
11
12
13
Display Filter
Panel
14
15
Erase Events
Toggle Auto
Scrolling of
Events
16
Play Events
17
Stop Playing
Events
Version 2.3
[Available on the Event Details Window] Clicking on this button allows the user to
save the back trace text displayed on the Event Details Window to a file.
Menu Controls
This is an advanced feature for connecting to a remote IPOPP.
Clicking on this menu item disconnects SLS console from IPOPP.
Clicking on this menu item opens up the IPOPP Dashboard (if it was closed).
Clicking on this menu item closes SLS Console.
Clicking on this menu item displays the SLS Version.
Mode Panel Controls
Clicking on this button starts LIVE Mode. In LIVE Mode messages are displayed in
the log message window as they are reported. The 'LIVE MODE' status is
displayed in the lower left corner of the Console.
Clicking on this button stops LIVE Mode and starts Playback Mode. Playback Mode
allows messages to be displayed for a selected time span. Playback controls
become available (refer to items 16 and 17).
Clicking on this button forces message Filters to be displayed if they are hidden.
Page 15
April 4, 2014
18
Filter Controls
Clicking on this button opens up a Text Filter Panel. Users can open up more than
one Text Filter Panel. This is unlike other filters, which can have only one panel.
19
Display Date/Time
Filter
20
Display Source
Filter
21
22
Display Level
Filter
Count Panel
23
24
Date/Time Filter
Panel
Source Filter
Panel
25
26
27
Delete Filter
28
NOTE: SLS Console must be in LIVE Mode, without any filtering enabled to view real-time activity on the
Process Monitor. Events/logs played back In Playback Mode will also appear on the Process Monitor.
Page 16
April 4, 2014
$HOME/drl/dsm/gui-scripts/passmanager.sh
Detailed Description: The Pass Manager is depicted in Figure 3. Table 5 describes its GUI
components and how to use them to perform reprocessing and deletion. Use the diagram indices to
map the corresponding GUI component to its location in the figure.
GUI
Components
Pass
Manager
Display
Window
Description
Each row in the Pass Manager Table represents a satellite/instrument overpass
that has been registered with the IPOPP database, and includes the following
information associated with the overpass:
a) Pass ID;
b) Spacecraft;
c) Acquisition of Signal (AOS) (start time of satellite overpass);
d) Loss of Signal (LOS) (end time of satellite overpass).
View
Version 2.3
The View button can be used to view details such as (start, stop and creation time)
about products associated with an overpass.
Page 17
April 4, 2014
Refresh
By clicking 'Refresh', the table will be updated to the most current state. The table
does not update automatically.
Reprocess
Click on a single row or multiple rows (by holding down the CTRL key) to select a
single overpass or multiple overpasses. Click on 'Reprocess', and a dialog box will
ask for confirmation. Clicking 'Yes' on the confirmation dialog box will result in
deletion of all science products associated with the selected overpass(es) (except
the SNPP RDR file or the Terra/Aqua PDS file pair) and complete reprocessing of
the overpass(es) (i.e., re-runs of relevant SPAs and regeneration of all science
data products associated with the overpass).
Delete
Click on a single row or multiple rows (by holding down the CTRL key) to select a
single overpass or multiple overpasses. Click on 'Delete', and a dialog box will ask
for confirmation. Clicking 'Yes' on the confirmation dialog box will result in the
unregistering and deletion of all science data products associated with the
overpass(es), including the SNPP RDR files and Terra/Aqua PDS (packet file and
CSR) file pairs. The delete operation may take some time. Wait for the message
box to confirm that the delete was successful, then click on the 'Refresh' button to
view the changes.
NOTE: Please use caution when using the Delete utility, as it is irreversible.
7. Installing/Updating/Configuring SPAs
Science Processing Algorithms (SPAs) are remote sensing science algorithms packaged with the
DRL's algorithm wrapping technique. This algorithm wrapper provides a common command and
execution interface to encapsulate multi-discipline, multi-mission science processing algorithms. Once
packaged as an SPA, a science algorithm can be plugged into IPOPP for automatic processing.
This version of IPOPP already contains the most current SNPP SPAs and Terra/Aqua MODIS SPAs
available at the time of release. For the list of SPAs included in this package refer to Appendix B,
"Science Processing Algorithms and Products." New or updated SPAs will be made available via the
DRL Web Portal. Go to http://directreadout.sci.gsfc.nasa.gov/?id=software for the most current list of
SPAs and products supported by IPOPP. Follow the instructions below for installing new or updated
SPAs into an existing IPOPP.
NOTE: To preconfigure an existing SPA rather than install/update it (e.g., SPAs like
BURNSCAR_SPA and H2G_SPA that are already included with IPOPP), perform only steps 2, 5 and
6 as described below.
1. Download algorithm_versionno_SPA_wrapperversionno.tar.gz into $HOME/drl
Go to http://directreadout.sci.gsfc.nasa.gov/?id=software and select the SPA to be installed by
clicking on the hyperlink. Follow the prompts and download the compressed archive file to the
$HOME/drl/ subdirectory. The SPA compressed archive file name will be of the form:
algorithm_versionno_SPA_wrapperversionno.tar.gz (e.g, C-SDR_1.6_SPA_1.5.tar.gz).
2. Close the Dashboard and the SLS Console, if they are open.
3. cd $HOME/drl
[Change Directory]
4. $HOME/drl/tools/install_spa.sh algorithm_version_SPA_wrapperversion.tar.gz
[Install SPA]
This will delete the old SPA directory (if it exists), create a new <spaname> subdirectory in the
$HOME/drl/SPA directory, and install the new SPA into IPOPP.
5. Pre-configure if needed
Version 2.3
April 4, 2014
Page 19
April 4, 2014
Are you trying to process a non-real time swath, but have not ingested the required
ancillaries? Ingest required ancillaries (follow the process documented in Step 3 in Section 5,
"IPOPP Operation") and then use the Pass Manager Table 'Reprocess' utility to reprocess the
overpass (refer to Section 6.3, "Pass Manager").
None of the above seems to be the problem. It is possible that the IPOPP database has been
corrupted and the existing ancillaries are not registered with the IPOPP database. Try
resetting IPOPP using the "Actions>Reset IPOPP" menu option on the IPOPP Dashboard
(refer to Section 6.1, "IPOPP Dashboard").
Is your system able to run the core algorithm executables? An easy way to discover whether your
system is able to run the core algorithm executables is to install the SPA testdata tar file and try to run
the testscript (refer to the corresponding SPA User's Guide). If the testscript fails, your system may
not meet the recommended system requirements (refer to Appendix A, "System Requirements" and
the SPA User's Guide).
PROBLEM 2: A product is not being produced.
Is
the
corresponding
SPA
installed?
"Installing/Updating/Configuring SPAs").
Install
the
SPA
(refer
to
Section
7,
Is the SPA station enabled? Use IPOPP Dashboard in Configuration Editor Mode to verify that the
station is enabled (refer to Section 6.1, "IPOPP Dashboard").
Are prerequisite stations enabled? Use Dashboard in Configuration Editor Mode to verify that
prerequisite stations are enabled (refer to Section 6.1, "IPOPP Dashboard").
Is the SPA station ON? Use Dashboard in Process Monitor Mode to verify status (refer to Section 6.1,
"IPOPP Dashboard"). If the station is OFF, try starting the station using the "Start Services" menu
option on the IPOPP Dashboard (refer to Section 6.1, "IPOPP Dashboard").
PROBLEM 3: Actions performed from the IPOPP Dashboard take an unexpectedly long time or
seem to wait indefinitely.
Are you running out of resources? This rare event may occur if you are running all SPA stations
corresponding to both EOS and SNPP missions simultaneously, or your computer does not meet the
recommended system requirements. A terminate_dashboard.sh utility is available at the IPOPP
download site on the DRL Web Portal to address this situation. Download the
TerminateDashboard_utility.tar.gz tar file and place it under $HOME/drl. Then do the following:
Abort (Ctrl-C) any IPOPP scripts that you may have invoked on the command line.
cd $HOME/drl
[Change directory]
tar xzf TerminateDashboard_utility.tar.gz
[Unpack the utility]
$HOME/drl/tools/terminate_dashboard.sh
[Execute the script]
This will terminate all IPOPP services along with the Dashboard and any actions issued by it.
At this point we recommend that you reduce the number of enabled SPAs, or increase system
memory.
Version 2.3
Page 20
April 4, 2014
Appendix A
System Requirements
Hardware
IPOPP has been tested on computers with the following configuration:
Processors:
RAM:
Data Disk:
Motherboard:
It is recommended that separate physical disks and raid controllers be used for the operating system
and the data storage at /raid. Performance on less capable systems may be improved by disabling
unneeded SPAs. SNPP processing is CPU-intensive; processors with higher clock speeds will
produce output proportionally faster.
Operating Systems
IPOPP has been tested under these operating systems:
a) Fedora 18 X86_64;
b) CentOS Linux 6.4 X86_64;
c) Open SUSE Linux 12.1 X86_64; and
d) Kubuntu 13.04 X86_64.
System Time
Some IPOPP ancillary file retrievals and product generations are time-dependent; the system must
use 24-hour UTC time and be synchronized through a Network Time Protocol (NTP) Server.
Required Software
The following software must be installed:
a) Java Runtime Environment (JRE) 1.6.0_25 or later;
b) MySQL Client and Server 5.1 or later;
c) libXp 1.0 or later;
d) bash 4.1.2 or later;
e) tcsh 6.17 or later;
f)
bc 1.06 or later;
g) ed 1.1 or later;
h) Native 32-bit support or ia32-libs (ia32-libs should not be installed on systems providing native
support such as Redhat Enterprise, Redhat Fedora, OpenSUSE, and CentOS Linux).
Additionally, Fedora Linux requires the 32-bit version of ld-linux.so.2, which can be obtained
by installing glibc for i686.
Version 2.3
Page A-1
April 4, 2014
soft
nproc
65535
Version 2.3
Page A-2
April 4, 2014
Appendix B
Science Processing Algorithms and Products
The table below lists Science Processing Algorithms (SPAs) included in this package along with the
data products they produce. More detailed descriptions of SPAs are contained in the respective SPA
User's Guides available with the SPA packages.
SNPP SPAs
C-SDR
Version
Included
1.6
CVIIRS
1.0
ActiveFires
GTMImagery
1.5.06.07
1.5.07.02
CloudMask
LST
Aerosol
1.5.06.07
1.5.06.07
1.5.06.07
SurfReflect
VegIndex
COP
1.5.06.07
1.5.06.07
1.5.06.07
SnowCov
1.5.06.07
VIIRS-AF
1.2.9
OMPSnadir
0.0.5
MODIS SPAs
Aqua GBAD
MODISL1DB
Version
Included
2.7
1.8
Version 2.3
Output Products
VIIRS Imagery resolution SDRs
VIIRS Moderate resolution SDRs
VIIRS Day/Night Band (DNB) SDR
VIIRS On Board Calibrator IP Intermediate Product (IP)
VIIRS Calibrated Dual Gain IP
VIIRS Geolocation products
ATMS SDR
ATMS Temperature Data Record (TDR)
ATMS Geolocation products
CrIS SDR and Geolocation products
VIIRS Imagery and Moderate Resolution Corrected Reflectance Level2
Products
VIIRS Active Fires Application Related Product (ARP) (with Fire Mask)
VIIRS I-Band Ground Track Mercator (GTM) Imagery EDR
VIIRS M-Band GTM Imagery EDR
VIIRS Near Constant Contrast (NCC) Albedo GTM Imagery EDR
VIIRS Cloud Mask IP
VIIRS Land Surface Temperature EDR
VIIRS Aerosol Optical Thickness (AOT) IP
VIIRS Aerosol Model Index (AMI) IP
VIIRS Aerosol Environmental Data Record (EDR)
VIIRS Suspended Matter (SM) EDR
VIIRS Aerosol Geolocation
VIIRS Land Surface Reflectance IP
VIIRS Vegetation Index EDR
VIIRS Cloud Optical Properties IP
VIIRS Ice & Night Water Cloud Top Temperature IP
VIIRS Snow Binary Map EDR
VIIRS Snow Fraction EDR
VIIRS Active Fire Level 2 (NASA algorithm)
VIIRS Fire Location Text File
OMPS Total Column Level 1A EV (TCL1AEV)
OMPS Total Column SDR EV(TCSDREV)
OMPS Total Column Total Ozone (TCTO3)
OMPS Total Column Total SO2 NRT (TCTSO2NRT)
OMPS Nadir Profile Level 1A EV (NPL1AEV)
OMPS Nadir Profile SDR EV (NPSDREV)
OMPS Nadir Profile SDR Deluxe (NPSDRDELUXE)
OMPS Nadir Profile Ozone (NPO3)
PNG image for Ozone
PNG image for Reflectivity at 331nm
PNG image for Ultraviolet Aerosol
Output Products
Aqua Ephemeris and Attitude files
MODIS Level 1A (MOD01/MYD01) and Geolocation (MOD03/MYD03)
MODIS Level 1B 1 km (MOD021KM/MYD021KM), half km
(MOD02HKM/MYD02QKM), and quarter km (MOD02QKM/MYD02QKM)
Page B-1
April 4, 2014
IMAPP
2.2
L2GEN
6.4.2
MOD14
6.2.1
CREFL
NDVIEVI
MODLST
BURNSCAR
1.7.1
2.2
4.14
1.1
Other SPAs
H2G
Version
Included
2.3
Version 2.3
products
MODIS Cloudmask Level 2(MOD35)
MODIS Cloudtop Properties, Cloud Phase and Cloud Optical properties
Level 2 (MOD06)
MODIS Atmospheric Profiles Level 2(MOD07)
MODIS Aerosol Level 2(MOD04)
NOTE:
The IPOPP package does not contain the optional
IMAPP*_MOD06OD_COEFF.tar.gz coefficient files tar file. This file is
available on the DRL Web Portal and may be optionally installed to enable
the MODIS Cloud Optical Properties software module (MOD06OD).
Additional instructions are available in the IMAPP_SPA User's Guide.
MODIS Ocean Color Level 2 (daytime product, includes Chlorophyll-a
[CHLOR_A] concentration)
MODIS Sea Surface Temperature (SST) Level 2
MODIS Active Fire (MOD14) Level 2
MODIS Fire Location Text File
MODIS Level 2 Corrected Reflectance Level 2
MODIS Vegetation Indices (MOD13) Level 2
MODIS Land Surface Temperature Level 2
MODIS Half km Corrected Reflectance Level 2
MODIS Corrected Reflectance Daily Composite Level 3
MODIS Active Fires Daily Composite Level 3
MODIS Prescar Level 3 (Standalone Mode only)
MODIS Burnscar Level 3 (Standalone Mode only)
Output Products
Geolocated GeoTIFF images, for various parameter datasets in SNPP
SPA products and MODIS Level 2 SPA products. H2G also creates
standard true color images for supported VIIRS and MODIS science
products.
Page B-2
April 4, 2014
Appendix C
Location of Ancillaries and Data Products
The table below shows the location of the ancillaries and processed instrument data products.
Directory Location
Ancillaries/Products
/raid/pub/ancillary
/raid/pub/ArchivedAncillary
/raid/pub/gsfcdata/terra/modis/level{0,1,2}
/raid/pub/gsfcdata/aqua/modis/level{0,1,2}
/raid/pub/gsfcdata/combined/modis/level3
/raid/pub/gsfcdata/aqua/gbad/
/raid/pub/gsfcdata/npp/viirs/level{0,1,2}
/raid/pub/gsfcdata/npp/atms/level{0,1}
/raid/pub/gsfcdata/npp/cris/level{0,1}
/raid/pub/gsfcdata/npp/omps/level{0,1,2}
Version 2.3
Page C-1
April 4, 2014