From dd17a83e6edc6aeab33bb2c830e49099fb4ff55b Mon Sep 17 00:00:00 2001 From: Pedro Vicente Nunes Date: Tue, 20 Jul 2004 16:45:38 -0500 Subject: [svn-r8909] Purpose: update documentation and usage message Description: updated the html documentation for the new h5diff modes added a section for h5repack Solution: Platforms tested: linux Misc. update: --- doc/html/Tools.html | 123 +++++++++++++++++++++++++++++++++++++---- tools/h5repack/h5repack_main.c | 3 +- 2 files changed, 115 insertions(+), 11 deletions(-) diff --git a/doc/html/Tools.html b/doc/html/Tools.html index 2d2007f..a82ee99 100644 --- a/doc/html/Tools.html +++ b/doc/html/Tools.html @@ -93,8 +93,9 @@ installed with HDF5.
  • h5ls -- Lists specified features of HDF5 file contents
  • h5diff -- - Compares two HDF5 files and reports the differences - (Beta version) + Compares two HDF5 files and reports the differences. +
  • h5repack -- Copies an HDF5 file to a new + file with or without compression/chunking.
  • h5perf -- Measures HDF5 performance
  • h5repart -- @@ -669,7 +670,7 @@ installed with HDF5.
    -
    Tool Name: h5diff    (Beta version) +
    Tool Name: h5diff    
    Syntax:
    h5diff file1 file2 [OPTIONS] @@ -692,9 +693,19 @@ installed with HDF5. object1 in file1 with object2 in file2. These objects must be HDF5 datasets. +

    object1 and object2 must be expressed as absolute paths from the respective file's root group. +

    +

    + h5diff has the following four modes of output:
    + Normal mode: print the number of differences found and where they occurred
    + Report mode (-r): print the above plus the differences
    + Verbose mode (-v): print the above plus a list of objects and warnings
    + Quiet mode (-q): do not print output (h5diff always returns an exit code of + 1 when differences are found). +

    Additional information, with several sample cases, can be found in the document @@ -710,12 +721,18 @@ installed with HDF5. The HDF5 files to be compared. -h - Print all differences. + help message. -r - Print only the names of objects that differ; - do not print the differences. These objects may be HDF5 - datasets, groups, or named datatypes. + Report mode. Print the differences. + + -v + Verbose mode. Print the differences, list of objects, warnings. + + + -q + Quiet mode. Do not print output. + -n count Print difference up to count @@ -771,6 +788,90 @@ installed with HDF5.

    +
    Tool Name: h5repack     +
    Syntax: +
    h5repack -i file1-o file2 [-h] [-v] [-f + 'filter'] [-l 'layout'][-m number][-e file] +
    Purpose: +
    Copies an HDF5 file to a new file with or without compression/chunking. +
    Description: +
    h5repack is a command line tool that applies HDF5 filters + to a input file file1, saving the output in a new file, file2.

    'filter' + is a string with the format 
    + <list of objects> : <name of filter> = <filter + parameters>.
    +
    +  <list of objects> is a comma separated list of object names + meaning apply compression only to those objects. If no object names are + specified, the filter is applied to all objects
    +  <name of filter> can be: 
    + GZIP, to apply the HDF5 GZIP filter (GZIP compression)
    + SZIP, to apply the HDF5 SZIP filter (SZIP compression)
    + SHUF, to apply the HDF5 shuffle filter
    + FLET, to apply the HDF5 checksum filter
    + NONE, to remove the filter 
    + <filter parameters> is optional compression info 
    + SHUF (no parameter) 
    + FLET (no parameter) 
    + GZIP=<deflation level> from 1-9 
    + SZIP=<pixels per block,coding> (pixels per block is a even number in + 2-32 and coding method is 'EC' or 'NN') +

     
    +
    'layout' is a string with the format
    +  <list of objects> : <layout type> 
    +
    + <list of objects> is a comma separated list of object names, meaning + that layout information is supplied for those objects. If no object names are + specified, the layout is applied to all objects 
    + <layout type> can be: 
    + CHUNK, to apply chunking layout 
    + COMPA, to apply compact layout 
    + CONTI, to apply continuous layout 
    + <layout parameters> is present for the chunk case only it is the chunk + size of each dimension: <dim_1 x dim_2 x ... dim_n>
    +
     
    +
    Options and Parameters: +
    +
    file1 +
    file2 +
    The input and output HDF5 files +
    -h +
    help message.
    -f filter +
    Filter type
    -l layout +
    Layout type
    -v +
    Verbose mode. Print output (list of objects in the file, filters + and layout applied).
    -e file +
    File with the -f and -l options (only filter and layout flags) +
    -d delta +
    Print only differences that are greater than the + limit delta. + delta must be a positive number. + The comparison criterion is whether the + absolute value of the difference of + two corresponding values is greater than + delta +
    (e.g., |a–b| > delta, + where a is a value in file1 and + b is a value in file2).
    -m number +
    Do not apply the filter to objects which size in bytes is + smaller than number. If no size is specified a minimum of 1024 + bytes is assumed. +
    +
    Examples: +
    1) h5repack -i file1 -o file2 -f GZIP=1 -v
    +         Applies GZIP compression to all + objects in file1 and saves the output in file2 +

    2) h5repack -i file1 -o file2 -f dset1:SZIP=8,NN -v
    +         Applies SZIP compression only + to object 'dset1'

    +

    3) h5repack -i file1 -o file2 -l dset1,dset2:CHUNK=20x10 -v
    +         Applies chunked layout to + objects 'dset1' and 'dset2'
    +

    + +

     

    +
    +
    Tool Name: h5repart
    Syntax:
    h5repart @@ -2309,7 +2410,7 @@ installed with HDF5. 
             # h5cc -c prog1.c
         # h5cc -c prog2.c
-        # h5cc -shlib -o hdf_prog prog1.o prog2.o
    + # h5cc -shlib -o hdf_prog prog1.o prog2.o
    Options and Parameters:
      @@ -2401,7 +2502,7 @@ installed with HDF5. 
               # h5fc -c prog1.f90
         # h5fc -c prog2.f90
-        # h5fc -o hdf_prog prog1.o prog2.o
      + # h5fc -o hdf_prog prog1.o prog2.o
      Options and Parameters:
        @@ -2614,7 +2715,9 @@ And in this document, the HDF Help Desk
        Describes HDF5 Release 1.7, the unreleased development branch; working toward HDF5 Release 1.8.0 -