OMPSNADIR Science Processing Algorithm (Ompsnadir - Spa) User's Guide
OMPSNADIR Science Processing Algorithm (Ompsnadir - Spa) User's Guide
OMPSNADIR Science Processing Algorithm (Ompsnadir - Spa) User's Guide
Processing Algorithm
(OMPSNADIR_SPA)
User's Guide
Version 1.0.1
September 2014
Users must agree to all terms and conditions in the Software Usage Agreement on the DRL
Web Portal before downloading this software.
Software and documentation published on the DRL Web Portal may occasionally be
updated or modified. The most current versions of DRL software are available at the DRL
Web Portal:
http://directreadout.sci.gsfc.nasa.gov/?id=software
Questions relating to the contents or status of this software and its documentation should be
addressed to the DRL via the Contact DRL mechanism at the DRL Web Portal:
http://directreadout.sci.gsfc.nasa.gov/?id=dspContent&cid=66
A Science Processing Algorithm (SPA) is defined as a wrapper and its contained algorithm.
SPAs will function in a standalone, cross-platform environment to serve the needs of the
broad Direct Readout community. Detailed information about SPAs and other DRL
technologies is available at the DRL Web Portal.
Software Description
This software package contains the Ozone Mapping and Profiler Suite (OMPS) nadir
processing Science Processing Algorithm (OMPSNADIR_SPA). The OMPSnadir algorithm
takes as input two OMPS Raw Data Record (RDR) files in mission-standard format
(RNSCA-RONPS and RNSCA-ROTCS). It creates eleven output files:
Software Version
Version 1.1 of the DRL algorithm wrapper was used to package the SPA described in this
document. The SPA uses Version 1.0.1 of the OMPSnadir algorithm.
This software will execute on a 64-bit computer and has been tested on computers with
32GB of RAM, with the following operating systems:
a) Fedora 18 X86_64;
b) CentOS Linux 6.4 X86_64;
c) OpenSUSE Linux 12.1 X86_64;
d) Kubuntu 13.04 X86_64.
Credits
The OMPSnadir algorithm was provided to the DRL by the Ozone Product Evaluation and
Analysis Test Element (OPEATE). The DRL has enhanced the software package to
improve its portability across various Linux platforms.
Prerequisites
To run this package, you must have the Java Development Kit (JDK) or Java Runtime
Engine (JRE) (Java 1.6.0_25 or higher) installed on your computer, and have the Java
installation bin/ subdirectory in your PATH environment variable.
Installing into an IPOPP Framework: This SPA can also be installed dynamically into an
IPOPP framework to automate production of OMPSNadir data products. The SPA
installation process will install SPA station(s) into IPOPP. An SPA station is an IPOPP
agent that provides the mechanism necessary for running an SPA automatically within the
IPOPP framework. Once this SPA is installed, users must enable the station(s)
corresponding to this SPA along with any other prerequisite station(s). Instructions for
installing an SPA and enabling its stations are contained in the IPOPP User's Guide
(available on the DRL Web Portal). The SPA stations associated with this SPA are listed in
Appendix A.
$ ./run_OMPSnadir.sh
A successful execution usually takes around a minute or more, depending on the speed of
your computer and the size of the granule. If everything is working properly, the scripts will
terminate with a message such as:
You can cd to the output directory to verify that the science products exist. Test output
product(s) are available for comparison in the testdata/output directory. These test output
product(s) were generated on a 64-bit PC architecture computer running Fedora 14. The
output products serve as an indicator of expected program output. Use a comparison utility
(such as diff, h5diff, etc.) to compare your output product(s) to those provided in the
testdata/output directory. Locally generated files may differ slightly from the provided output
files because of differences in machine architecture or operating systems.
Program Operation
In order to run the package using your own input data, you can either use the run scripts
within the wrapper subdirectories, or modify the test scripts within the testscripts
subdirectory.
Specify input parameters using <label value> pairs: To execute the 'run' scripts, you
must supply the required input and output parameters. Input and output parameters are
usually file paths or other values (e.g., an automatic search flag). Each parameter is
specified on the command line by a <label value> pair. Labels are simply predefined names
for parameters. Each label must be followed by its actual value. Each process has its own
set of <label value> pairs that must be specified in order for it to execute. Some of these
pairs are optional, meaning the process would still be able to execute even if that parameter
is not supplied. The two types of <label value> pairs that the OMPSNADIR_SPA uses are:
a) Input file label/values. These are input file paths. Values are absolute or relative
paths to the corresponding input file.
b) Output file label/values. These are output files that are produced by the SPA. Values
are absolute or relative paths of the files you want to generate.
The following tables contain labels, and their descriptions, required by the
OMPSNADIR_SPA.
ronps.rdr OMPS RNSCA-RONPS Raw 1. RT-STPS can be used to create these OMPS
Data Record (RDR) file RDR products.
rotcs.rdr OMPS RNSCA-ROTCS Raw 1. RT-STPS can be used to create these OMPS
Data Record (RDR) file RDR products.
Archived LUTs:
ftp://is.sci.gsfc.nasa.gov/ArchivedAncillary/LUTs/npp/omps/
OMPS-NPP-TC_DRK-p058-vw.x-yyyymMMddthhmmss-
1
*.h5
Archived LUTs:
ftp://is.sci.gsfc.nasa.gov/ArchivedAncillary/LUTs/npp/omps/
OMPS-NPP-NP_DRK-p058-vw.x- yyyymMMddthhmmss-
1
*.h5
Execute the 'run': The following script shows an example of a command line to run the
OMPSnadir algorithm from the testscripts directory:
A successful execution usually requires around a minute or more, depending on the speed
of your computer and the size of the granule. If execution fails, you will see an error
message indicating the cause of failure (e.g., a file cannot be found, or a label cannot be
recognized). Correct it and run again. If the problem has some other cause, it can be
identified using the log files. Log files are automatically generated within the directory used
for execution. They start with stdfile* and errfile* and can be deleted after execution. Other
log and intermediate files may be generated automatically within the directory used for
execution. They are useful for traceability and debugging purposes. However it is strongly
recommended that users clean up log files and intermediate files left behind in the run
directory before initiating a fresh execution of the SPA. Intermediate files from a previous
run may affect a successive run and produce ambiguous results. The 'run' can be executed
from any directory the user chooses. This can be done by prefixing it with the file path for
the 'run' script.
NOTES:
1. Use the latest leapsec and utcpole ancillaries available on DRL’s ancillary repository
(Refer to the Table above). It is recommended to use leapsec and utcpole input files
that are not more than 14 days old.
2. Use NP_DRK and TC_DRK LUTs that are closest but prior to the start of the swath.
3. The data products generated by this SPA may be visualized with the DRL's
H2G_SPA (Hierarchical Data Format [HDF] to Georeferenced Tagged Image File
Format [GeoTIFF] Converter Science Processing Algorithm). H2G is designed
NOTE: Please refer to the H2G_SPA User's Guide for more details about the image
products, including their locations and filename patterns when they are generated in IPOPP.