H5AUGJPSS version 1.0 released on August 5 11:05 CDT 2011



BUILDING H5AUGJPSS
==================
Prerequisites:  HDF5 (version 1.8) and libxml2-devel

The Makefile in src will use h5cc from the system installed HDF5 (or the first one
found according to the user's PATH).  If h5cc is not in the user's PATH or if
h5cc from a different HDF5 version is desired, the Makefile can be edited to
specify the full path to h5cc.

The Makefile expects to find header files for libxml2 in /usr/include/libxml2 
and to link to /usr/lib/libxml2.a.  On Linux machines these files can be
obtained by installing the libxml2-devel package.  If these are installed in
another location, edit the paths in the Makefile.

When the paths are correct:
1. run make in the src directory.  
2. Check for the h5augjpss binary in the top level directory.

TEST
====
cd to the test directory and check the NCDUMP and H5DUMP variables at the top
of the script.  If they don't work as specified, change them to point to  
installed ncdump and h5dump binaries.

Run test_h5ajpss.sh.


RUNNING H5AUGJPSS
=================
The h5augjpss prototype has 7 command line options:

-h or --help    displays a usage message

-o or -l options
   -o1		Removes the link to the /Data_Products group, making the group
                unavailable to the HDF5 library and allowing netCDF-4 based
                tools and applications to open <JPSS product file name>.
   -o2         Add dimension scales and attributes according to the Product
                Profile xml file.  There is no option provided to reverse 
                these changes.
   -o3         Add geolocation datasets Height, Latitude, and Longitude from
                the file specified by the N_GEO_Ref attribute in the data file.
                There is no option provided to reverse these changes. 
   -o4         Create links in the '/' group to datasets in the /All_Data... 
                group, then remove it.
   -r1         Reverse the change made by -o1.
   -r4         Reverse the change made by -o4

EXAMPLE COMMANDS
================
   h5augjpss -o1 <JPSS product file name>
      removes the link to the group with objects unknown to netCDF-4, making
      the group unavailable to the HDF5 library and allowing netCDF-4 based 
      tools and applications to open <JPSS product file name>
   h5augjpss -o2 <JPSS XML product file name> <JPSS product file name>
      extracts dimensions and other information from the JPSS XML product
      file according to the specifications found in h5augjpss-design.pdf.
   h5augjpss -o3 <JPSS product file name>
      checks JPSS product file for Height, Latitude and Longitude datasets
      and copies them from the file specified in the product file's attribute
      N_GEO_Ref if they are not present in the product file.
   h5augjpss -o4 <JPSS product file name>
      creates links to the JPSS product file's datasets in /All_Data/...,
      then removes the link to the group /All_Data/..., making it unavailable
      to the HDF5 library and allowing tools such as IDV that don't support
      HDF5 groups to open the modified file.
   h5augjpss -o1 -o2 -o3 -o4 <JPSS XML product file name>
      <JPSS product file name>
      executes all of the four modifications above.
   h5augjpss <JPSS XML product file name> <JPSS product file name>
      executes options -o1 -o2 -o3 as described above.
   h5augjpss -r1 <JPSS product file name>
      reverses the effect of -o1, replacing the original link to restore
      access to the /Data_Products group.
   h5augjpss -r4 <JPSS product file name>
      reverses the effect of -o4, removing the added links and replacing the
      original link to restore access to the /All_Data group.

The -o and -r options can be run in any order and any combination. 

INPUT FILE DIRECTORIES
======================
Absolute or relative paths (relative to the current working directory) may be
specified for the xmlfile and the datafile.  An environment variable
H5AUGJPSS_DATADIR may also be set with a path to the directory where the files
are located, in which case the paths may be omitted.  If the environment
variable is set and a path is also specified, the specified path will be used.

If a path is specified for the datafile only, the path will be used for the
datafile, and h5augjpss will search for the xmlfile first in the directory 
specified by the environment variable if set, then in the directory specified 
for the data file, then in the current working directory.  

The file specified in the datafile for the geolocation datasets must be in the  
same directory as the datafile.
