summaryrefslogtreecommitdiffstats
path: root/doc/html/Environment.html
blob: 3e2141dc7fe912e41fbd8bb0bbc43c8f84874c7b (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
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
<html>
<<<<<<< Environment.html
<head>
<title>HDF5 Library Environment Variables and Configuration Parameters</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>&nbsp;<br>
   <a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>
   <a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
   <!--
   <a href="Glossary.html">Glossary</a><br>
   -->
</td>
<td valign=top align=right>
   And in this document, the 
   <a href="H5.user.html">HDF5 User's Guide</a>:&nbsp;&nbsp;&nbsp;&nbsp;
      <a href="Files.html">Files</a>&nbsp;&nbsp;
      <br>
      <a href="Datasets.html">Datasets</a>&nbsp;&nbsp;
      <a href="Datatypes.html">Data Types</a>&nbsp;&nbsp;
      <a href="Dataspaces.html">Dataspaces</a>&nbsp;&nbsp;
      <a href="Groups.html">Groups</a>&nbsp;&nbsp;
      <a href="References.html">References</a>&nbsp;&nbsp;
      <br>
      <a href="Attributes.html">Attributes</a>&nbsp;&nbsp;
      <a href="Properties.html">Property Lists</a>&nbsp;&nbsp;
      <a href="Errors.html">Error Handling</a>&nbsp;&nbsp;
      <a href="Filters.html">Filters</a>&nbsp;&nbsp;
      <a href="Caching.html">Caching</a>&nbsp;&nbsp;
      <br>
      <a href="Chunking.html">Chunking</a>&nbsp;&nbsp;
      <a href="Debugging.html">Debugging</a>&nbsp;&nbsp;
      Environment&nbsp;&nbsp;
      <a href="ddl.html">DDL</a>&nbsp;&nbsp;
      <a href="Ragged.html">Ragged Arrays</a>&nbsp;&nbsp;
<!--
<hr>
And in this document, the 
<a href="H5.user.html">HDF5 User's Guide</a>:&nbsp;&nbsp;&nbsp;&nbsp;
      <a href="Attributes.html">H5A</a>&nbsp;&nbsp;
      <a href="Datasets.html">H5D</a>&nbsp;&nbsp;
      <a href="Errors.html">H5E</a>&nbsp;&nbsp;
      <a href="Files.html">H5F</a>&nbsp;&nbsp;
      <a href="Groups.html">H5G</a>&nbsp;&nbsp;
      <a href="Properties.html">H5P</a>&nbsp;&nbsp;
      <a href="References.html">H5R & H5I</a>&nbsp;&nbsp;
      <a href="Ragged.html">H5RA</a>&nbsp;&nbsp;
      <a href="Dataspaces.html">H5S</a>&nbsp;&nbsp;
      <a href="Datatypes.html">H5T</a>&nbsp;&nbsp;
      <a href="Filters.html">H5Z</a>&nbsp;&nbsp;
      <a href="Caching.html">Caching</a>&nbsp;&nbsp;
      <a href="Chunking.html">Chunking</a>&nbsp;&nbsp;
      <a href="Debugging.html">Debugging</a>&nbsp;&nbsp;
      <a href="Environment.html">Environment</a>&nbsp;&nbsp;
      <a href="ddl.html">DDL</a>&nbsp;&nbsp;
-->
</td></tr>
</table>
</center>
<hr>


<h1>HDF5 Library Environment Variables and Configuration Parameters</h1>

<h2>1. Environment Variables</h2>

The HDF5 library uses UNIX environment variables to control
or adjust certain library features at runtime.  The variables and 
their defined effects are as follows:

<dir>
<dl>
    <dt><tt>HDF5_DEBUG</tt>
        <dd>Defines a list of debugging switches documented in the
            <a href="Debugging.html">Debugging</a> section of the
            <cite>HDF5 User's Guide</cite>.

    <dt><tt>HDF5_NOCLEANUP</tt>
        <dd>When set to a non-empty value, the programs in the test
            directory do not remove temporary HDF5 data files.
            The default is for each test to remove the files before exit.

    <dt><tt>HDF5_MPI_OPT_TYPES</tt> 
            &nbsp;&nbsp;(for parallel beta version only)
        <dd>When set to <code>1</code>, PHDF5 will use the MPI optimized 
            code to perform parallel read/write accesses to datasets.
            Currently, this optimization fails when accessing extendable
            datasets.  The default is not to use the optimized code.

    <dt><tt>HDF5_MPI_1_METAWRITE</tt> 
            &nbsp;&nbsp;(for parallel beta version only)
        <dd>When set to <code>1</code>, PHDF5 will write the metadata 
            via process 0 of each opened parallel HDF5 file.  This should 
            improve I/O throughput.  The default is not to use this 
            optimization.

</dl>
</dir>

<h2>2. Configuration Parameters</h2>

The HDF5 configuration script accepts a list of parameters to control
configuration features when creating the Makefiles for the library.  
The command
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;configure --help </code>
<br>
will display the current list of parameters and their effects.


<hr>
<center>
<table border=0 width=98%>
<tr><td valign=top align=left>
   <a href="H5.intro.html">Introduction to HDF5</a>&nbsp;<br>
   <a href="RM_H5Front.html">HDF5 Reference Manual</a>&nbsp;<br>
   <a href="index.html">Other HDF5 documents and links</a>&nbsp;<br>
   <!--
   <a href="Glossary.html">Glossary</a><br>
   -->
</td>
<td valign=top align=right>
   And in this document, the 
   <a href="H5.user.html">HDF5 User's Guide</a>:&nbsp;&nbsp;&nbsp;&nbsp;
      <a href="Files.html">Files</a>&nbsp;&nbsp;
      <br>
      <a href="Datasets.html">Datasets</a>&nbsp;&nbsp;
      <a href="Datatypes.html">Data Types</a>&nbsp;&nbsp;
      <a href="Dataspaces.html">Dataspaces</a>&nbsp;&nbsp;
      <a href="Groups.html">Groups</a>&nbsp;&nbsp;
      <a href="References.html">References</a>&nbsp;&nbsp;
      <br>
      <a href="Attributes.html">Attributes</a>&nbsp;&nbsp;
      <a href="Properties.html">Property Lists</a>&nbsp;&nbsp;
      <a href="Errors.html">Error Handling</a>&nbsp;&nbsp;
      <a href="Filters.html">Filters</a>&nbsp;&nbsp;
      <a href="Caching.html">Caching</a>&nbsp;&nbsp;
      <br>
      <a href="Chunking.html">Chunking</a>&nbsp;&nbsp;
      <a href="Debugging.html">Debugging</a>&nbsp;&nbsp;
      Environment&nbsp;&nbsp;
      <a href="ddl.html">DDL</a>&nbsp;&nbsp;
      <a href="Ragged.html">Ragged Arrays</a>&nbsp;&nbsp;
<!--
<hr>
And in this document, the 
<a href="H5.user.html">HDF5 User's Guide</a>:&nbsp;&nbsp;&nbsp;&nbsp;
      <a href="Attributes.html">H5A</a>&nbsp;&nbsp;
      <a href="Datasets.html">H5D</a>&nbsp;&nbsp;
      <a href="Errors.html">H5E</a>&nbsp;&nbsp;
      <a href="Files.html">H5F</a>&nbsp;&nbsp;
      <a href="Groups.html">H5G</a>&nbsp;&nbsp;
      <a href="Properties.html">H5P</a>&nbsp;&nbsp;
      <a href="References.html">H5R & H5I</a>&nbsp;&nbsp;
      <a href="Ragged.html">H5RA</a>&nbsp;&nbsp;
      <a href="Dataspaces.html">H5S</a>&nbsp;&nbsp;
      <a href="Datatypes.html">H5T</a>&nbsp;&nbsp;
      <a href="Filters.html">H5Z</a>&nbsp;&nbsp;
      <a href="Caching.html">Caching</a>&nbsp;&nbsp;
      <a href="Chunking.html">Chunking</a>&nbsp;&nbsp;
      <a href="Debugging.html">Debugging</a>&nbsp;&nbsp;
      <a href="Environment.html">Environment</a>&nbsp;&nbsp;
      <a href="ddl.html">DDL</a>&nbsp;&nbsp;
-->
</td></tr>
</table>
</center>


<hr>

<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>
=======
  <head>
    <title>HDF5 Library Environment Variables
      and Configuration Parameters</title>
  </head>

  <body>

    <h1>HDF5 Library Environment Variables and Configuration Parameters</h1>

    <h2>1. Environment Variables</h2>

    The HDF5 library uses UNIX environment variables to control
    or adjust certain library features at runtime.  The variables and 
    their defined effects are as follows:

    <center>
      <table width="90%">
	<tr>
	  <th>Variable</th>
	  <th>Description</th>
	</tr>

	<tr valign=top>
	  <td><code>HDF5_DEBUG</code></td>
	  <td>Defines a list of debugging switches documented in the
	    <a href="Debugging.html">Debugging</a> section of the
	    <cite>HDF5 User's Guide</cite>.</td>
	</tr>

	<tr valign=top>
	  <td><code>HDF5_NOCLEANUP</code></td>
	  <td>If set then programs in the test directories do not
	    remove temporary files. The default is for each test to
	    remove the files before exit if the test succeeds but to
	    leave the files if the test fails.</td>
	</tr>

	<tr valign=top>
	  <td><code>HDF5_PREFIX</code></td>
	  <td>The value of this variable is prepended to all temporary 
	    file names created by the test programs and separated from 
	    the base name of the file by a slash. The default is no
	    prefix.</td>
	</tr>

	<tr valign=top>
	  <td><ode>HDF5_DRIVER</code></td>
	  <td>This variable should hold the name of a low-level HDF5
	    file driver such as <code>sec2</code>, <code>stdio</code>, 
	    <code>core</code>, <code>split</code>, or
	    <code>family</code>. The family driver also takes an
	    optional real-valued family member size in MB which
	    defaults to 1. If this variable is not set or empty then
	    the library-defined default file driver is used (which can 
	    be set at configuration time with the H5F_LOW_DFLT cpp
	    constant, usually <code>sec2</code>).</td>
	</tr>

	<tr valign=top>
	  <td><code>HDF5_MPI_OPT_TYPES</code></td>
	  <td>When set to <code>1</code>, parallel HDF5 will use the
	    MPI-optimized code to perform parallel read/write accesses
	    to datasets. Currently, this optimization fails when
	    accessing extendable datasets.  The default is not to use
	    the optimized code.</td>
	</tr>

	<tr valign=top>
	  <td><code>HDF5_MPI_1_METAWRITE</code></td>
	  <td>When set to <code>1</code>, parallel HDF5 will write the
	  metadata via process 0 of each opened parallel HDF5 file.
	  This should improve I/O throughput.  The default is not to
	  use this optimization.</td>
	</tr>

      </table>
    </center>


    <h2>2. Configuration Parameters</h2>

    The HDF5 configuration script accepts a list of parameters to control
    configuration features when creating the Makefiles for the library.  
    The command
    <br>
    <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;configure --help </code>
    <br>
    will display the current list of parameters and their effects.


<hr>
<address>
<a href="mailto:hdfhelp@ncsa.uiuc.edu">HDF Help Desk</a>
</address>

Last modified: 25 November 1998


</body>
</html>