summaryrefslogtreecommitdiffstats
path: root/doc/html/Tools.html
blob: e5f96dc6d0efdf559b361836c646081872fbebc3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
<html>
<head><title>
HDF5/Tools API Specification
</title>

<!-- #BeginLibraryItem "/ed_libs/styles_RM.lbi" -->

<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * Copyright by The HDF Group.                                               *
  * Copyright by the Board of Trustees of the University of Illinois.         *
  * All rights reserved.                                                      *
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
  * the files COPYING and Copyright.html.  COPYING can be found at the root   *
  * of the source code distribution tree; Copyright.html can be found at the  *
  * root level of an installed copy of the electronic HDF5 document set and   *
  * is linked from the top-level documents page.  It can also be found at     *
  * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
  * access to either file, you may request a copy from help@hdfgroup.org.     *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->

<link href="ed_styles/RMelect.css" rel="stylesheet" type="text/css">
<!-- #EndLibraryItem --></head>

<body bgcolor="#FFFFFF">
<!-- HEADER RIGHT " " -->

<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->

<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="http://www.hdfgroup.org/HDF5/doc1.6/UG/UG_frame.html">HDF5 User Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the 
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;&nbsp;<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;<br>
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<a href="PredefDTypes.html">Datatypes</a>&nbsp;&nbsp;
</td></tr>
<tr><td colspan="2" align="right">
<i><small>(<a href="http://www.hdfgroup.org/HDF5/doc1.6/PSandPDF/">PDF</a>
of complete manual formatted as print volume)&nbsp;&nbsp;&nbsp;</small></i>
</td></tr>
</table>
</center>
<hr>


<!-- #EndLibraryItem --><center>
<h1>HDF5 Tools</h1>
</center>




<h2>HDF5 Tool Interfaces</h2>
<p>

HDF5-related tools are available to assist the user in a variety of 
activities, including 
   examining or managing HDF5 files, 
   converting raw data between HDF5 and other special-purpose formats,
   moving data and files between the HDF4 and  HDF5 formats, 
   measuring HDF5 library performance, and
   managing HDF5 library and application compilation, 
      installation and configuration.
Unless otherwise specified below, these tools are distributed and 
installed with HDF5.

