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 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
|
<html>
<head><title>
HDF5/Tools API Specification
</title>
</html><!-- #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://www.hdfgroup.org/HDF5/doc/Copyright.html. If you do not have *
* access to either file, you may request a copy from help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
-->
<!-- #EndLibraryItem --><html></head>
<body bgcolor="#FFFFFF">
<!-- #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> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <br>
<a href="../UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>
<a href="../HL/RM_H5IM.html">H5IM</a>
<a href="../HL/RM_H5LT.html">H5LT</a>
<a href="../HL/RM_H5PT.html">H5PT</a>
<a href="../HL/RM_H5TB.html">H5TB</a>
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5L.html">H5L</a>
<a href="RM_H5O.html">H5O</a>
<a href="RM_H5P.html">H5P</a>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<br>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
<a href="../fortran/index.html">Fortran</a>
<a href="APICompatMacros.html">Compatibility Macros</a>
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>
-->
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><center>
<h1>HDF5 Tools</h1>
</center>
<!-- HEADER RIGHT "HDF5 Tools" -->
<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> and
<a href="#Tools-Diff">ph5diff</a> --
Compare two HDF5 files and report the differences.
<li><a href="#Tools-Repack">h5repack</a> --
Copies an HDF5 file to a new file
with or without compression and/or chunking.
<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.
<li><a href="#Tools-Copy">h5copy</a> --
Copies HDF5 objects from a file to a new file
<li><a href="#Tools-MkGrp">h5mkgrp</a> --
Creates a new HDF5 group in a file
<li><a href="#Tools-Stat">h5stat</a> --
Reports statistics regarding an HDF5 file
and the objects in the file.
<li><a href="#Tools-Perf">h5perf</a> --
Measures Parallel HDF5 performance.
<li><a href="#Tools-PerfSerial">h5perf_serial</a> --
Measures HDF5 serial performance.
<br><br>
</ul>
<li>User utilities distributed separately:
<ul>
<li><a href="http://www.hdfgroup.org/ftp/HDF5/special_tools/h5check/src/unpacked/doc/h5check.pdf"">h5check</a> --
Verifies that an HDF5 file is validly encoded.
<br>
<em>(Distributed separately; see
<a href="http://www.hdfgroup.org/products/hdf5_tools/h5check.html">
<code>http://www.hdfgroup.org/products/hdf5_tools/h5check.html</code></a>.)
</em>
<li><a href="http://www.hdfgroup.org/projects/jpss/documentation/h5edit/h5edit.htm"">h5edit</a> --
Edits HDF5 files.
<br>
<em>(Distributed separately; see
<a href="http://www.hdfgroup.org/projects/jpss/h5edit_index.html">
<code>http://www.hdfgroup.org/projects/jpss/h5edit_index.html</code></a>.)
</em>
<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/products/java/hdf-java-html/"
target="ToolsExt">HDF Java Products</a>
for viewing, manipulating, and generating HDF4 and HDF5 files:
<br>
<em>(Distributed separately; see
<code>http://www.hdfgroup.org/products/java/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>
<!-- NEW PAGE -->
<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="http://www.hdfgroup.org/ftp/HDF5/tools/h4toh5/src/unpacked/doc/h4toh5lib_RM.html">h5toh4</a> --
Converts an HDF5 file to an HDF4 file.
<li><a href="http://www.hdfgroup.org/ftp/HDF5/tools/h4toh5/src/unpacked/doc/h4toh5lib_RM.html">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>
-->
<!-- --- --- --- --- --- --- --- --- --- --- --- -->
<!-- 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/h5jam_and_h5unjam.htm"); ?>
<?php include("Tools/h5copy.htm"); ?>
<?php include("Tools/h5mkgrp.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/h5stat.htm"); ?>
<?php include("Tools/h5check.htm"); ?>
<?php include("Tools/h5perf.htm"); ?>
<?php include("Tools/h5perf_serial.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> <br>
<a href="../H5.intro.html">Introduction to HDF5</a> <br>
<a href="../UG/index.html">HDF5 User Guide</a> <br>
<!--
<a href="Glossary.html">Glossary</a><br>
-->
</td>
<td valign=top align=right>
In the
<a href="RM_H5Front.html">HDF5 Reference Manual</a>
<font size="-1"><br>
<a href="../HL/RM_H5DS.html">H5DS</a>
<a href="../HL/RM_H5IM.html">H5IM</a>
<a href="../HL/RM_H5LT.html">H5LT</a>
<a href="../HL/RM_H5PT.html">H5PT</a>
<a href="../HL/RM_H5TB.html">H5TB</a>
<a href="../HL/RM_HDF5Optimized.html">Optimized</a>
<br>
<a href="RM_H5.html">H5</a>
<a href="RM_H5A.html">H5A</a>
<a href="RM_H5D.html">H5D</a>
<a href="RM_H5E.html">H5E</a>
<a href="RM_H5F.html">H5F</a>
<a href="RM_H5G.html">H5G</a>
<a href="RM_H5I.html">H5I</a>
<br>
<a href="RM_H5L.html">H5L</a>
<a href="RM_H5O.html">H5O</a>
<a href="RM_H5P.html">H5P</a>
<a href="RM_H5R.html">H5R</a>
<a href="RM_H5S.html">H5S</a>
<a href="RM_H5T.html">H5T</a>
<a href="RM_H5Z.html">H5Z</a>
<br>
<a href="Tools.html">Tools</a>
<a href="PredefDTypes.html">Datatypes</a>
<a href="../fortran/index.html">Fortran</a>
<a href="APICompatMacros.html">Compatibility Macros</a>
<br>
<a href="CollectiveCalls.html">Collective Calls in Parallel</a>
</font>
<!--
<br>
<i><font size=-1>(Printable <a href="http://hdfgroup.org/HDF5/doc/PSandPDF/HDF5_RefManual.PDF">PDF</a> of this Reference Manual)</font></i>
-->
</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><!-- #BeginLibraryItem "/ed_libs/Footer.lbi" -->
<address>
<table width="100%" border="0">
<tr valign="top">
<td align="left">
<address>
The HDF Group Help Desk: <img src="../Graphics/help.png" align=top height=16>
<br>
Describes HDF5 Release 1.8.13, May 2014.
</address>
</td><td width="5%"> </td>
<td align="right">
<a href="../Copyright.html">Copyright</a> by
<a href="http://www.hdfgroup.org">The HDF Group</a>
<br>
and the Board of Trustees of the University of Illinois
</td>
</tr>
</table>
</address>
<!-- #EndLibraryItem --><dl>
<dt><dt><SCRIPT LANGUAGE="JAVASCRIPT">
<!--
document.writeln("Last modified: 23 October 2013");
-->
</SCRIPT>
</body>
</html>
|