Files
hdf5/develop/_view_tools_command.html
T
2026-08-15 00:48:45 +00:00

203 lines
13 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.16.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>HDF5: Command-line Tools</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="hdf5doxy.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="hdf5doxy.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="hdf5_navtree_hacks.js"></script>
<div style="background:#FFDDDD;font-size:120%;text-align:center;margin:0;padding:5px">Help us improve by taking our short survey: <a href="https://www.hdfgroup.org/website-survey/">https://www.hdfgroup.org/website-survey/</a></div>
<!-- ... other metadata & script includes ... -->
<script type="text/javascript" src="doxygen-awesome-tabs.js"></script>
<script type="text/javascript">
DoxygenAwesomeTabs.init()
</script>
<!-- Google tag (gtag.js) -->
<script async src="https://www.googletagmanager.com/gtag/js?id=G-57FMZK4S7X"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'G-57FMZK4S7X');
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectlogo"><img alt="Logo" src="HDFG-logo.png"/></td>
<td id="projectalign">
<div id="projectname">HDF5<span id="projectnumber">&#160;Last Updated on 2026-08-15</span>
</div>
<div id="projectbrief">The HDF5 Field Guide</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.16.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</script>
<div id="main-nav">
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="_getting_started.html"><span>Getting&#160;started</span></a></li>
<li><a href="_u_g.html"><span>User&#160;Guide</span></a></li>
<li><a href="_r_m.html"><span>Reference&#160;Manual</span></a></li>
<li><a href="_cookbook.html"><span>Cookbook</span></a></li>
<li><a href="_t_n.html"><span>Technical&#160;Notes</span></a></li>
<li><a href="_r_f_c.html"><span>RFCs</span></a></li>
<li><a href="_s_p_e_c.html"><span>Specifications</span></a></li>
<li><a href="_g_l_s.html"><span>Glossary</span></a></li>
<li><a href="_f_t_s.html"><span>Full-Text&#160;Search</span></a></li>
<li><a href="_about.html"><span>About</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<span id="MSearchSelect" class="search-icon" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()"><span class="search-icon-dropdown"></span></span>
<input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><div id="MSearchCloseImg" class="close-icon"></div></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- main-nav -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('_view_tools_command.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">Command-line Tools </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> </p><hr />
<h1 class="doxsection"><a class="anchor" id="secViewToolsCommandObtain"></a>
Obtain Tools and Files (Optional)</h1>
<p>Pre-built binaries for Linux and Windows are distributed within the respective HDF5 binary release packages, which can be obtained from the <a href="https://support.hdfgroup.org/releases/hdf5/downloads/latest/index.html">Download HDF5</a> page.</p>
<p>HDF5 files can be obtained from various places such as <a class="el" href="_h_d_f5_examples.html" title="HDF5 Examples">HDF5 Examples</a> and <a href="http://www.hdfeos.org/">HDF-EOS and Tools and Information Center</a>. Specifically, the following examples are used in this tutorial topic: </p><ul>
<li>HDF5 Files created from compiling the <a class="el" href="_l_b_examples.html" title="Examples from Learning the Basics">Examples from Learning the Basics</a> </li>
<li>HDF5 Files on the <a class="el" href="_ex_a_p_i.html" title="Examples by API">Examples by API</a> page </li>
<li>NPP JPSS files, <a href="https://support.hdfgroup.org/archive/support/ftp/HDF5/examples/files/tutorial/SVM01_npp_d20130524_t1255132_e1256374_b08146_c20130524192048864992_noaa_ops.h5.gz">SVM01_npp.. (gzipped)</a> and <a href="https://support.hdfgroup.org/archive/support/ftp/HDF5/examples/files/tutorial/SVM09_npp_d20120229_t0849107_e0854511_b01759_c20120229145452682127_noaa_ops.h5.gz">SVM09_npp.. (gzipped)</a> </li>
<li>HDF-EOS <a href="https://support.hdfgroup.org/archive/support/ftp/HDF5/examples/files/tutorial/OMI-Aura.he5">OMI-Aura file</a></li>
</ul>
<h1 class="doxsection"><a class="anchor" id="secViewToolsCommandTutor"></a>
Tutorial Topics</h1>
<p>A variety of command-line tools are included in the HDF5 binary distribution. There are tools to view, edit, convert and compare HDF5 files. This tutorial discusses the tools by their functionality. It does not cover all of the HDF5 tools.</p>
<table class="doxtable">
<tr>
<th>Tool Category</th><th>Topic</th><th>Tools Used</th></tr>
<tr>
<td><b><a class="el" href="_view_tools_view.html" title="Command-line Tools For Viewing HDF5 Files">Command-line Tools For Viewing HDF5 Files</a></b></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewContent" title="File Content and Structure">File Content and Structure</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> and <a class="el" href="_h5_t_o_o_l__l_s__u_g.html#sec_cltools_h5ls" title="h5ls">h5ls</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewDset" title="Datasets and Dataset Properties">Datasets and Dataset Properties</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> and <a class="el" href="_h5_t_o_o_l__l_s__u_g.html#sec_cltools_h5ls" title="h5ls">h5ls</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewGrps" title="Groups">Groups</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> and <a class="el" href="_h5_t_o_o_l__l_s__u_g.html#sec_cltools_h5ls" title="h5ls">h5ls</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewAttr" title="Attributes">Attributes</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewSub" title="Dataset Subset">Dataset Subset</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_view.html#secViewToolsViewDtypes" title="Datatypes">Datatypes</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> </td></tr>
<tr>
<td><a class="el" href="_view_tools_edit.html" title="Command-line Tools For Editing HDF5 Files">Command-line Tools For Editing HDF5 Files</a></td><td><a class="el" href="_view_tools_edit.html#secViewToolsEditRemove" title="Remove Inaccessible Objects and Unused Space in a File">Remove Inaccessible Objects and Unused Space in a File</a></td><td><a class="el" href="_h5_t_o_o_l__r_p__u_g.html#sec_cltools_h5repack" title="h5repack">h5repack</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_edit.html#secViewToolsEditChange" title="Change a Dataset&#39;s Storage Layout">Change a Dataset's Storage Layout</a></td><td><a class="el" href="_h5_t_o_o_l__r_p__u_g.html#sec_cltools_h5repack" title="h5repack">h5repack</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_edit.html#secViewToolsEditApply" title="Apply Compression Filter to a Dataset">Apply Compression Filter to a Dataset</a></td><td><a class="el" href="_h5_t_o_o_l__r_p__u_g.html#sec_cltools_h5repack" title="h5repack">h5repack</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_edit.html#secViewToolsEditCopy" title="Copy Objects to Another File">Copy Objects to Another File</a></td><td><a class="el" href="_h5_t_o_o_l__c_p__u_g.html#sec_cltools_h5copy" title="h5copy">h5copy</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_edit.html#secViewToolsEditAdd" title="Add or Remove User Block from File">Add or Remove User Block from File</a></td><td><a class="el" href="_h5_t_o_o_l__j_a_m__u_g.html#sec_cltools_h5jam" title="h5jam">h5jam</a> and <a class="el" href="_h5_t_o_o_l__j_a_m__u_g.html#sec_cltools_h5unjam" title="h5unjam">h5unjam</a> </td></tr>
<tr>
<td><a class="el" href="_view_tools_convert.html" title="Command-line Tools For Converting HDF5 Files">Command-line Tools For Converting HDF5 Files</a></td><td><a class="el" href="_view_tools_convert.html#secViewToolsConvertASCII" title="Output HDF5 Dataset into an ASCII File (to Import into Excel and Other Applications)">Output HDF5 Dataset into an ASCII File (to Import into Excel and Other Applications)</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_convert.html#secViewToolsConvertBinary" title="Output HDF5 Dataset into Binary File">Output HDF5 Dataset into Binary File</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> </td></tr>
<tr>
<td></td><td><a class="el" href="_view_tools_convert.html#secViewToolsConvertExport" title="Export from h5dump and Import into HDF5">Export from h5dump and Import into HDF5</a></td><td><a class="el" href="_h5_t_o_o_l__d_p__u_g.html#sec_cltools_h5dump" title="h5dump">h5dump</a> and <a class="el" href="_h5_t_o_o_l__i_m__u_g.html#sec_cltools_h5import" title="h5import">h5import</a> </td></tr>
</table>
<hr />
<p> Navigate back: <a class="el" href="index.html" title="notitle">Main</a> / <a class="el" href="_getting_started.html" title="Getting Started with HDF5">Getting Started with HDF5</a> </p>
</div></div><!-- contents -->
</div><!-- PageDoc -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
</ul>
</div>
</body>
</html>