<!--
<table border=0>
<tr><td valign=top>
-->
<ul>
    <li>User utilities: 
    <ul>
        <li><a href="#Tools-Dump">h5dump</a> -- 
            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> -- 
            Lists specified features of HDF5 file contents
        <li><a href="#Tools-Diff">h5diff</a> -- 
            Compares two HDF5 files and reports the differences.
        <li><a href="#Tools-Repack">h5repack</a> -- Copies an HDF5 file to a new
          file with or without compression/chunking.
        <li><a href="#Tools-Perf">h5perf</a> -- 
            Measures HDF5 performance
        <li><a href="#Tools-Repart">h5repart</a> -- 
            Repartitions a file, creating a family of files
        <li><a href="#Tools-Jam">h5jam</a> -- 
            Adds a user block to the front of an HDF5 file 
        <li><a href="#Tools-Jam">h5unjam</a> -- 
            Splits an existing user block from an HDF5 file,
            placing it in a separate file
    <br><br>
    </ul>

    <li>Configuration and  library management utilities: 
    <ul>
        <li><a href="#Tools-Redeploy">h5redeploy</a> -- 
            Updates HDF5 compiler tools after an HDF5 software installation 
            in a new location  
         <li><a href="#Tools-H5CC">h5cc</a> and
            <a href="#Tools-H5CC">h5pcc</a> --
            Simplify the compilation of HDF5 programs written in C
         <li><a href="#Tools-H5FC">h5fc</a> and
            <a href="#Tools-H5FC">h5pfc</a> --
            Simplify the compilation of HDF5 programs written in Fortran90
        <li><a href="#Tools-H5C++">h5c++</a> --
            Simplifies the compilation of HDF5 programs written in C++
    <br><br>
    </ul>
 
    <li><a href="http://www.hdfgroup.org/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://www.hdfgroup.org/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://www.hdfgroup.org/h4toh5/" target="ToolsExt">
        HDF5/HDF4 conversion tools</a>:
        <br>
        <em>(Distributed separately; external link is 
	<code>http://www.hdfgroup.org/h4toh5/</code>)</em>
    <ul>
        <li><a href="http://www.hdfgroup.org/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://www.hdfgroup.org/tools5.html" 
        target="ToolsExt">Other tools</a>, 
	including third-party and commercial utilities and applications
        <br>
        <em>(Distributed separately; external link is 
	<code>http://www.hdfgroup.org/tools5.html</code>)</em>

</ul>
<!--
</td></tr>
</table>
-->

<!-- NEW PAGE -->

<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->
<!--       Include special topic files                       -->
<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->


<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->
<!--       Include function files                            -->
<!--  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  ---  -->

<?php include("Tools/h5dump.htm"); ?>
<?php include("Tools/h5ls.htm"); ?>
<?php include("Tools/h5diff.htm"); ?>
<?php include("Tools/h5repack.htm"); ?>
<?php include("Tools/h5repart.htm"); ?>
<?php include("Tools/h5import.htm"); ?>
<?php include("Tools/gif2h5.htm"); ?>
<?php include("Tools/h52gif.htm"); ?>
<?php include("Tools/h5toh4.htm"); ?>
<?php include("Tools/h4toh5.htm"); ?>
<?php include("Tools/h5perf.htm"); ?>
<?php include("Tools/h5jam_and_h5unjam.htm"); ?>
<?php include("Tools/h5redeploy.htm"); ?>
<?php include("Tools/h5cc_and_h5pcc.htm"); ?>
<?php include("Tools/h5fc_and_h5pfc.htm"); ?>
<?php include("Tools/h5c++.htm"); ?>


<!-- HEADER RIGHT " " -->
<!-- #BeginLibraryItem "/ed_libs/NavBar_RM.lbi" -->

<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
<a href="index.html">HDF5 documents and links</a>&nbsp;<br>
<a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
<a href="http://www.hdfgroup.org/HDF5/doc1.6/UG/UG_frame.html">HDF5 User Guide</a>&nbsp;<br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
And in this document, the 
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;&nbsp;<br>
<a href="RM_H5.html">H5</a>&nbsp;&nbsp;
<a href="RM_H5A.html">H5A</a>&nbsp;&nbsp;
<a href="RM_H5D.html">H5D</a>&nbsp;&nbsp;
<a href="RM_H5E.html">H5E</a>&nbsp;&nbsp;
<a href="RM_H5F.html">H5F</a>&nbsp;&nbsp;
<a href="RM_H5G.html">H5G</a>&nbsp;&nbsp;
<a href="RM_H5I.html">H5I</a>&nbsp;&nbsp;
<a href="RM_H5P.html">H5P</a>&nbsp;&nbsp;<br>
<a href="RM_H5R.html">H5R</a>&nbsp;&nbsp;
<a href="RM_H5S.html">H5S</a>&nbsp;&nbsp;
<a href="RM_H5T.html">H5T</a>&nbsp;&nbsp;
<a href="RM_H5Z.html">H5Z</a>&nbsp;&nbsp;
<a href="Tools.html">Tools</a>&nbsp;&nbsp;
<a href="PredefDTypes.html">Datatypes</a>&nbsp;&nbsp;
</td></tr>
<tr><td colspan="2" align="right">
<i><small>(<a href="http://www.hdfgroup.org/HDF5/doc1.6/PSandPDF/">PDF</a>
of complete manual formatted as print volume)&nbsp;&nbsp;&nbsp;</small></i>
</td></tr>
</table>
</center>
<hr>


<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" -->

<address>
The HDF Group Help Desk: <img src="Graphics/help.png" align=top height=16>
<br>
Describes HDF5 Release 1.6.10, November 2009 
</address>


<!-- #EndLibraryItem -->&nbsp;<br>
<SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 25 April 2009");
-->
</SCRIPT>

</body>
</html>