philipp/hdf5
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[svn-r7429]

Browse Source 
Purpose:
    Enhanced indexing; copy edits.

Description:
    Restructured index and clarify descriptions and/or make them more
        parallel; added link to "Other tools"
    Added note that h4toh5 and h5toh4 are no longer part of the HDF5 library
        distribution
    Lots of copy edits

Platforms tested:
    IE 5, Safari
This commit is contained in:
Frank Baker
2003-08-28 18:03:36 -05:00
parent 93bc31f6a0
commit 0ac562001b
1 changed files with 100 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
doc/html/Tools.html
View File

@@ -78,57 +78,84 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<li>User utilities:
<ul>
<li><a href="#Tools-Dump">h5dump</a> --
A tool for displaying HDF5 file contents
Enables a user to examine the contents of an HDF5 file
and dump those contents to an ASCII file
<li><a href="#Tools-Ls">h5ls</a> --
A tool for listing specified features of HDF5 file contents
Lists specified features of HDF5 file contents
<li><a href="#Tools-Diff">h5diff</a> --
A tool to identify and locate the differences between two HDF5 files
Compares two HDF5 files and reports the differences
<em>(Beta version)</em>
<li><a href="#Tools-Repart">h5repart</a> --
A tool for repartitioning a file, creating a family of files
<li><a href="#Tools-Import">h5import</a> --
A tool for importing data into an existing or new HDF5 file
<li><a href="#Tools-GIF2H5">gif2h5</a> --
A tool for converting a GIF file to an HDF5 file
<li><a href="#Tools-H52GIF">h52gif</a> --
A tool for converting images in an HDF5 file to a GIF file
<li><a href="#Tools-Perf">h5perf</a> --
A tool for measuring HDF5 performance
<br><br
Measures HDF5 performance
<li><a href="#Tools-Repart">h5repart</a> --
Repartitions a file, creating a family of files
<br><br>
</ul>
<li>Configuration and library management utilities:
<ul>
<li><a href="#Tools-Redeploy">h5redeploy</a> --
A tool for updating HDF5 compiler tools after installing HDF5
Updates HDF5 compiler tools after an HDF5 software installation
in a new location
<li><a href="#Tools-H5CC">h5cc</a> --
A tool for compiling HDF5 programs written in C
Simplifies the compilation of HDF5 programs written in C
<li><a href="#Tools-H5FC">h5fc</a> --
A tool for compiling HDF5 programs written in Fortran90
Simplifies the compilation of HDF5 programs written in Fortran90
<li><a href="#Tools-H5C++">h5c++</a> --
A tool for compiling HDF5 programs written in C++
<br><br
</ul>
<li><a href="http://hdf.ncsa.uiuc.edu/java-hdf5-html/">Java-based tools for HDF5</a> --
<em>(at <code>http://hdf.ncsa.uiuc.edu/java-hdf5-html/</code>)</em>
<br>
Java-based tools for viewing, manipulating, and generating HDF5
files (distributed separately)
<br>
Includes <code>H5view</code>, <code>H5gen</code>, Java HDF5
Interface (JHI5), and HDF5 VisAD Data Adapter
<br><br>
<li><a href="http://hdf.ncsa.uiuc.edu/h4toh5/">HDF5/HDF4 conversion tools</a>:
<ul>
<li><a href="http://hdf.ncsa.uiuc.edu/h4toh5/">H4toH5 Conversion Library</a> --
A library providing APIs for use in tools that perform customized
conversions of HDF4 files to HDF5 files
&nbsp;
<em>(Distributed separately; not part of HDF5)</em>
<li><a href="#Tools-H5toh4">h5toh4</a> --
A utility for converting an HDF5 file to an HDF4 file
<li><a href="#Tools-H4toh5">h4toh5</a> --
A utility for converting an HDF4 file to an HDF5 file
Simplifies the compilation of HDF5 programs written in C++
<br><br>
</ul>
<li><a href="http://hdf.ncsa.uiuc.edu/hdf-java-html/"
target="ToolsExt">Java-based tools for HDF5</a>
for viewing, manipulating, and generating HDF4 and HDF5 files:
<br>
<em>(Distributed separately; external link is
<code>http://hdf.ncsa.uiuc.edu/hdf-java-html/</code>)</em>
<ul>
<li><code>HDFview</code> -- a browser that
works with both HDF4 and HDF5 files and
can be used to transfer data between the two formats
<li>Java interfaces for both the HDF4 and HDF5 libraries
<li>Other HDF4- and HDF5-related products
<br><br>
</ul>
<li>Data conversion utilities:
<ul>
<li><a href="#Tools-Import">h5import</a> --
Imports data into an existing or new HDF5 file
<li><a href="#Tools-GIF2H5">gif2h5</a> --
Converts a GIF file to an HDF5 file
<li><a href="#Tools-H52GIF">h52gif</a> --
Converts images in an HDF5 file to a GIF file
<br><br>
</ul>
<li><a href="http://hdf.ncsa.uiuc.edu/h4toh5/" target="ToolsExt">
HDF5/HDF4 conversion tools</a>:
<br>
<em>(Distributed separately; external link is
<code>http://hdf.ncsa.uiuc.edu/h4toh5/</code>)</em>
<ul>
<li><a href="http://hdf.ncsa.uiuc.edu/h4toh5/"
target="ToolsExt">H4toH5 Conversion Library</a> --
Provides APIs for use in tools that perform customized
conversions of HDF4 files to HDF5 files
<li><a href="#Tools-H5toh4">h5toh4</a> --
Converts an HDF5 file to an HDF4 file
<li><a href="#Tools-H4toh5">h4toh5</a> --
Converts an HDF4 file to an HDF5 file
<br><br>
</ul>
<li><a href="http://hdf.ncsa.uiuc.edu/tools5.html"
target="ToolsExt">Other tools</a>,
including third-party and commercial utilities and applications
<br>
<em>(Distributed separately; external link is
<code>http://hdf.ncsa.uiuc.edu/tools5.html</code>)</em>
</ul>
</td></tr>
</table>
@@ -188,7 +215,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<p>
<code>h5dump</code> can also dump a subset of a dataset.
This feature operates in much the same way as hyperslabs in HDF5;
the parameters specified on the commnd line are passed to the
the parameters specified on the command line are passed to the
function <a href="RM_H5S.html#Dataspace-SelectHyperslab">
<code>H5Sselect_hyperslab</code></a> and the resulting selection
is displayed.
@@ -199,7 +226,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<cite>Data Description Language</cite> document.
</p>
<p>
<em>Note</em>: It is not permissable to specify multiple
<em>Note</em>: It is not permissible to specify multiple
attributes, datasets, datatypes, groups, or soft links with one
flag. For example, one may not issue the command
<br>
@@ -333,7 +360,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
[<a href="http://www.ietf.org/rfc/rfc2732.txt">IETF RFC 2732</a>])
that refers to the DTD to be used to validate the XML</dd>
<br><br>
<dt>Subsetting paramaters can also be expressed in a convenient
<dt>Subsetting parameters can also be expressed in a convenient
compact form, as follows:
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
@@ -718,7 +745,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<p>
<b>Input data and options:</b><br>
Input data can be provided in one of the follwing forms:
Input data can be provided in one of the following forms:
<ul><li>As an ASCII, or plain-text, file containing either
floating point or integer data
<li>As a binary file containing either 32-bit or
@@ -790,7 +817,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
etc.<br>
<code>h5import</code> does not overwrite a pre-existing
dataset of the specified or default name.
When an existing dataset of a confilcting name is
When an existing dataset of a conflicting name is
encountered, <code>h5import</code> quits with an error;
the current input file and any subsequent input files
are not processed.
@@ -855,7 +882,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
</td></tr>
<tr valign=top align=left><td width=30>&nbsp;</td><td>
&nbsp;&nbsp;&nbsp;&nbsp;Compressed and<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extendible
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;extendable
</td><td>Requires chunked layout.
</td></tr>
<tr valign=top align=left><td width=30>&nbsp;</td><td>
@@ -979,7 +1006,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<code>dataset3</code> for the third input dataset, etc.<br>
Note that <code>h5import</code> does not overwrite a
pre-existing dataset of the specified or default name.
When an existing dataset of a confilcting name is
When an existing dataset of a conflicting name is
encountered, <code>h5import</code> quits with an error;
the current input file and any subsequent input files
are not processed.<br>
@@ -1183,7 +1210,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<tr valign=top align=left><td>
<code>&nbsp;&nbsp;&nbsp;&nbsp;GZIP</code>
</td><td>Gzip compression.<br>
Othe compression algorithms are not implemented
Other compression algorithms are not implemented
in this release of <code>h5import</code>.
</td></tr>
@@ -1288,7 +1315,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
etc.<br>
<code>h5import</code> does not overwrite a pre-existing
dataset of the specified or default name.
When an existing dataset of a confilcting name is
When an existing dataset of a conflicting name is
encountered, <code>h5import</code> quits with an error;
the current input file and any subsequent input files
are not processed.
@@ -1373,7 +1400,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
with chunk dimension sizes of 2x2x2x2x2.<br>
&ndash; The output datatype will be 32-bit integer in
<code>NATIVE</code> format
(as the output architecure is not specified).<br>
(as the output architecture is not specified).<br>
&ndash; The output dataset will be compressed using Gzip compression
with a compression level of 7.<br>
&ndash; The output dataset will be stored in
@@ -1527,7 +1554,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<ul>
<li>HDF5 group objects are converted into HDF4 Vgroup
objects. HDF5 hardlinks and softlinks pointing to
objects. HDF5 hard links and soft links pointing to
objects are converted to HDF4 Vgroup references.
<li>HDF5 dataset objects of integer datatype are
converted into HDF4 SDS objects. These datasets
@@ -1565,6 +1592,13 @@ to convert files from HDF4 format to HDF5 format and vice versa.
All datatypes are converted to big-endian.
Floating point datatypes are converted to IEEE format.
<dt><strong>Note:</strong>
<dl>The <code>h5toh4</code> and <code>h4toh5</code> utilities
are no longer part of the HDF5 product;
they are distributed separately through the page
<a href="http://hdf.ncsa.uiuc.edu/h4toh5/">
Converting between HDF (4.x) and HDF5</a>.
</p>
<dt><strong>Options and Parameters:</strong>
<dl>
@@ -1627,8 +1661,8 @@ to convert files from HDF4 format to HDF5 format and vice versa.
The <code>-h</code> option causes a syntax summary
similar to the following to be displayed:
<pre> h4toh5 inputfile.hdf outputfile.h5
h5toh4 inputfile.hdf <!-- currently no -m option
h5toh4 -m inputfile1.hdf inputfile2.hdf ... --> </pre>
h4toh5 inputfile.hdf <!-- currently no -m option
h4toh5 -m inputfile1.hdf inputfile2.hdf ... --> </pre>
<p>
Each object in the HDF4 file is converted to an equivalent
HDF5 object, according to the mapping described in
@@ -1639,7 +1673,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<a href="http://hdf.ncsa.uiuc.edu/HDF5/papers/h4toh5/H4-to-H5MappingGuidelines.pdf" target=ExternalWinB>
<cite>Mapping HDF4 Objects to HDF5 Objects</cite> on the HDF FTP server</a>.)
<p>
In this inital version, <code>h4toh5</code> converts the following
In this initial version, <code>h4toh5</code> converts the following
HDF4 objects:
<center>
<table width=75% border=0>
@@ -1680,6 +1714,13 @@ to convert files from HDF4 format to HDF5 format and vice versa.
</td></tr>
</table>
</center>
<dt><strong>Note:</strong>
<dl>The <code>h4toh5</code> and <code>h5toh4</code> utilities
are no longer part of the HDF5 product;
they are distributed separately through the page
<a href="http://hdf.ncsa.uiuc.edu/h4toh5/">
Converting between HDF (4.x) and HDF5</a>.
</p>
<dt><strong>Options and Parameters:</strong>
<dl>
<dt><code>-h</code>
@@ -1751,7 +1792,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
Example:</td></tr>
<tr align="left" valign="top"><td>&nbsp;</td><td>
<code>HDF5_PARAPREFIX&nbsp;&nbsp;</code></td><td>
Sets the prefix for paralllel output data files.</td></tr>
Sets the prefix for parallel output data files.</td></tr>
</table>
<dt><strong>Options and Parameters:</strong>
<dl>
@@ -1950,7 +1991,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
<dt><code>-echo</code>
<dd>Shows all the shell commands executed.
<dt><code>-force</code>
<dd>Performs the requested action without offerring any prompt
<dd>Performs the requested action without offering any prompt
requesting confirmation.
<dt><code>-prefix=</code><em>dir</em>
<dd>Specifies a new directory in which to find the
@@ -1988,7 +2029,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
to compile an HDF5 program. It takes care of specifying where the
HDF5 header files and libraries are on the command line.
<p>
<code>h5cc</code> supercedes all other compiler scripts in that
<code>h5cc</code> supersedes all other compiler scripts in that
if you've used them to compile the HDF5 library, then
<code>h5cc</code> also uses those scripts. For example, when
compiling an MPIch program, you use the <code>mpicc</code>
@@ -2070,7 +2111,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
to compile an HDF5 program. It takes care of specifying where the
HDF5 header files and libraries are on the command line.
<p>
<code>h5fc</code> supercedes all other compiler scripts in that
<code>h5fc</code> supersedes all other compiler scripts in that
if you've used them to compile the HDF5 Fortran library, then
<code>h5fc</code> also uses those scripts. For example, when
compiling an MPIch program, you use the <code>mpif90</code>
@@ -2145,7 +2186,7 @@ to convert files from HDF4 format to HDF5 format and vice versa.
to compile an HDF5 program. It takes care of specifying where the
HDF5 header files and libraries are on the command line.
<p>
<code>h5c++</code> supercedes all other compiler scripts in that
<code>h5c++</code> supersedes all other compiler scripts in that
if you've used one set of compiler scripts to compile the
HDF5 C++ library, then <code>h5c++</code> uses those same scripts.
For example, when compiling an MPIch program,
@@ -2290,7 +2331,7 @@ And in this document, the
Describes HDF5 Release 1.6.0, July 2003
</address><!-- #EndLibraryItem -->
Last modified: 2 July 2003
Last modified: 16 July 2003
</body>
</html>