82fb21b613
been checked into "HDF5 Development" branch. General ======= Various "copy edit" types of repairs. Revisions to document cross-linking. Added structural links tying all docs together (banners at top and bottom of documents, similar to Reference Manual banners of the Beta release). Set background color to white in all documents. NCSAfooterlogo.gif hdf2.jpg New image files to make the documents more self-contained (i.e., to prevent loading images from NCSA and HDF home servers). index.html Redesigned to isolate links external to the installation in a single location. Intro to HDF5 ============= H5.intro.html Fixed banner linking Intro to other docs. Set all URLs to be relative within the distribution; nothing points back to the HDF server. Updates to "Limits of the Current Release" and "Changes in the Current Release." HDF5 User's Guide ================= Changed several User Guide section titles such that all sections that are primarily about a particular interface are now titled in the format "The xxxxx Interface (H5x)". H5.user.html Commented out links to developer docs since they are marked in MANIFEST as not being for distribution in the release. Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. Datatypes.html Removed the sentence "I'm deferring definition until later since they're probably not as important as the other data types." from Section 3.3, "Properties of Date and Time Atomic Types." Added info regarding 'char' versus 'string' datatypes. Added as Section 3.7, "Character and String Datatype Issues." References.html Commented out substantial material (at end of document) from References planning document that is not appropriate for the User Guide but that is worth keeping around. Groups.html Final edits from elimination of "current working group." HDF5 Reference Manual ===================== Removed "Draft" from the <title>__</title> lines. RM_H5Front.html Removed 2nd and 3rd indices from page. Changed "freeform" lists of sections (TOCs) to aligned tables. RM_H5F.html RM_H5P.html Add file mounting information.
269 lines
9.5 KiB
HTML
269 lines
9.5 KiB
HTML
<html>
|
|
<head>
|
|
<title>
|
|
HDF5 User's Guide
|
|
</title>
|
|
</head>
|
|
|
|
<body bgcolor="#FFFFFF">
|
|
|
|
|
|
<hr>
|
|
<center>
|
|
<table border=0 width=98%>
|
|
<tr><td valign=top align=left>
|
|
<a href="H5.intro.html">Introduction to HDF5</a> <br>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br>
|
|
<a href="index.html">Other HDF5 documents and links</a> <br>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a><br>
|
|
-->
|
|
</td>
|
|
<td valign=top align=right>
|
|
|
|
<!--
|
|
|
|
And in this document, the
|
|
HDF5 User's Guide:
|
|
<a href="Files.html">Files</a>
|
|
<br>
|
|
<a href="Datasets.html">Datasets</a>
|
|
<a href="Datatypes.html">Data Types</a>
|
|
<a href="Dataspaces.html">Dataspaces</a>
|
|
<a href="Groups.html">Groups</a>
|
|
<a href="References.html">References</a>
|
|
<br>
|
|
<a href="Attributes.html">Attributes</a>
|
|
<a href="Properties.html">Property Lists</a>
|
|
<a href="Errors.html">Error Handling</a>
|
|
<a href="Filters.html">Filters</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<br>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
<a href="Ragged.html">Ragged Arrays</a>
|
|
-->
|
|
<!--
|
|
<hr>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Attributes.html">H5A</a>
|
|
<a href="Datasets.html">H5D</a>
|
|
<a href="Errors.html">H5E</a>
|
|
<a href="Files.html">H5F</a>
|
|
<a href="Groups.html">H5G</a>
|
|
<a href="Properties.html">H5P</a>
|
|
<a href="References.html">H5R & H5I</a>
|
|
<a href="Ragged.html">H5RA</a>
|
|
<a href="Dataspaces.html">H5S</a>
|
|
<a href="Datatypes.html">H5T</a>
|
|
<a href="Filters.html">H5Z</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
-->
|
|
</td></tr>
|
|
</table>
|
|
</center>
|
|
<hr>
|
|
|
|
|
|
<center><h1>A User's Guide for HDF5</h1></center>
|
|
|
|
<p>The following documents form a loosely organized user's guide
|
|
to the HDF5 library.
|
|
|
|
<center>
|
|
<table border=0>
|
|
|
|
<tr><td valign=top><a href="Files.html">HDF5 Files</a>
|
|
</td><td> </td>
|
|
<td valign=top>A guide to the <strong>H5F</strong> interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Datasets.html">Datasets</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5D</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Datatypes.html">Data Types</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5T</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Dataspaces.html">Dataspaces</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5S</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Groups.html">Groups</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5G</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="References.html">References and
|
|
Identifiers</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5R</strong>
|
|
and <strong>H5I</strong> interfaces.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Attributes.html">Attributes</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5A</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Properties.html">Property Lists</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5P</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Errors.html">Error Handling</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5E</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Filters.html">Filters</a>
|
|
</td><td></td><td valign=top>A guide to the <strong>H5Z</strong>
|
|
interface.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Caching.html">Caching</a>
|
|
</td><td></td><td valign=top>A guide for meta and raw data caching.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Chunking.html">Dataset Chunking</a>
|
|
</td><td></td><td valign=top>A guide to the issues and pitfalls
|
|
of dataset chunking.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Debugging.html">Debugging</a>
|
|
</td><td></td><td valign=top>A guide to debugging HDF5 API calls.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="Environment.html">Environment Variables
|
|
and</a>
|
|
<br> <a href="Environment.html">Configuration
|
|
Parameters</a>
|
|
</td><td></td><td valign=top>A list of HDF5 environment variables
|
|
and <br> configuration parameters.
|
|
</td></tr>
|
|
<tr><td valign=top><a href="ddl.html">DDL for HDF5</a>
|
|
</td><td></td><td valign=top>A DDL in BNF for HDF5.
|
|
</td></tr>
|
|
<tr><td valign=top><hr noshade size=1><a href="Ragged.html">Ragged Arrays</a>
|
|
</td><td></td><td valign=top><hr noshade size=1>A guide to the
|
|
<strong>H5RA</strong> interface.
|
|
<em><font color=red>(Experimental)</font></em>
|
|
</td></tr>
|
|
</table>
|
|
</center>
|
|
|
|
<!--
|
|
<p>The following documents form a loosely organized developer's guide to
|
|
aspects of the HDF5 library. (Some of the following documents
|
|
may be rather out of date as they were working papers for design
|
|
goals.)
|
|
|
|
<ul>
|
|
<li><a href="Version.html">Version Numbers</a> -
|
|
A description of HDF5 version numbers.
|
|
<li><a href="IOPipe.html">I/O Pipeline</a> -
|
|
A description of the raw data I/O pipeline.
|
|
<li><a href="ExternalFiles.html">Working with External Files</a> -
|
|
A guide to the use of multiple files with HDF5.
|
|
<li><a href="Big.html">Large Datasets</a> -
|
|
A guide to accessing large datasets on small computers.
|
|
<li><a href="MemoryManagement.html">Memory Management</a> -
|
|
A white paper about memory management issues in HDF5.
|
|
<li><a href="Coding.html">Coding Style</a> -
|
|
A white paper about coding style in the HDF5 library code.
|
|
<li><a href="compat.html">HDF4/HDF5 Compatibility</a> -
|
|
A white paper about compatibility issues between HDF4 and HDF5.
|
|
<li><a href="study.html">Chunking Performance Study</a> -
|
|
A white paper describing the HDF5 chunking performance.
|
|
</ul>
|
|
-->
|
|
|
|
|
|
<hr>
|
|
<center>
|
|
<table border=0 width=98%>
|
|
<tr><td valign=top align=left>
|
|
<a href="H5.intro.html">Introduction to HDF5</a> <br>
|
|
<a href="RM_H5Front.html">HDF5 Reference Manual</a> <br>
|
|
<a href="index.html">Other HDF5 documents and links</a> <br>
|
|
<!--
|
|
<a href="Glossary.html">Glossary</a><br>
|
|
-->
|
|
</td>
|
|
<td valign=top align=right>
|
|
|
|
<!--
|
|
|
|
And in this document, the
|
|
HDF5 User's Guide:
|
|
<a href="Files.html">Files</a>
|
|
<br>
|
|
<a href="Datasets.html">Datasets</a>
|
|
<a href="Datatypes.html">Data Types</a>
|
|
<a href="Dataspaces.html">Dataspaces</a>
|
|
<a href="Groups.html">Groups</a>
|
|
<a href="References.html">References</a>
|
|
<br>
|
|
<a href="Attributes.html">Attributes</a>
|
|
<a href="Properties.html">Property Lists</a>
|
|
<a href="Errors.html">Error Handling</a>
|
|
<a href="Filters.html">Filters</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<br>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
<a href="Ragged.html">Ragged Arrays</a>
|
|
-->
|
|
|
|
<!--
|
|
<hr>
|
|
And in this document, the
|
|
<a href="H5.user.html">HDF5 User's Guide</a>:
|
|
<a href="Attributes.html">H5A</a>
|
|
<a href="Datasets.html">H5D</a>
|
|
<a href="Errors.html">H5E</a>
|
|
<a href="Files.html">H5F</a>
|
|
<a href="Groups.html">H5G</a>
|
|
<a href="Properties.html">H5P</a>
|
|
<a href="References.html">H5R & H5I</a>
|
|
<a href="Ragged.html">H5RA</a>
|
|
<a href="Dataspaces.html">H5S</a>
|
|
<a href="Datatypes.html">H5T</a>
|
|
<a href="Filters.html">H5Z</a>
|
|
<a href="Caching.html">Caching</a>
|
|
<a href="Chunking.html">Chunking</a>
|
|
<a href="Debugging.html">Debugging</a>
|
|
<a href="Environment.html">Environment</a>
|
|
<a href="ddl.html">DDL</a>
|
|
-->
|
|
</td></tr>
|
|
</table>
|
|
</center>
|
|
|
|
|
|
<!--
|
|
<hr>
|
|
<address><a href="mailto:koziol@ncsa.uiuc.edu">Quincey Koziol</a></address>
|
|
<address><a href="mailto:matzke@llnl.gov">Robb Matzke</a></address>
|
|
-->
|
|
<!-- hhmts start -->
|
|
<!--
|
|
Last modified: Wed Aug 19 15:29:11 PDT 1998
|
|
-->
|
|
<!-- hhmts end -->
|
|
|
|
<hr>
|
|
<address>
|
|
<table width=100% border=0>
|
|
<tr><td align=left valign=top>
|
|
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
|
|
<br>
|
|
Last modified: 30 October 1998
|
|
|
|
</td><td align=right valign=top>
|
|
<a href="Copyright.html">Copyright</a>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</body>
|
|
</html>
|