summaryrefslogtreecommitdiffstats
path: root/doxygen/dox/UsersGuide.dox
blob: 22fe5c66718282c4d42fa6aa8d8cccc7d9d9f3c9 (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
/** \page UG HDF5 User’s Guide

<center>
HDF5 Release 1.10

\image html HDFG-logo.png "The HDF Group"

</center>

\section sec_data_model The HDF5 Data Model and File Structure
    - <!-- @ref subsec_data_model_intro --> Introduction
    - <!-- @ref subsec_data_model_abstract --> The Abstract Data Model
    - <!-- @ref subsec_data_model_storage --> The HDF5 Storage Model
    - <!-- @ref subsec_data_model_structure --> The Structure of an HDF5 File

\section sec_program The HDF5 Library and Programming Model
    - <!-- @ref subsec_program_intro --> Introduction
    - <!-- @ref subsec_program_model --> The HDF5 Programming Model
    - <!-- @ref subsec_program_transfer_pipeline --> The Data Transfer Pipeline

\section sec_file The HDF5 File
    - <!-- @ref subsec_file_intro --> Introduction
    - <!-- @ref subsec_file_access_modes --> File Access Modes
    - <!-- @ref subsec_file_creation_access --> File Creation and File Access Properties
    - <!-- @ref subsec_file_drivers --> Low-level File Drivers
    - <!-- @ref subsec_file_program_model --> "Programming Model for Files
    - <!-- @ref subsec_file_h5dump --> Using h5dump to View a File
    - <!-- @ref subsec_file_summary --> File Function Summaries
    - <!-- @ref subsec_file_create --> Creating or Opening an HDF5 File
    - <!-- @ref subsec_file_closes --> Closing an HDF5 File
    - <!-- @ref subsec_file_property_lists --> File Property Lists
    - <!-- @ref subsec_file_alternate_drivers --> Alternate File Storage Layouts and Low-level File Drivers
    - <!-- @ref subsec_file_examples --> Code Examples for Opening and Closing Files
    - <!-- @ref subsec_file_multiple --> Working with Multiple HDF5 Files

\section sec_group HDF5 Groups
    - <!-- @ref subsec_group_intro --> Introduction
    - <!-- @ref subsec_group_descr --> Description of the Group Object
    - <!-- @ref subsec_group_h5dump --> Using h5dump
    - <!-- @ref subsec_group_function --> Group Function Summaries
    - <!-- @ref subsec_group_program --> Programming Model for Groups
    - <!-- @ref subsec_group_examples --> Examples of File Structures

\section sec_dataset HDF5 Datasets
    - <!-- @ref subsec_dataset_intro --> Introduction
    - <!-- @ref subsec_dataset_function --> Dataset Function Summaries
    - <!-- @ref subsec_dataset_program --> Programming Model for Datasets
    - <!-- @ref subsec_dataset_transfer --> Data Transfer
    - <!-- @ref subsec_dataset_allocation --> Allocation of Space in the File
    - <!-- @ref subsec_dataset_filters --> Using HDF5 Filters

\section sec_datatype HDF5 Datatypes

\section sec_dataspace HDF5 Dataspaces and Partial I/O

\ref sec_attribute
\li \ref subsec_attribute_intro
\li \ref subsec_attribute_program
    <ul>
        <li> <!-- @ref subsubsec_attribute_program_exist --> To Open and Read or Write an Existing Attribute
    </ul>
\li \ref subsec_error_H5A
\li \ref subsec_attribute_work
    <ul>
        <li> \ref subsubsec_attribute_work_struct
        <li> \ref subsubsec_attribute_work_create
        <li> \ref subsubsec_attribute_work_access
        <li> \ref subsubsec_attribute_work_info
        <li> \ref subsubsec_attribute_work_iterate
        <li> \ref subsubsec_attribute_work_delete
        <li> \ref subsubsec_attribute_work_close
    </ul>
\li \ref subsec_attribute_special

\ref sec_error
\li \ref subsec_error_intro
\li \ref subsec_error_program
\li \ref subsec_error_H5E
\li \ref subsec_error_ops
    <ul>
        <li> \ref subsubsec_error_ops_stack
        <li> \ref subsubsec_error_ops_print
        <li> \ref subsubsec_error_ops_mute
        <li> \ref subsubsec_error_ops_custom_print
        <li> \ref subsubsec_error_ops_walk
        <li> \ref subsubsec_error_ops_travers
    </ul>
\li \ref subsec_error_adv
    <ul>
        <li> \ref subsubsec_error_adv_more
        <li> \ref subsubsec_error_adv_app
    </ul>

\section sec_plist Properties and Property Lists in HDF5

\section sec_addition Additional Resources

<!-- 
<table>
<tr><td style="border: none;">
\li \ref H5A "Attributes (H5A)"
\li \ref H5D "Datasets (H5D)"
\li \ref H5S "Dataspaces (H5S)"
\li \ref H5T "Datatypes (H5T)"
\li \ref H5E "Error Handling (H5E)"
\li \ref H5F "Files (H5F)"
\li \ref H5Z "Filters (H5Z)"
\li \ref H5G "Groups (H5G)"
</td><td style="border: none;">
\li \ref H5I "Identifiers (H5I)"
\li \ref H5 "Library General (H5)"
\li \ref H5L "Links (H5L)"
\li \ref H5O "Objects (H5O)"
\li \ref H5P "Property Lists (H5P)"
\li \ref H5PL "Dynamically-loaded Plugins (H5PL)"
\li \ref H5R "References (H5R)"
</td><td style="border: none;vertical-align: top;">
\li \ref api-compat-macros
\li <a href="./deprecated.html">Deprecated functions</a>
\li High-level Extensions
    <ul>
    <li><a href="https://portal.hdfgroup.org/display/HDF5/Lite">\Bold{HDF5 Lite} (H5LT)</a></li>
    <li><a href="https://portal.hdfgroup.org/display/HDF5/Images">\Bold{HDF5 Image} (H5IM)</a></li>
    <li><a href="https://portal.hdfgroup.org/display/HDF5/Tables">\Bold{HDF5 Table} (H5TB)</a></li>
    <li><a href="https://portal.hdfgroup.org/display/HDF5/Packet+Tables">\Bold{HDF5 Packet Table} (H5TB)</a></li>
    <li><a href="https://portal.hdfgroup.org/display/HDF5/Dimension+Scales">\Bold{HDF5 Dimension Scale} (H5DS)</a></li>
    </ul>
</td></tr>
<tr><td colspan="3" style="border: none;">
\ref H5 \ref H5A \ref H5D \ref H5E \ref H5F \ref H5G \ref H5I \ref H5L
\ref H5O \ref H5P \ref H5PL \ref H5R \ref H5S \ref H5T \ref H5Z
</td></tr>
</table>

</td></tr>
</table>
 -->

\par Don't like what you see? - You can help to improve this User’s Guide
     Complete the survey linked near the top of this page!\n
     We treat documentation like code: Fork the
     <a href="https://github.com/HDFGroup/hdf5">HDF5 repo</a>, make changes, and create a
     <a href="https://github.com/HDFGroup/hdf5/pulls">pull request</a> !\n

*/