summaryrefslogtreecommitdiffstats
path: root/doc/html/TechNotes.html
blob: d6f60ab83c2f8c4705bc21753ed22f36ef2d9068 (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
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
<html>

<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->

<head><title>
HDF5 Technical Notes
</title>

</html><!-- #BeginLibraryItem "/ed_libs/styles_Gen.lbi" -->
<!--
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
  * 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://hdf.ncsa.uiuc.edu/HDF5/doc/Copyright.html.  If you do not have     *
  * access to either file, you may request a copy from hdfhelp@ncsa.uiuc.edu. *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
 -->

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

<body bgcolor="#FFFFFF">


<!-- #BeginLibraryItem "/ed_libs/NavBar_TechN.lbi" --><hr>
<center>
<table cellspacing=0 cellpadding=0 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="Glossary.html">Glossary</a><br>
-->
</td>

<td valign=top align=right>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User's Guide</a>&nbsp;<br>
<a href="ADGuide.html">HDF5 Application Developer's Guide</a>&nbsp;<br>
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>

<!--
And in this document, 
HDF5 Technical Notes&nbsp;&nbsp;
<br>
<a href="TechNotes/FreeLists.html">Memory Management and Free Lists</a>&nbsp;&nbsp;
-->

</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><br>
<br>

<center>
<h1>HDF5 Technical Notes</h1>
<h3>Technical Notes for HDF5 Library and Driver Developers</h3>
</center>


<center>
<table border=0 width=85%>

<tr><td valign=top colspan=3>
    This informal volume of technical notes is of interest to 
    those who develop and maintain the HDF5 library and 
    related, closely-coupled drivers.
    These notes are not generally of interest to applications developers 
    and certainly not of interest to users.
    (Some of these documents may be somewhat out of date as they were 
    working papers for the design process.)
    <br>
    <br>
</td></tr>

<tr><td valign=top width=40%><a href="TechNotes/MemoryMgmt.html">
    Memory Management</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of memory management issues in HDF5
</td></tr>

<tr><td valign=top><a href="TechNotes/FreeLists.html">
    Memory Management and</a>
    <br>&nbsp;&nbsp;&nbsp;&nbsp;
    <a href="TechNotes/FreeLists.html">Free Lists</a>
    </td><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td valign=top>
    Notes regarding the implementation of free lists and memory management
</td></tr>

<tr><td valign=top><a href="TechNotes/HeapMgmt.html">Heap Management</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of the H5H heap management fuctions
</td></tr>

<tr><td valign=top><a href="TechNotes/RawDStorage.html">Raw Data Storage</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of the storage of raw HDF5 data
</td></tr>

<tr><td valign=top><a href="TechNotes/VFL.html">Virtual File Layer</a>
    </td><td>&nbsp;</td><td valign=top>
    A description of the HDF5 virtual file layer (VFL), 
    a public API for the implementation of custom I/O drivers 
</td></tr>

<tr><td valign=top><a href="TechNotes/VFLfunc.html">List of VFL Functions</a>
    </td><td>&nbsp;</td><td valign=top>
    A list of the VFL functions, <code>H5FD*</code>
</td></tr>

<tr><td valign=top><a href="TechNotes/IOPipe.html">I/O Pipeline</a>
    </td><td>&nbsp;</td><td valign=top>
    A description of the raw data I/O pipeline
</td></tr>

<tr><td valign=top><a href="TechNotes/BigDataSmMach.html">
    Large Datasets on Small</a>
    <br>&nbsp;&nbsp;&nbsp;&nbsp;
    <a href="TechNotes/BigDataSmMach.html">Machines</a>
    </td><td>&nbsp;</td><td valign=top>
    A guide to accessing large datasets on small computers
</td></tr>

<tr><td valign=top><a href="TechNotes/MoveDStruct.html">
    Relocating a File Data</a>
    <br>&nbsp;&nbsp;&nbsp;&nbsp;
    <a href="TechNotes/MoveDStruct.html">Structure</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of the issues involved in moving file data structures once 
    they have been cached in memory
</td></tr>

<tr><td valign=top><a href="TechNotes/ExternalFiles.html">
    Working with External Files</a>
    </td><td>&nbsp;</td><td valign=top>
    A guide to the use of multiple files with HDF5
</td></tr>

<tr><td valign=top><a href="TechNotes/ObjectHeader.html">Object Headers</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of the H5O object header functions
</td></tr>

<tr><td valign=top><a href="TechNotes/SymbolTables.html">
    Symbol Table Caching Issues</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of issues involving caching of object header messages in
    symbol table entries
</td></tr>

<tr><td valign=top><a href="TechNotes/H4-H5Compat.html">
    HDF4/HDF5 Compatibility</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of compatibility issues between HDF4 and HDF5
</td></tr>

<tr><td valign=top><a href="TechNotes/ChunkingStudy.html">
    Testing the Chunked Layout</a>
    <br>&nbsp;&nbsp;&nbsp;&nbsp;
    <a href="TechNotes/ChunkingStudy.html">of HDF5</a>
    </td><td>&nbsp;</td><td valign=top>
    A white paper discussing the motivation to implement raw data chunking 
    in the HDF5 library
</td></tr>

<tr><td valign=top><a href="TechNotes/LibMaint.html">Library Maintenance</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of HDF5 library maintenance issues
</td></tr>

<tr><td valign=top><a href="TechNotes/CodeReview.html">Code Review</a>
    </td><td>&nbsp;</td><td valign=top>
    Code Review 1 and 2
</td></tr>

<tr><td valign=top><a href="TechNotes/Version.html">
    Release Version Numbers</a>
    </td><td>&nbsp;</td><td valign=top>
    A description of HDF5 release version numbers
</td></tr>

<tr><td valign=top><a href="TechNotes/NamingScheme.html">Naming Schemes</a>
    </td><td>&nbsp;</td><td valign=top>
    A discussion of naming schemes for HDF5 library modules, functions, 
    datatypes, etc.
</td></tr>

<tr><td valign=top>
<a href="TechNotes/ThreadSafeLibrary.html">Thread Safe HDF5 Library</a>
    <br>&nbsp;&nbsp;&nbsp;&nbsp;
    <a href="TechNotes/ThreadSafeLibrary.html">Implementation</a>
    </td><td>&nbsp;</td><td valign=top>
    A report on the implementation of a thread safe HDF5 library.
</td></tr>

<tr><td valign=top><a href="TechNotes/ReservedFileSpace.html">Reserved File Address Space</a>
    </td><td>&nbsp;</td><td valign=top>
    Description of HDF5's internal system for ensuring that files stay within their address space.
</td></tr>

<tr><td valign=top>
<a href="TechNotes/openmp-hdf5.html">Using HDF5 with OpenMP</a>
    </td><td>&nbsp;</td><td valign=top>
    A short report on using HDF5 with OpenMP.
</td></tr>

<tr><td valign=top><a href="TechNotes/SWControls.html">HDF5 Software Controls</a>
    </td><td>&nbsp;</td><td valign=top>
    Descriptions of the HDF5 knobs and controls, such as the 
    environment variables and settings that control the functionality 
    of the HDF5 libraries and tools.
</td></tr>

<tr><td valign=top><a href="TechNotes/Daily_Test_Explained.htm">Daily Test Explained</a>
    </td><td>&nbsp;</td><td valign=top>
    An explanation of the Daily Testing for HDF software conducted.
</td></tr>

<tr><td valign=top><a href="TechNotes/TestReview.html">Test Review</a>
    </td><td>&nbsp;</td><td valign=top>
    Results of reviewing tests for API functions.
</td></tr>

<tr><td valign=top><a href="TechNotes/Basic_perform.html">Basic Performance Tools</a>
    </td><td>&nbsp;</td><td valign=top>
    A description of the three basic performance tools (chunk, iopipe, overhead).
</td></tr>

</table>
</center>

<br>
<br>


<!-- #BeginLibraryItem "/ed_libs/NavBar_TechN.lbi" --><hr>
<center>
<table cellspacing=0 cellpadding=0 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="Glossary.html">Glossary</a><br>
-->
</td>

<td valign=top align=right>
<a href="http://hdf.ncsa.uiuc.edu/HDF5/doc/UG/index.html">HDF5 User's Guide</a>&nbsp;<br>
<a href="ADGuide.html">HDF5 Application Developer's Guide</a>&nbsp;<br>
<a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>

<!--
And in this document, 
HDF5 Technical Notes&nbsp;&nbsp;
<br>
<a href="TechNotes/FreeLists.html">Memory Management and Free Lists</a>&nbsp;&nbsp;
-->

</td></tr>
</table>
</center>
<hr>
<!-- #EndLibraryItem --><address>
<table width=100% border=0>
<tr><td align=left valign=top> 

<!-- #BeginLibraryItem "/ed_libs/Footer.lbi" -->
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a> 
<br>
Describes HDF5 Release 1.6.5, October 2005
</address>
<!-- #EndLibraryItem -->

Last modified:  25 September 2003

</td>
<td align=right valign=top>
<a href="Copyright.html">Copyright</a>&nbsp;&nbsp;
</td></tr>
</table>


</body>
</html>