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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
|
***********************************************************************
* HDF5 Build and Install Instructions for Windows XP *
* (Full Version) *
***********************************************************************
The following instructions assume that the HDF5 source code package from
HDF website (http://hdfgroup.org) is used.
Warnings:
Please read CAREFULLY about the following preconditions and notes first.
Contents:
Section : Preconditions and Notes
Section I : What do we build and install
Section II : How to build and test HDF5 libraries and tools
Section III : How to build examples (optional)
Section IV : How to build an application using the HDF5 library or DLL
Section V : How to disable Gzip(Zlib)/Szip compression
Section VI : How to build HDF5 in .NET 2003
Section VII : How to build HDF5 with Fortran Support
Section VIII : How to build Multi-threaded version of HDF5 library
Section IX : How to build and test HDF5 snapshot release
Section X : How to build HDF5 with Thread-Safe Feature
Section XI : How to build HDF5 in Visual Studio 2005
Section XII : How to build HDF5 for 64-bit Windows
Section XIII : Misc.
========================================================================
Preconditions and Notes
========================================================================
Preconditions:
1. Installed Microsoft Visual C++ 6.0 or Intel Compiler and 7zip or WinZip.
1.1 Installed Intel Compiler 9.1 if you want to build
HDF5 Fortran libraries.
Note: 1. 7zip is an open-source alternative to WinZip. Some of the
advanced functionality is disabled in WinZip unless you buy the
software. With 7zip, most of this functionality is included for
free.
2. By default, WinZip will convert the Unix end of line format
when extracting .tar file. This conversion will cause
"false" failure in some HDF5 tools testings.
Please uncheck the "TAR file smart CR/LF conversion" option
in your WinZip to prevent the conversion when extracting
.tar file.
To uncheck the "TAR file smart CR/LF conversion" option:
Invoke WinZip, go to "Options", select "Configuration..."
Click the "Miscellaneous" tab and uncheck "TAR file smart
CR/LF conversion" option, then click OK.
2. Set up a directory structure to unpack the library. For example:
c:\ (any drive)
MyHDFstuff\ (any folder name)
3. Download the hdf5-1.8.x source code package and use 7zip or WinZip to
extract the HDF5 package into c:\MyHDFstuff. This creates a
directory called 'hdf5-1.8.x' under MyHDFstuff which contains
several files and directories. Rename "hdf5-1.8.x" to "hdf5".
4. HDF5 provide options to do in-memory compress within HDF5
library. Currently, two external compression libraries Zlib and
Szip can be used with HDF5.
4.1 HDF5 uses Zlib version 1.2.3 for compression and Zlib is NOT
distributed with HDF5 library in 1.8.x release. To use Zlib
library, you have to install your own Zlib DLL library or go
to ftp://ftp.hdfgroup.org/lib-external/zlib/1.2/bin/zlib123-windows.zip
to download the Zlib library.
4.2 HDF5 uses Szip version 2.0 for compression and Szip
compression software is provided with HDF5 products in
1.8.0 release. To use Szip 2.0 library, you can
download Szip source codes and binaries from
ftp://ftp.hdfgroup.org/lib-external/szip/2.0/bin/windows
Please note that Szip is not a totally open-source free
software. For licensing issue of Szip, please check
"Licensing terms" at
http://hdfgroup.org/doc_resource/SZIP/index.html.
Szip compression feature inside HDF5 is optional.
5. Define the following environment variables:
HDF5_EXT_ZLIB
HDF5_EXT_SZIP
In this section, Zlib and Szip compression packages are assumed
to be used. Please read Section V as well as this section if you
do not want to use compression feature inside HDF5.
To define these environment variables:
Click "Start", click "Control Panel", and then double-click
"System". On the "Advanced" tab, click "Environment Variables".
If you are logged on as administrator to the local computer AND
want to let all other users use these two environment variables,
click "New" under "System Variables" box; otherwise, click "New"
under "User Variables" box.
In the New Variable window, set "Variable name" as HDF5_EXT_ZLIB
and "Variable value" as zdll.lib, then click OK.
Similarly, you can set:
HDF5_EXT_SZIP environment variable as szlibdll.lib
Notes:
a. You might have to close and reopen running programs for
the new environment variable settings to take effect.
b. c:\zlib123\zlib1.dll and c:\szip\dll\szlibdll.dll should
be copied into the location that the application can find,
one suggestion is to use the c:\WINDOWS\system.
6. Set up path for external libraries and headers
Skip this part if you don't want to use ANY compression features
provided by HDF5. Please do read Section V.
You have to read this part even if you want to only use Zlib
or Szip. You also need to read Section V.
Invoke Microsoft Visual C++ and go to "Tools" and select
"Options", find "Directories";
6.1 Find the box "Show directories for", choose
"Include files", if you can not find your Zlib and Szip
header path
(for example, c:\zlib123\include, c:\szip\include)
from the directory list, add the header path
(c:\zlib123\include, c:\szip\include) to the
included directories.
6.2 Find the box "Show directories for", choose "Library files",
If you cannot find your Zlib and Szip library path
(for example, c:\zlib123\lib, c:\szip\dll)
from the directory list, add the library path
(c:\zlib123\lib, c:\szip\dll) to the library directories.
Notes:
1. In release 1.8.0, all.zip is deprecated. Users should go to
hdf5/windows directory, run copy_hdf.bat first and then open
all.dsw under hdf5/windows/proj/all to start building process.
2. In release 1.8.0, all.sln was provided for command line use ONLY.
all.sln should never be opened to start building HDF5 using IDE.
3. To build HDF5 C++ libraries, please read through
this document.
4. For users who want to quickly build HDF5 library or do not
want to know HDF5 building and installation details, please
read INSATLL_Windows_Short_MSVS6.0.txt,
INSTALL_Windows_Short_Net.txt or INSTALL_Windows_Short_Intel.txt
based on the compiler to be used.
5. For users who would like to build and test HDF5 package from the
command line, please read INSATLL_Windows_From_Command_Line.txt.
6. HDF4-related tools are not built and released with HDF5 library
packages any more. To obtain HDF4 related tools, please check
http://hdfgroup.org/h4toh5/ and
ftp://ftp.hdfgroup.org/HDF5/h4toh5
7. For DLL users, please do read and follow "DLL hints"
at Section IV.
8. For .NET users, please read Section VI.
9. For fortran users, Intel fortran Compiler 9.1 is currently supported-- please
see Section VII. Intel Compiler verion 7.x and 8.x are no longer supported,
but documentation can still be found on the web at
http://hdfgroup.org/windows/docs/hdf518/dep/Install_Windows_Dep_Intel.txt
10. For users who would like to build Muti-threaded version of HDF5
library, please read Section VIII.
11. For users who would like to build, test and use HDF5 snapshot
release, please read Section IX.
12. For .Net and 2005 users, if you are not building HDF5 with
Thread-Safe Feature (see Section X), ttsafedll.dsp should
always be turned off.
13. The Compaq Fortran Compiler is no longer supported in HDF5-1.8.
========================================================================
Section I: What do we build and install?
========================================================================
1. Build and Install
HDF5 static library:
debug and release version
HDF5 Dynamic Link Library(DLL):
debug and release version as well as export libraries for DLL
HDF5 High-Level Library (Optional):
HDF5 C++ Library
HDF5 HL-Fortran Library
HDF5 tools:
HDF5 tools
2. Build Only (Not included in the binary distribution)
HDF5 tool library:
debug and release version
HDF5 tool export library for DLL:
debug and release version
HDF5 library testing programs:
HDF5 library comprehensive tests
HDF5 related tools testing programs:
HDF5 tools comprehensive tests
3. Examples (Not included in the binary distribution)
HDF5 examples:
simple HDF5 C/C++/Fortran and High level C/Fortran examples
========================================================================
Section II: How to build and test HDF5 libraries and tools
========================================================================
Note:
To build and testHDF5 with Fortran support, please read
over Section VII.
STEP 1: Building HDF5 libraries and tools
1. Run batch file copy_hdf.bat
Go to c:\MyHDFstuff\hdf5\windows and run copy_hdf.bat. This
process will copy all the necessary batch files, windows specific
source codes and text files saved under c:\MyHDFstuff\hdf5\windows
directory to the corresponding directories under hdf5.
2. Invoke Microsoft Visual C++ compiler
Invoke Microsoft Visual C++. From the main menu, go to "File"
and select the "Open Workspace" option. Then open the
c:\MyHDFstuff\hdf5\windows\proj\all\all.dsw workspace.
You should find windows project files listed as "all files,
big files etc." on the left.
3. (Optional)HDF5 C++ and High level C++
3.1 Skip this step if you do not want to build HDF5 High-Level
libraries
Go to "Project" and select "dependencies";
Select "all" in the "Select project to modify:" box,
then enable the desired projects:
hdf5_hl
hdf5_hldll
hl_test_image
hl_test_imagedll
hl_test_lite
hl_test_litedll
hl_test_table
hl_test_tabledll
hl_test_ds
hl_test_dsdll
hl_test_packet
hl_test_packetdll
3.2 Skip this step if you do not want to build HDF5 High-Level
C++ libraries
Go to "Project" and select "dependencies";
Select "all" in the "Select project to modify:" box,
then enable all of the project files listed in Section II
Step 1(3.1) and the following desired projects:
hdf5_hl_cpp
hdf5_hl_cppdll
hl_test_table_cpp
hl_test_table_cppdll
4. Select "Build", then Select "Set Active Configuration".
4.1 To build debug versions of single-threaded static libraries,
debug multithreaded DLLs and tests
In "Project configurations", select "all -- Win32 Debug",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build debug version of project "all".
4.2 To build release versions of single-threaded static libraries,
multithreaded DLLs and tests
In "Project configurations", select "all -- Win32 Release",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build release version of project "all".
Both debug and release versions must be built.
Warning messages can be ignored.
When the debug or release build is done the directories
listed below will contain the following files:
c:\MyHDFstuff\hdf5\proj\hdf5\debug -
hdf5d.lib- the hdf5 static library
c:\MyHDFstuff\hdf5\proj\hdf5\release -
hdf5.lib- the hdf5 static library
c:\MyHDFstuff\hdf5\proj\hdf5dll\debug -
hdf5ddll.dll- DLL
hdf5ddll.lib- the DLL export library
c:\MyHDFstuff\hdf5\proj\hdf5dll\release -
hdf5dll.dll- DLL
hdf5dll.lib- the DLL export library
c:\MyHDFstuff\hdf5\test\libtest\debug -
and c:\MyHDFstuff\hdf5\test\libtest\release -
libtest.lib - the internal library for test
c:\MyHDFstuff\hdf5\test\libtestD\debug -
libtestD.dll - the internal DLL for test
libtestD.lib - the internal DLL export library for test
c:\MyHDFstuff\hdf5\test\libtestD\release -
libtestD.dll - the internal DLL for test
libtestD.lib - the internal DLL export library for test
c:\MyHDFstuff\hdf5\tools\toolslib\debug -
and c:\MyHDFstuff\hdf5\tools\toolslib\release -
toolslib.lib- the internal tools library
c:\MyHDFstuff\hdf5\tools\toolslibD\debug -
and c:\MyHDFstuff\hdf5\tools\toolslibD\release -
toolslibD.dll- DLL
toolslibD.lib- the internal DLL export library for tools
c:\MyHDFstuff\hdf5\tools\"tools directory"-
where tools are located
The directories listed below will contain the following files
ONLY when you choose to build HDF5 C++ libraries:
c:\MyHDFstuff\hdf5\proj\hdf5_cpp\debug -
hdf5_cppd.lib- the HDF5 C++ API static library
c:\MyHDFstuff\hdf5\proj\hdf5_cpp\release -
hdf5_cpp.lib- the HDF5 C++ API static library
c:\MyHDFstuff\hdf5\proj\hdf5_cppdll\debug -
hdf5_cppddll.dll- the HDF5 C++ API DLL
hdf5_cppddll.lib- the C++ API DLL export library
c:\MyHDFstuff\hdf5\proj\hdf5_cppdll\release -
hdf5_cppdll.dll- the HDF5 C++ API DLL
hdf5_cppdll.lib- the C++ API DLL export library
The directories listed below will contain the following files
ONLY when you choose to build HDF5 High Level libraries:
c:\MyHDFstuff\hdf5\proj\hdf5_hl\Release -
hdf5_hl.lib - HDF5 High Level Static Library
c:\MyHDFstuff\hdf5\proj\hdf5_hl\Debug -
hdf5_hld.lib - HDF5 High Level Static Library
c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Release -
hdf5_hldll.dll - HDF5 High Level DLL
hdf5_hldll.lib - HDF5 High Level export Library
c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Debug -
hdf5_hldlld.dll - HDF5 High Level DLL
hdf5_hldlld.lib - HDF5 High Level export Library
The directories listed below will contain the following files
ONLY when you choose to build HDF5 High Level C++ libraries:
c:\MyHDFstuff\hdf5\proj\hdf5_hl_cpp\Release -
hdf5_hl_cpp.lib - HDF5 High Level C++ Static Library
c:\MyHDFstuff\hdf5\proj\hdf5_hl_cpp\Debug -
hdf5_hl_cpp.lib - HDF5 High Level C++ Static Library
c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Release -
hdf5_hl_cppdll.dll - HDF5 High Level C++ DLL
hdf5_hl_cppdll.lib - HDF5 High Level C++ export Library
c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Debug -
hdf5_hl_cppdlld.dll - HDF5 High Level C++ DLL
hdf5_hl_cppdlld.lib - HDF5 High Level C++ export Library
STEP 2: Testing HDF5 libraries and tools
HDF5 libraries and tools should be tested to make sure that they were
built correctly.
We provide 2 options for users to test HDF5 libraries and tools.
Option 1: Automatic testings
HDF5 comes with various test suites, all of which can be tested
with hdf5check.bat batch file in c:\MyHDFstuff\hdf5 directory.
hdf5check batch file can be run with one of the following four
options:
hdf5check test HDF5 C library and tools only
hdf5check enablecpp test HDF5 C/C++ libraries and tools
To use this option, HDF5 C++
libraries must have been built
in step I.
hdf5check enablefortran test HDF5 C/FORTRAN libraries and
tools
To use this option, HDF5 Fortran
libraries must have been built
in Section VII.
hdf5check enableall test HDF5 C/C++/FORTRAN libraries
and tools
To use this option, HDF5 C++ and
Fortran libraries must have been
built.
Invoke a command prompt window and run hdf5check with appropriate
option.
Test results are saved in two files:
c:\MyHDFstuff\hdf5\check_results.txt
c:\MyHDFstuff\hdf5\tests_results.txt.
In general, you only need to check tests_results.txt. If all the
tests passed, then you do not have to check check_results.txt.
If some tests failed, check check_results.txt can help you
figure out what was wrong.
Option 2: Step-by-step HDF5 libraries and tools testings
You can also test HDF5 libraries and tools one by one. There are
possibly four versions of HDF5 libraries and tools testings.
They are:
release version
release dll version
debug version
debug dll version
We strongly suggest you to redirect your testing results into an
output file so that you can easily check the testing results. You
may use either Notepad or WordPad or whatever other windows word
processor to check the results. For the purpose of printing,
please choose font less than 14 for better alignment of the text.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_dll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 DLLs will be copied to the system directory.
hdf5\proj\hdf5dll\release\hdf5dll.dll
hdf5\proj\hdf5dll\debug\hdf5ddll.dll
hdf5\test\libtestD\release\libtestD.dll
hdf5\test\libtestD\debug\libtestDd.dll
1. HDF5 library testing
cd into the hdf5\test directory.
(1) basic tests
Go to a) b) c) or d) to test your chosen version
a) release static version
type:
hdf5test release >"Your output filename"
b) release dll version
type:
hdf5test release dll >"Your output filename"
c) debug static version
type:
hdf5test debug >"Your output filename"
d) debug dll version
type:
hdf5test debug dll >"Your output filename"
(2) timing tests
Go to a) b) c) or d) to test your chosen version
a) release static version
type:
hdf5timingtest release >"Your output filename"
b) release dll version
type:
hdf5timingtest release dll >"Your output filename"
c) debug static version
type:
hdf5timingtest debug >"Your output filename"
d) debug dll version
type:
hdf5timingtest debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
2. HDF5 tools testing
To test HDF5 tools, cd back into hdf5 directory and then cd into
tools directory(c:\MyHDFstuff\hdf5\tools). The HDF5 tools testing
results are saved into output files in tools directory by the
testhdf5tools.bat as described below.
Go to a) b) c) or d) to test your chosen version
a) release static version
type:
testhdf5tools release
output file: toolstest_release.txt
b) release dll version
type:
testhdf5tools release dll
output file: toolstest_releasedll.txt
c) debug static version
type:
testhdf5tools debug
output file: toolstest_debug.txt
d) debug dll version
type:
testhdf5tools debug dll
output file: toolstest_debugdll.txt
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
3. HDF5 C++ library test
Skip this step UNLESS you have built HDF5 C++ libraries
and want to test them.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_cppdll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 C++ DLLs will be copied to the system directory.
hdf5\proj\hdf5_cppdll\release\hdf5_cppdll.dll
hdf5\proj\hdf5_cppdll\debug\hdf5_cppddll.dll
Run hdf5cpptest.bat in the hdf5\c++\test directory at the
command prompt as below:
hdf5cpptest release >"Your output filename"
hdf5cpptest release dll >"Your output filename"
hdf5cpptest debug >"Your output filename"
hdf5cpptest debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
4. HDF5 Fortran library test
Skip this step UNLESS you have built HDF5 Fortran libraries in
Section VII, and want to test them.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_f90dll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 Fortran DLLs will be copied to the system
directory.
hdf5\proj\hdf5_f90cstubdll\release\hdf5_f90cstubdll.dll
hdf5\proj\hdf5_f90cstubdll\debug\hdf5_f90cstubddll.dll
hdf5\proj\hdf5_fortrandll\release\hdf5_fortrandll.dll
hdf5\proj\hdf5_fortrandll\debug\hdf5_fortranddll.dll
hdf5\fortran\test\libtest_cstubdll\release\libtest_cstubdll.dll
hdf5\fortran\test\libtest_cstubdll\debug\libtest_cstubddll.dll
hdf5\fortran\test\libtest_fortrandll\release\libtest_fortrandll.dll
hdf5\fortran\test\libtest_fortrandll\debug\libtest_fortranddll.dll
Run testhdf5_fortran.bat at the command prompt as below:
testhdf5_fortran release >"Your output filename"
testhdf5_fortran release dll >"Your output filename"
testhdf5_fortran debug >"Your output filename"
testhdf5_fortran debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
5. HDF5 High-Level library test
Skip this step UNLESS you have built HDF5 High-Level libraries
and want to test them.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_hldll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 high level DLLs will be copied to the system
directory.
c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Release\hdf5_hldll.dll
c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Debug\hdf5_hldlld.dll
Run test_hdf5_hl.bat in the hdf5\hl\test directory at the
command prompt as below:
test_hdf5_hl release >"Your output filename"
test_hdf5_hl release dll >"Your output filename"
test_hdf5_hl debug >"Your output filename"
test_hdf5_hl debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
6 HDF5 High-Level C++ library test
Skip this step UNLESS you have built HDF5 High-Level C++
libraries and want to test them.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_hlcppdll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 high level c++ DLLs will be copied to the system
directory.
c:\MyHDFstuff\hdf5\proj\hdf5_hlcppdll\Release\hdf5_hlcppdll.dll
c:\MyHDFstuff\hdf5\proj\hdf5_hlcppdll\Debug\hdf5_hlcppdlld.dll
Run test_hdf5_hl_cpp.bat in the hdf5\hl\c++\test directory at
the command prompt as below:
test_hdf5_hl_cpp release >"Your output filename"
test_hdf5_hl_cpp release dll >"Your output filename"
test_hdf5_hl_cpp debug >"Your output filename"
test_hdf5_hl_cpp debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
7. HDF5 High-Level Fortran library test
Skip this step UNLESS you have built HDF5 High-Level Fortran
libraries and want to test them.
DLLs listed below should be placed into the Windows system
directory. A batch file named install_hlf90dll.bat is included in
c:\MyHDFstuff\hdf5 directory. Run this batch file and the
following HDF5 high level fortran DLLs will be copied to the system
directory.
c:\MyHDFstuff\hdf5\proj\hdf5_hl_f90cstubdll\Release\hdf5_hl_f90cstubdll.dll
c:\MyHDFstuff\hdf5\proj\hdf5_hl_f90cstubdll\Debug\hdf5_hl_f90cstubdlld.dll
c:\MyHDFstuff\hdf5\proj\hdf5_hlfortrandll\Release\hdf5_hlfortrandll.dll
c:\MyHDFstuff\hdf5\proj\hdf5_hlfortrandll\Debug\hdf5_hlfortrandlld.dll
Run test_hdf5_hl_fortran.bat in the hdf5\hl\fortran\test directory at
the command prompt as below:
test_hdf5_hl_fortran release >>"Your output filename"
test_hdf5_hl_fortran release dll >>"Your output filename"
test_hdf5_hl_fortran debug >>"Your output filename"
test_hdf5_hl_fortran debug dll >>"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
STEP 3: Installing HDF5 Libraries
We provide a batch file for users to relocate all HDF5 libraries in one
folder (C++ and Fortran libraries will also be copied into this folder
if they have been built in step I or Section VII, respectively). The file
is called installhdf5lib.bat under c:\MyHDFstuff\hdf5 directory. Run
the batch file, you may see a folder called hdf5lib under c:\MyHDFstuff\hdf5.
The <release> layout of <hdf5lib> should be:
release\include -- HDF5 header files
release\bin -- HDF5 static tool executables
release\bindll -- HDF5 DLL tool executables
release\lib -- HDF5 static libraries
release\dll -- HDF5 DLLs
You may also find the similar layout for the <debug>.
========================================================================
Section III: How To Build Examples (Optional)
========================================================================
Simple examples have been provided for users to test HDF5
C/C++/Fortran and high level C/Fortran library and tools.
Note:
1) To build HDF5 C++ examples, HDF5 C++ library must have been
built in step I.
2) To build HDF5 Fortran or HL Fortran examples, please see
Section VII, Step 3.
3) To build HDF5 High Level C examples, HDF5 High level library
must have been built in step I.
4) By default, the debug versions of HDF5 C/C++/HL examples
are linked with the debug versions of HDF5 C/C++/HL
libraries and DLLs. The debug versions of HDF5 C/C++/HL
examples will fail if they are linked with HDF5 binary
distribution, which only includes the release versions of
HDF5 C/C++ libraries and DLLs.
To build and test HDF5 C examples:
----------------------------------
1. Invoke Microsoft Visual C++, go to "File" and select
the "Open Workspace" option.
Then open the workspace
c:\MyHDFstuff\hdf5\windows\examples\allexamples\allexamples.dsw.
2. Select "Build", then Select "Set Active Configuration".
2.1 To build debug versions of C examples.
In "Project configurations", select "allexamples -- Win32 Debug",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build debug version of project "allexamples".
2.2 To build release versions of C examples.
In "Project configurations", select "allexamples -- Win32 Release",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build release version of project "allexamples".
When the debug build or release build is done, there should be the
following subdirectories in c:\MyHDFstuff\hdf5\examples\
attributetest
attributetestdll
chunkread
chunkreaddll
compoundtest
compoundtestdll
extendwritetest
extendwritetestdll
grouptest
grouptestdll
readtest
readtestdll
selectest
selectestdll
writetest
writetestdll
3. Invoke a command prompt window and run the batch file
InstallExamples.bat which resides in the top level directory
(c:\MyHDFstuff\hdf5). This file creates 4 new directories,
examplesREL, examplesRELDLL, examplesDBG, and examplesDBGDLL,
in the c:\MyHDFstuff\hdf5\examples directory and places all the
executables in it. Both the release and debug versions of the
examples should be built before this step is done.
4. We provide a batch file named testExamples.bat and an expected
examples tests output file named testExamples_exp_output.txt
in c:\MyHDFstuff\hdf5\examples directory for you to test HDF5
C examples.
testExamples.bat batch file has 4 options:
testExamples release -- for release version
testExamples release dll -- for release DLL version
testExamples debug -- for debug version
testExamples debug dll -- for debug DLL version
Invoke a command prompt window and run testExamples with
appropriate options. You should get "All HDF5 C examples tests
passed." when the C examples are built successfully. Otherwise,
the difference between the expected outputs and actual outputs
will be given.
To build and test HDF5 C++ examples:
------------------------------------
1. Invoke Microsoft Visual C++ 6.0, choose "File" and select
the "Open Workspace" option.
Then open the workspace
c:\myHDFstuff\hdf5\windows\c++\examples\allcppexamples\allcppexamples.dsw.
2. Select "Build", then Select "Set Active Configuration".
2.1 To build debug versions of C++ examples.
In "Project configurations", select "allcppexamples -- Win32 Debug",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build debug version of project "allcppexamples".
2.2 To build release versions of C++ examples.
In "Project configurations", select "allcppexamples -- Win32 Release",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build release version of project "allcppexamples".
When the debug build or release build is done, there should be the
following subdirectories in c:\MyHDFstuff\hdf5\c++\examples\
chunkstest
chunkstestdll
compoundtest
compoundtestdll
createtest
createtestdll
extend_dstest
extend_dstestdll
h5grouptest
h5grouptestdll
readdatatest
readdatatestdll
writedatatest
writedatatestdll
3. Invoke a command prompt window and run the batch file
InstallcppExamples.bat which resides in the top level directory
(c:\MyHDFstuff\hdf5). This file creates 4 new directories,
cppexamplesREL, cppexamplesRELDLL, cppexamplesDBG,
and cppexamplesDBGDLL, in the c:\MyHDFstuff\c++\examples
directory and places all the executables in it. Both the release
and debug versions of the examples should be built before this
step is done.
4. We provide a batch file named testcppExamples.bat in
c:\MyHDFstuff\hdf5\c++\examples directory for you to test HDF5
C++ examples.
testcppExamples.bat batch file has 4 options:
testcppExamples release -- for release version
testcppExamples release dll -- for release DLL version
testcppExamples debug -- for debug version
testcppExamples debug dll -- for debug DLL version
Invoke a command prompt window and run testcppExamples with
appropriate options. You should get "All HDF5 C++ examples tests
passed." when the C++ examples are built successfully. Otherwise,
the difference between the expected outputs and actual outputs
will be given.
To build and test HDF5 High Level C examples:
---------------------------------------------
1. Invoke Microsoft Visual C++, go to "File" and select
the "Open Workspace" option.
Then open the workspace
c:\MyHDFstuff\hdf5\windows\hl\examples\allhlcexamples\allhlcexamples.dsw
2. Select "Build", then Select "Set Active Configuration".
2.1 To build debug versions of High Level C examples.
In "Project configurations", select
"allhlcexamples -- Win32 Debug", select "ok". Select
"Build" -> "Build" or "Rebuild All" to build debug version
of project "allhlcexamples".
2.2 To build release versions of C examples.
In "Project configurations", select
"allhlcexamples -- Win32 Release", select "ok". Select
"Build" -> "Build" or "Rebuild All" to build release version
of project "allhlcexamples".
When the debug build or release build is done, there should be the
following subdirectories in c:\MyHDFstuff\hdf5\hl\examples
allhlcexamples
ex_images
ex_imagesdll
ex_lite
ex_litedll
ex_table
ex_tabledll
ex_ds
ex_dsdll
ex_packet
ex_packetdll
3. Invoke a command prompt window and run the batch file
Install_hlcexamples.bat which resides in the top level directory
(c:\MyHDFstuff\hdf5). This file creates 4 new directories,
HLCexamplesRELEASE, HLCexamplesRELEASEDLL, HLCexamplesDEBUG, and
HLCexamplesDEBUGDLL, in the c:\MyHDFstuff\hdf5\hl\examples
directory and places all the executables in it. Both the release
and debug versions of the examples should be built before this
step is done.
4. We provide a batch file named test_hl_cexamples.bat in
c:\MyHDFstuff\hdf5\hl\examples directory for you to test
HDF5 high level C examples.
test_hl_cexamples.bat batch file has 4 options:
Options purpose
test_hl_cexamples release -- for release version
test_hl_cexamples release dll -- for release DLL version
test_hl_cexamples debug -- for debug version
test_hl_cexamples debug dll -- for debug DLL version
Invoke a command prompt window and run test_hl_cexamples with
appropriate options.
When you run "test_hl_cexamples.bat" with each option, if you see the
following messages at the end:
All of the HL C Examples Passed!
You have built HL C examples successfully. Otherwise, HL C examples
Failed to build.
========================================================================
Section IV: Building an application using the HDF5 library or DLL
========================================================================
Waring: The instructions below will only describe how to build an
application using the release version of the HDF5 library or
DLL. To use the debug version of the HDF5 library or DLL, you
need to substitute the release version of the HDF5 library or
DLL with the debug version.
To use HDF5 static library
To build an application that uses the HDF5 static library the
following locations will need to be specified for locating header
files and linking with the HDF static library, for example:
c:\MyHDFstuff\hdf5\hdf5lib\release\include
c:\MyHDFstuff\hdf5\hdf5lib\release\lib
If you have installed HDF5 library in Section II, step 3.
We assume that you will use Zlib and Szip compression with HDF5
library.
To specify these locations in the settings for your VC++ project,
you may choose one of the following two methods.
1) Method One
To insert the path that specifies HDF5 and Zlib, Szip header files:
1. Open your VC++ project in Microsoft Visual C++ and make sure it
is the active project.
2. Go to the Project menu and chose the "Settings" option.
3. Choose the build configuration you would like to modify in the
drop down menu labeled with "Settings For:"
4. Choose the C/C++ tab
5. Choose "Preprocessor" in the drop down menu labeled with
"Category:"
6. In a text-area labeled with "Additional include directories:",
add HDF5, Zlib, and Szip header files directories. For example:
c:\MyHDFstuff\hdf5\hdf5lib\release\include
c:\zlib123\include
c:\szip\include
Then click OK.
7. (Optional) To use HDF5 Fortran static library, the location of
Fortran module files should be specified by following
Project->Settings->Fortran->Preprocessor, and in a test-area
labeled with "INCLUDE and USE Paths:", add HDF5 Fortran module
files directories. For example:
c:\MyHDFstuff\hdf5\hdf5lib\release\include
To link the HDF5 library with your application:
1. Open your VC++ project in Microsoft Visual C++ and make sure it
is the active project.
2. Go to the Project menu and chose "Add to Project" option and
then "Files" option.
3. Change the "Files of type:" to "Library Files (.lib)"
4. Navigate through the directories until you find the location of
the hdf5.lib.
5. Select hdf5.lib and click OK.
6. repeat 1-5, to select zdll.lib and szlibdll.lib.
7. (optional) repeat 1-5, to select hdf5_cpp.lib to link with HDF5
C++ static library.
8. (optional) repeat 1-5, to select hdf5_fortran.lib to link with
HDF5 Fortran static library.
2) Method Two
1. Go to Tools->Options->Directories,
2. Insert the correct HDF5, Zlib, Szip paths for both headers(include)
and libraries. For example,
c:\MyHDFstuff\hdf5\hdf5lib\release\include
c:\MyHDFstuff\hdf5\hdf5lib\release\lib
c:\zlib123\include
c:\zlib123\lib
c:\szip\include
c:\szip\dll
3. Go to the Project menu and choose the "Settings" option.
4. Find the "link" option and "Input" category, insert
"zdll.lib, szlibdll.lib, hdf5.lib".
5. (Optional) repeat 3-4, to insert "hdf5_cpp.lib" if you want to
use HDF5 C++ static library.
6. (Optional) repeat 3-4, to insert "hdf5_fortran.lib" if you want to
use HDF5 Fortran static library.
7. (Optional)repeast 3-4, to insert "hdf5_hl.lib" if you want to use
HDF5 high leve static library.
7. (Optional) repeat 3-4, to insert "hdf5_hl_cpp.lib" if you want to
use HDF5 high level C++ static library.
8. (Optional) repeat 3-4, to insert "hdf5_hl_fortran.lib" if you want to
use HDF5 high level Fortran static library.
To use the DLL:
1. Follow the steps for specifying the location of the header files
as shown above.
2. Follow the steps for linking the HDF5 library as shown above
except now link the export library that is created with the DLL.
The export library is called hdf5dll.lib for HDF5 C libray,
hdf5_cppdll.lib for HDF5 C++ library, and hdf5_fortrandll.lib
for HDF5 Fortran library.
3. Place the DLL in a location that Windows will be able to locate
it. The searched path and order for DLL's is
a) The directory where the executable module for the current
process is located.
b) The current directory.
c} The Windows system directory. The GetSystemDirectory function
retrieves the path of this directory.
d) The Windows directory. The GetWindowsDirectory function
retrieves the path of this directory.
e) The directories listed in the PATH environment variable.
4. To modify your own application settings, please DO FOLLOW the
"DLL Hints" at Section XI "HELPFUL POINTERS".
========================================================================
Section V: How to disable Gzip(Zlib)/Szip compression
========================================================================
Warning: When you modify the H5pubconf.h file as described below,
DO NOT just change the values of these macros from 1 to 0.
Please DO remove(or comment out) appropriate lines.
1. Disable Gzip compression
If you would like to remove Gzip compression from the HDF5
library, follow the steps below.
1.1 Open the H5pubconf.h file from the c:\MyHDFstuff\hdf5\src
directory and remove(or comment out) the following two lines:
#define H5_HAVE_ZLIB_H 1
#define H5_HAVE_FILTER_DEFLATE 1
then save the file.
1.2 Delete HDF5_EXT_ZLIB environment variable if you have
set it in preconditions.
1.3 Run-compile HDF5 library according to Section II.
When you disable Gzip, you may get the following message
when building HDF5 libraries:
The following environment variables were not found
$(HDF5_EXT_ZLIB)
This message can be ignored.
2. Disable Szip compression (both encoder and decoder)
If you would like to remove Szip compression from the HDF5
library, follow the steps below.
2.1 Open the H5pubconf.h file from the c:\MyHDFstuff\hdf5\src
directory and remove(or comment out) the following two
lines:
#define H5_HAVE_SZLIB_H 1
#define H5_HAVE_FILTER_SZIP 1
then save the file.
2.2 Delete HDF5_EXT_SZIP environment variable if you have
set it in preconditions.
2.3 Run-compile HDF5 library according to Section II.
When you disable Szip, you may get the following message
when building HDF5 libraries:
The following environment variables were not found
$(HDF5_EXT_SZIP)
This message can be ignored.
Notes:
To disable Gzip and Szip at the same time, just follow 1.1~1.2
and 2.1~2.2 and run-compile HDF5 library according to Section II.
3. Disable Szip encoder
If you would like to just disable Szip encoder from the HDF5
library while keeping Szip decoder enabled, follow the steps
below.
3.1 Download Szip library without encoder
Szip library is different if you want to disable Szip encoder.
Download szip_noencoder binaries from
ftp://ftp.hdfgroup.org/lib-external/szip/2.0/bin/windows.
The Szip library and header path should also be set up
accordingly (refer to precondition 6).
3.2 Run-compile HDF5 library according to Section II.
========================================================================
Section VI: How to build HDF5 in Microsoft Visual Studio .Net 2003
========================================================================
Note:
To build Fortran libraries with Intel Fortran 9.1, please see
Section VII.
Preconditions:
a. Set up path for Microsoft Visual Studio .Net 2003 compiler
Open "System" in Control Panel.
On the "Advanced" tab, click "Environment Variables", click
"Path" in the "System variables" box, then click "Edit" and
add your Visual C++ .Net path (For example,
C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\IDE)
into "Variable Value" and click "OK".
b. Set up path for external libraries and headers
Skip this part if you don't want to use ANY compression features
provided by HDF5. Please do read Section V.
You have to read this part even if you want to only use Zlib
or Szip. You also need to read Section V.
Invoke Microsoft Visual C++ .Net and go to "Tools" and select
"Options". In the left pane of "Option" window poped up,
choose and extend "Projects", Click on "VC++ Directories".
In the right pane, Find the box "Show directories for", choose
"Include files", if you can not find your Zlib and Szip
header path
(for example, c:\zlib123\include, c:\szip\include)
from the directory list, add the header path
(c:\zlib123\include, c:\szip\include) to the
included directories.
Find the box "Show directories for", choose "Library files",
If you cannot find your Zlib and Szip library path
(for example, c:\zlib123\lib, c:\szip\dll)
from the directory list, add the library path
(c:\zlib123\lib, c:\szip\dll) to the library directories.
1. Open all.dsw workspace
Invoke Microsoft Visual C++ .Net 2003. From the main
menu, go to "File" and select "Open Solution". In
the "Open Solution" window, Change "Files of type" to
"All Project Files". Choose "all.dsw" under the directory
c:\MyHDFstuff\hdf5\windows\proj\all. In the pop up window,
choose "Yes To All" to convert all project files to Visual
C++ .Net project format.
2. Building HDF5 C and C++ Libraries
2.1 Disable project files not relevant to C and C++.
Go to "Build" and select "Configuration Manager". Choose "Release"
or "Debug" under "Active Solution Configuration"
Disable the following projects:
flush1_fortran
flush1_fortrandll
flush2_fortran
flush2_fortrandll
hdf5_f90cstub
hdf5_f90cstubdll
hdf5_fortran
hdf5_fortrandll
libtest_cstubdll
libtest_fortran
libtest_fortrandll
testhdf5_fortran
testhdf5_fortrandll
hdf5_hl_fortran
hdf5_hl_f90cstubdll
hdf5_hl_fortrandll
hl_test_image_fortran
hl_test_image_fortrandll
hl_test_lite_fortran
hl_test_lite_fortrandll
hl_test_table_fortran
hl_test_table_fortrandll
ttsafedll
Click on "OK",
2.2.1 Building HDF5 C and C++ Libraries
From the main menu, choose "Build"-> "Build" or
"Rebuild ALL" to build both release and debug version of HDF5
Libraries.
2.2.2 If you don't want to build HDF5 C++ Libraries,
Go to "Build" and select "Configuration Manager". Choose "Release"
or "Debug" under "Active Solution Configuration"
Disable the following projects:
dsets_cpp
dsets_cppdll
hdf5_cpp
hdf5_cppdll
testhdf5_cpp
testhdf5_cppdll
hdf5_hl_cpp
hdf5_hl_cppdll
hl_test_table_cpp
hl_test_table_cppdll
Click on "OK", From the main menu, choose "Build"-> "Build" or
"Rebuild ALL" to build both release and debug version of HDF5
Libraries.
2.2.3 If you don't want to build HDF5 High-Level Libraries,
Go to "Build" and select "Configuration Manager". Choose "Release"
or "Debug" under "Active Solution Configuration"
Disable the following projects:
hdf5_hl
hdf5_hldll
hl_test_image
hl_test_imagedll
hl_test_lite
hl_test_litedll
hl_test_table
hl_test_tabledll
hl_test_ds
hl_test_dsdll
hl_test_packet
hl_test_packetdll
Click on "OK", From the main menu, choose "Build"-> "Build" or
"Rebuild ALL" to build both release and debug version of HDF5
Libraries.
2.2.4 If you want to build HDF5 C++ libarty without High-Level
C++ Libraries, Go to "Build" and select "Configuration Manager".
Choose "Release" or "Debug" under "Active Solution Configuration"
Disable the following projects:
hdf5_hl_cpp
hdf5_hl_cppdll
hl_test_table_cpp
hl_test_table_cppdll
Click on "OK", From the main menu, choose "Build"-> "Build" or
"Rebuild ALL" to build both release and debug version of HDF5
Libraries.
2.5 Go to "Build" and select "Configuration Manager".
Choose "Release" or "Debug" under "Active Solution Configuration".
Click on "OK", From the main menu, choose "Build"-> "Build" or
"Rebuild ALL" to build both release and debug version of HDF5
Libraries.
3. Testing HDF5 Libraries and Tools.
Go back to Section II, continue with STEP 2 (Testing HDF5
libraries and tools) to test HDF5 C and C++ Libraries.
4. If you want to change some project setting, select the project and
right click the button to choose Properties; find the similar menu
there as in Microsoft Visual Studio 6.0.
NOTE: Please read Section V if you do not want to use compression
feature inside HDF5.
========================================================================
Section VII: How to build HDF5 with Intel Fortran 9.1
========================================================================
Notes: 1. For Intel Compiler users, Intel fortran Compiler 9.1 is currently
supported-- please see below. Intel Compiler verion
7.x and 8.x are no longer supported, but documentation can
still be found on the web at
http://hdfgroup.org/windows/docs/hdf518/dep/Install_Windows_Dep_Intel.txt
2. The Compaq Fortran Compiler is no longer supported for HDF5 1.8.
3. Intel Fortran 9.1 works only under .Net 2003 or Visual Studio 2005
environments
4. For Visual Studio 2005 users, parallel builds should be disabled. To
do so: Go to Tools > Options > Projects and Solutions > Build and Run.
Set "maximum number of parallel project builds" to 1.
Preconditions:
a. Setup Szip Library for Intel Compiler.
Intel compilers use different Szip library from other compilers.
Szip source codes or binaries for Intel compiler can be downloaded
from the following address:
ftp://ftp.hdfgroup.org/lib-external/szip/2.0/bin/windows.
b. Set up path for external libraries and headers
Skip this part if you don't want to use ANY compression features
provided by HDF5. Instead, read Section V.
You have to read this part even if you want to use only Zlib
or Szip. You also need to read Section V.
Invoke Microsoft Visual C++ .Net 2003 or 2005. From the main
menu, Go to Tools > Options > Intel(R) Fortran.
In the right panel, make sure your "Selected Compiler" is Intel Fortran 9.1.
Click the right-most box for "Libraries",
Add Zlib and Szip Library Path (c:\zlib123\lib, c:\szip\dll for example)
Click rightmost box for "Includes",
Add Zlib and Szip header path (c:\zlib123\include c:\szip\include, for example).
Then click "OK".
1. Build with Intel Fortran Compiler 9.1 under MSVS C++ .Net 2003 / 2005 Environment
Note: This step will build HDF5 Static and DLL C and C++
Library using .Net 2003 or Visual Studio 2005 Compiler as well as
HDF5 Static and High Level Fortran Library using Intel
Fortran 9.1 Compiler.
1.1 Open all.dsw and Convert Project Files (.dsp) to Visual
C++ .Net Format (.vcproj)
Invoke Microsoft Visual C++ .Net or 2005. From the main menu,
go to "File" and select "Open Solution". In the "Open Solution"
window, Change "Files of type" to "All Project Files". Choose
"all.dsw" under the directory c:\MyHDFstuff\hdf5\windows\proj\all.
In the pop up window, choose "Yes To All" to convert all project
files to Visual C++ .Net project format.
1.2 Extract Compaq Fortran Project Files
a. Select project "flush1_fortran" in the Solution Explorer
window. In the Project menu, select
"Extract Compaq Visual Fortran Project".
Do the same thing for the following project files, but for now, skip
the projects labelled "**SKIP**":
flush1_fortrandll
flush2_fortran
flush2_fortrandll
hdf5_fortran
hdf5_fortrandll
**SKIP** libtest_fortran
libtest_fortrandll
testhdf5_fortran
testhdf5_fortrandll
**SKIP** hdf5_hl_fortran
hdf5_hl_fortrandll
hl_test_image_fortran
hl_test_image_fortrandll
hl_test_lite_fortran
hl_test_lite_fortrandll
hl_test_table_fortran
hl_test_table_fortrandll
b. Select project "libtest_fortran" in the Solution
Explorer window. In the Project menu, select
"Extract Compaq Visual Fortran Project". Since Project
file "libtest_fortran" contain both C and Fortran code,
you will be asked to specify which project, either
Fortran or C/C++, will serve as the main project for
this mixed language projects. Choose
"The Intel Fortran project" as the the main project and
click "OK".
Note: In Visual Studio 2005, you may receive a message that
says "The attempt to convert the Fortran project file failed.
The project file (.dsp) has not been converted." This message
can safely be ignored.
Do the same thing for hdf5_hl_fortran.
1.3 Add project dependencies
To check the project dependencies:
Right click the selected project, you should see "Project Dependencies"
on the menu, click "Project Dependencies", You should see a "Project
Dependencies" panel, with the selected project and the projects it
depends on checked under "Depends on" list.
Each of the following projects will need libtest_fortran_lib added
to its list of dependencies:
libtest_fortran
flush1_fortran
flush2_fortran
testhdf5_fortran
Each of the following projects will need hdf5_hl_fortran_lib added
to its list of dependencies:
hdf5_hl_fortran
hl_test_image_fortran
hl_test_lite_fortran
hl_test_table_fortran
1.4 Change Project Output
Right click on the project "hdf5_hl_fortran" and select
"Properties". At the top left of the Property Pages, select
"Debug" for the Configuration. Then, in the left pane, go to
Librarian > General. Change the Output File from
"$(OutDir)/$(ProjectName).lib" to "$(OutDir)/$(ProjectName)d.lib".
Then click Ok.
Similarly, right-click on "hdf5_hl_fortran_lib", and select
"Properties". At the top left of the Property Pages, select
"Debug" for the Configuration. Then, in the left pane, go to
Librarian > General. Change the Output File from
"..\..\..\proj\hdf5_hl_fortran\Debug\hdf5_hl_fortrand.lib"
to ..\..\..\proj\hdf5_hl_fortran\Debug\hdf5_hl_fortrand_lib.lib".
Then, in the top left corner again, change the Configuration to
"Release". Inside of Librarian > General, change the Output File
from ".\..\..\..\proj\hdf5_hl_fortran\Release\hdf5_hl_fortran.lib"
to ".\..\..\..\proj\hdf5_hl_fortran\Release\hdf5_hl_fortran_lib.lib".
1.5 Building HDF5 C/C++/Fortran Libraries and Tools
Select "Build", then Select "Configuration Manager".
Select "Debug" or "Release"
Disable ttsafedll
Select "ok". Select "Build" -> "Build" or "Rebuild All" to
build Debug or Release version of HDF5 C, C++, fortran
Library using Intel fortran 9.1 Compiler with .Net 2003 or .Net 2005.
2. Test HDF5 Static and High Level Fortran Library
We provide 2 options for users to test HDF5 libraries and tools.
Option 1: Automatic testings
HDF5 comes with various test suites, all of which can be tested
with hdf5check.bat batch file in c:\MyHDFstuff\hdf5 directory.
hdf5check batch file can used to test HDF libraries with Fortran with
the following options:
hdf5check enablefortran test HDF5 C/FORTRAN libraries and
tools
hdf5check enableall test HDF5 C/C++/FORTRAN libraries
and tools
To use this option, HDF5 C++ and
Fortran libraries must have been
built.
Invoke a command prompt window and run hdf5check with appropriate
option.
Test results are saved in two files:
c:\MyHDFstuff\hdf5\check_results.txt
c:\MyHDFstuff\hdf5\tests_results.txt.
In general, you only need to check tests_results.txt. If all the
tests passed, then you do not have to check check_results.txt.
If some tests failed, check check_results.txt can help you
figure out what was wrong.
Option 2: Step-by-step HDF5 libraries and tools testings
Note: This section provides step-by-step instructions for testing the
Fortran librariy and tools only. To test the rest of the HDF5 library
and tools, please see Section II, Step 2.
a. Test HDF5 Static Fortran Library
Go to directory c:\myHDFstuff\hdf5\fortran\test, Run batch file
testhdf5_fortran.bat with the following two options to test
fortran static library
testhdf5_fortran release >> "Your output file name"
testhdf5_fortran debug >> "Your output file name"
Check your output files, there should be no "failures" at all.
b. Test HDF5 High Level Fortran Library
Go to directory c:\myHDFstuff\hdf5\hl\fortran\test, Run batch file
testhdf5_fortran.bat with the following two options to test
fortran static library
test_hdf5_hl_fortran release >> "Your output file name"
test_hdf5_hl_fortran debug >> "Your output file name"
Check your output files, there should be no "failures" at all.
3. (Optional) Build HDF5 Fortan and HL Fortran Examples
Note: This section only covers building Fortran and HL Fortran examples.
For other examples, please see Section III.
To build and test HDF5 Fortran example:
---------------------------------------
1.1 Open allf90examples.dsw and Convert Project Files (.dsp) to Visual
C++ .Net Format (.vcproj)
Invoke Microsoft Visual C++ .Net or 2005. From the main menu,
go to "File" and select "Open Solution". In the "Open Solution"
window, Change "Files of type" to "All Project Files". Choose
"allf90examples.dsw" under the directory
c:\MyHDFstuff\hdf5\windows\fortran\examples\allf90examples.
In the pop up window, choose "Yes To All" to convert all project
files to Visual C++ .Net project format.
1.2 Extract Compaq Fortran Project Files
a. Select project "attreexampletest" in the Solution Explorer
window. In the Project menu, select "Extract Compaq Visual
Fortran Project".
Do the same thing for the each of the other project files, excluding
"allf90examples"
2. Select "Build", then Select "Set Active Configuration".
2.1 To build debug versions of Fortran examples.
In "Project configurations", select "allf90examples -- Win32 Debug",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build debug version of project "allf90examples".
2.2 To build release versions of Fortran examples.
In "Project configurations", select "allf90examples -- Win32 Release",
select "ok". Select "Build" -> "Build" or "Rebuild All" to
build release version of project "allf90examples".
When the debug build or release build is done, there should be the
following subdirectories in c:\MyHDFstuff\hdf5\fortran\examples\
attreexampletest
attreexampletestdll
compoundtest
compoundtestdll
dsetexampletest
dsetexampletestdll
fileexampletest
fileexampletestdll
groupexampletest
groupexampletestdll
grpdsetexampletest
grpdsetexampletestdll
grpittest
grpittestdll
grpsexampletest
grpsexampletestdll
hyperslabtest
hyperslabtestdll
mountexampletest
mountexampletest
refobjexampletest
refobjexampletestdll
refregexampletest
refregexampletestdll
rwdsetexampletest
rwdsetexampletestdll
selecteletest
selecteletestdll
3. Invoke a command prompt window and run the batch file
Installf90Examples.bat which resides in the top level directory
(c:\MyHDFstuff\hdf5). This file creates 4 new directories,
f90examplesREL, f90examplesRELDLL, f90examplesDBG, and
f90examplesDBGDLL, in the c:\MyHDFstuff\fortran\examples directory
and places all the executables in it. Both the release and debug
versions of the examples should be built before this step is done.
To build and test HDF5 High Level Fortran examples:
---------------------------------------------------
1.1 Open allhlf90examples.dsw and Convert Project Files (.dsp) to Visual
C++ .Net Format (.vcproj)
Invoke Microsoft Visual C++ .Net or 2005. From the main menu,
go to "File" and select "Open Solution". In the "Open Solution"
window, Change "Files of type" to "All Project Files". Choose
"allhlf90examples.dsw" under the directory
c:\MyHDFstuff\hdf5\windows\hl\fortran\examples\allhlf90examples.
In the pop up window, choose "Yes To All" to convert all project
files to Visual C++ .Net project format.
1.2 Extract Compaq Fortran Project Files
a. Select project "ex_lite" in the Solution Explorer
window. In the Project menu, select "Extract Compaq Visual
Fortran Project".
Do the same thing for the "ex_litedll".
2. Select "Build", then Select "Set Active Configuration".
2.1 To build debug versions of High Level Fortran examples.
In "Project configurations", select
"allhlf90examples -- Win32 Debug", select "ok". Select
"Build" -> "Build" or "Rebuild All" to build debug version
of project "allhlf90examples".
2.2 To build release versions of Fortran examples.
In "Project configurations", select
"allhlf90examples -- Win32 Release", select "ok". Select
"Build" -> "Build" or "Rebuild All" to build release version
of project "allhlf90examples".
When the debug build or release build is done, there should be the
following subdirectories in c:\MyHDFstuff\hdf5\hl\fortran\examples
ex_lite
ex_litedll
3. Invoke a command prompt window and run the batch file
Install_hlf90examples.bat which resides in the top level directory
(c:\MyHDFstuff\hdf5). This file creates 4 new directories,
HLf90examplesRELEASE, HLf90examplesRELEASEDLL, HLf90examplesDEBUG,
and HLf90examplesDEBUGDLL, in the
c:\MyHDFstuff\hdf5\hl\fortran\examples directory and places all
the executables in it. Both the release
and debug versions of the examples should be built before this
step is done.
4. We provide a batch file named test_hl_f90examples.bat in
c:\MyHDFstuff\hdf5\hl\fortran\examples directory for you to test
HDF5 high level fortran examples.
test_hl_f90examples.bat batch file has 4 options:
Options purpose
test_hl_f90examples release -- for release version
test_hl_f90examples release dll -- for release DLL version
test_hl_f90examples debug -- for debug version
test_hl_f90examples debug dll -- for debug DLL version
Invoke a command prompt window and run test_hl_f90examples with
appropriate options.
When you run "test_hl_f90examples release", the output will look
like:
release version of High Level Fortran examples PASSED
Similar messages should be generated with another three options
If the high level Fortran examples are built successfully.
========================================================================
Section VIII : How to build Multi-threaded version of HDF5 library
========================================================================
Notes: Preconditions and Section I also apply to this section. Users who
want to build Multi-threaded version of HDF5 library, please read
those two sections carefully before go to the following part.
1. Run batch file copy_hdf.bat.
Go to c:\MyHDFstuff\hdf5\windows and run copy_hdf.bat. This
process will copy all the necessary batch files,windows specific
source codes and text files saved under c:\MyHDFstuff\hdf5\windows
directory to the corresponding directories under hdf5.
2. Invoke Microsoft Visual C++ compiler
Invoke Microsoft Visual C++. From the main menu, go to "File"
and select the "Open Workspace" option. Then open the
c:\MyHDFstuff\hdf5\windows\proj\all\all.dsw workspace.
You should find windows project files listed as "all files,
big files etc." on the left.
3. Please refer to Section II, Step 3(3) to set the dependencies of
project "all.dsp".
4. Change Project settings
Choose "Project"->"Settings",
In the left pane of the window "Project Settings", from the drop
down box to the right of "Setting For:", choose "Win32 Release";
Highlight all of the static project file in the left lower pane
by pressing "ctrl" key while clicking the project file name.
In the right pane of the "Project Settings" window, choose "C/C++".
From the drop down box to the right of "Category", choose
"Code Generation", under "Use run-time library:",
"Single-Threaded" should appear. If it is blank inside this
box, check if you highlight some dll project files. Change
"Single-Threaded" to "Multithreaded".
In the left pane of the window "Project Settings", from the drop
down box to the right of "Setting For:", choose "Win32 Debug";
Highlight all of the static project file in the left lower pane
by pressing "ctrl" key while clicking the project file name.
In the right pane of the "Project Settings" window, choose "C/C++".
From the drop down box to the right of "Category", choose
"Code Generation", under "Use run-time library:",
"Debug Single-Threaded" should appear. If it is blank inside this
box, check if you highlight some dll project files. Change
"Debug Single-Threaded" to "Debug Multithreaded"
5. Go back to Section II, Step 1 (4), continue to build and test HDF5 library.
========================================================================
Section IX: Building and testing HDF5 snapshot release
========================================================================
Note: This section is only for users who would like to build and test
HDF5 snapshot release.
Step I: Generate H5Tinit.c using Microsoft Visual C++ 6.0
For users who would like to build and test HDF5 C and C++ library ONLY,
it is necessary to manually generate H5Tinit.c before going to
Section II step 1(2). Follow the steps below to generate H5Tinit.c
manually using Microsoft Visual C++ 6.0. We don't guarantee that
H5Tinit.c can be sucesessfully created by other compilers.
1. Previous step: Section II, step 1(1).
2. Extra steps:
1) Open c:\myHDFstuff\hdf5\windows\misc\typegen\typegen.dsw.
2) Build the project file.
3) Invoke command prompt and go to c:\myHDFstuff\hdf5\src.
4) type H5Tinit.exe >H5Tinit.c
5) Go back to Section II, continue with step 1(2).
Step II: Generate H5f90i_gen.h and H5fortran_types.f90 using Compaq
Visual Fortran 6.6c
Note: The users who don't want to build fortran library can skip
this step.
For users who would like to build and test HDF5 with Fortran library.
It is necessary to manually generate the following three files with
the given compiler before go to Section II:
Files to be Generated Compiler to be Used
H5f90i_gen.h Compaq Visual Fortran 6.6
H5fortran_types.f90 Compaq Visual Fortran 6.6
H5Tinit.c Visual C++ 6.0
We don't guarantee that these three files can be created successfully
by other compilers.
1) Previous step: Section II, step 1(1)
2) Follow the steps in Section X, Step I to generate H5Tinit.c.
3) Open and build H5fortran_detect_gen.dsw with Compaq Visual Fortran
Go to the following directory
c:\myHDFstuff\hdf5\windows\misc\H5fortran_detect_gen
Open H5fortran_detect_gen.dsw with Compaq Visual Fortran and
build the project file.
4) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
Type
H5fortran_detect_gen.exe > H5fortran_detect.f90
5) Open and build fortrantypegen.dsw with Compaq Visual Fortran
Go to the following directory
c:\myHDFstuff\hdf5\windows\misc\fortrantypegen
Open fortrantypegen.dsw with Compaq Visual Fortran and
build the project file.
6) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
Type
H5fortran_detect.exe > H5fort_type_defines.h
7) Open and build matchtypegen.dsw with Compaq Visual Fortran
Go to the following directory
c:\myHDFstuff\hdf5\windows\misc\matchtypegen
Open matchtypegen.dsw and build the project file.
8) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
Type
H5match_types.exe
This step will generate H5f90i_gen.h and H5fortran_types.f90
automatically.
9) Go back to Section II, step 1(2) to build and test HDF5 Libraries
and Tools
========================================================================
Section X: How To Build And Test HDF5 With Thread-Safe Feature
========================================================================
All of the preconditions in "Preconditions" Section at the
beginning of this document also apply to this section. There
are some extra preconditions for this section only as following.
pre1. Pthread-Win32 Installed
Posix Threads for Windows is a open source free software. Users can
download it from http://sources.redhat.com/pthreads-win32/.
HDF5 release 1.8.0 supports Pthread-Win32 2.7.0 (2005-06-04) or
later. Since pthreadVC2.dll used by HDF5 1.8.0 is the release version
dll of pthread-win32, ONLY HDF5 1.8.0 release dll are supported and
tested on Windows XP.
pre2. Set Path for Pthread-Win32 header and library
Invoke Microsoft Visual C++ 6.0, go to Tools->Options->Directories.
From the drop-down box under "Show directories for:",
Choose "Include files", add in the path to Pthread-Win32 header
file(For example: C:\PTHREADS_WIN32\INCLUDE).
Choose "Library files", add in the path to Pthread-Winew library
(For example: C:\PTHREADS_WIN32\LIB).
pre3. Enable HDF5 Thread-safe Feature on Windows
Go to directory c:\MYHDFstuff\hdf5\windows\src, open H5pubconf.h and
find the following messages and remove those comment signs referred to by those
two arrows and save H5pubconf.h
/*Users want to build and test hdf5 library with thread safe enabled,
Make the following block active
*/
/* <----
#if defined _DLL
#define H5_HAVE_THREADSAFE
#define H5_HAVE_SYSTEM_SCOPE_THREADS 1
#if defined TTSAFE_H
#define sleep Sleep
#endif
#endif
*/ <----
pre4. Define Environment Variable(HDF5_EXT_PTHREAD) for PthreadVC2.lib
To define this environment variable:
Click "Start" -> "Control Panel" -> "System" -> "Advanced" ->
"Environment Variables".
If you are logged on as administrator to the local computer AND
want to let all other users use these two environment variables,
click "New" under "System Variables" box; otherwise, click "New"
under "User Variables" box.
In the New Variable window, set
"Variable name" as HDF5_EXT_PTHREAD
"Variable value" as pthreadVC2.lib
click OK.
pre5. Copy pthreadVC2.dll to System Directory
pthreadVC2.dll should be copied into the location that applications
can find. One suggestion is to use the c:\WINDOWS\system.
1. Build HDF5 Release DLL with Thread-safe Feature
1.1 Run batch file copy_hdf.bat.
Go to c:\MyHDFstuff\hdf5\windows and run copy_hdf.bat. This
process will copy all the necessary batch files,windows specific
source codes and text files saved under c:\MyHDFstuff\hdf5\windows
directory to the corresponding directories under hdf5.
1.2 Invoke Microsoft Visual C++ compiler
Invoke Microsoft Visual C++. From the main menu, go to "File"
and select the "Open Workspace" option. Then open the
c:\MyHDFstuff\hdf5\windows\proj\all\all.dsw workspace.
1.3 Add in Thread-safe Source Code for HDF5 Library
Expand project "hdf5dll", right click on "source" and choose
"Add Files to Folder...", browse to add in file "H5TS.c" under
directory c:\MYHDFSTUFF\hdf5\src.
1.4 Link to pthreadVC2.lib
Right click on project "hdf5dll", choose "Set as Active Project".
Go to Project->Setting
On the left pane, choose "Win32 Release" to the right of
"Settings For:"
On the right pane, choose "Link", choose "Input" from the
drop-down box to the right of "Category:"
Under "Object/library modules:", add in "$(HDF5_EXT_PTHREAD)"
(No quotation marks).
Click on "OK".
1.5 Set Project Active Configurations
Go to Build->Set Active Configuration, choose "hdf5dll-Win32 Release"
under "Project configurations:", Click "OK".
1.6 Build HDF5 Release DLL with Thread-safe Feature
Go to Build->Build hdf5dll.dll to build HDF5 Release DLL with
thread-safe feature.
Warning messages can be ignored. But there should be no failures at
all.
2. Test Thread-safe Feature of HDF5 Release DLL
2.1 Build Release Version of Project libtestD
Go to Build->Set Active Configuration, choose
"libtestD-Win32 Release" under "Project configurations:", Click "OK".
Go to Build->Build libtestD.dll to build release version of Project
libtestD.
2.2 Build Release Version of Project ttsafedll
Go to Build->Set Active Configuration, choose
"ttsafedll-Win32 Release" under "Project configurations:", Click "OK".
Go to Build->Build ttsafedll.exe to build release version of Project
ttsafedll.exe.
2.3 Install hdf5dll.dll
Invoke a comand prompt, change directory to c:\MYHDFSTUFF\hdf5, run
batch file install_dll.bat to copy
c:\MYHDFSTUFF\hdf5\proj\hdf5dll\release\hdf5dll.dll into system
directory.
2.4 Test Thread-safe Feature of HDF5 Release DLL
Set project file ttsafedll.dsp as the active project file if it is
not. Go to Build->Execute ttsafedll.exe, the following is the
test messages users should get:
For help use: ttsafedll.exe -help
Linked with hdf5 version 1.8 release 0
Testing -- multi-dataset creation (dcreate)
Testing -- per-thread error stacks (error)
Testing -- thread cancellation safety test (cancel)
Testing -- multi-attribute creation (acreate)
All tests were successful.
Cleaning Up temp files...
Users who got the same messages as above have successfully built the
release version of hdf5dll.dll.
3. Build, Test and Install HDF5 Library and Tools
Go back to Section II, Step I(2) to Build, test and install HDF5
libary and tools.
========================================================================
Section XI: How to build HDF5 in Visual Studio 2005
========================================================================
The building procedure is almost the same as building HDF5 on .Net 2003.
Please refer to Section VI: How to build HDF5 in Visual Studio .Net 2003.
========================================================================
Section XII: How to build HDF5 for 64-bit Windows
========================================================================
HDF5 can be built for 64-bit Windows in Visual Studio .NET 2003 or Visual
Studio 2005. Visual Studio 2005 offers much greater support, and the build
process is much more straight-forward, so we recommend all users switch to
Visual Studio 2005 for 64-bit builds. However, we still provide instruction
for .NET.
Notes:
1. 32-bit binaries cannot be linked with 64-bit binaries, and therefore
external libraries (szip and zlib. and currently not supported. In the
future we plan to build these libraries natively and offer support.
2. Fortran libraries are currently untested and unsupported.
3. Building 64-bit HDF5 from a 32-bit machine is also unsupported. Because
we generate H5tinit.c from a generated 64-bit executable, this must be
done on a 64-bit machine.
Prerequisites:
1. A 64-bit Windows machine. Either AMD64 and Itanium is supported.
2. Either Visual Studio .NET or 2005. Visual Studio 2005 is recommended.
3. If building with .NET, the lastest version of the Windows Platform SDK
must be installed. The latest version can be found at:
http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
If building with 2005, Visual Studio must have been installed with the
x64 compiler tools.
Building:
1. Copy Windows-related files
From the directory .\windows, run copy_hdf.bat. This will copy
Windows-related files to their neccessarily locations within the source
directory.
2. Open the IDE
For Visual Studio 2005, this simply involves opening as normal.
In .NET, you must first open a 64-bit build environment command prompt.
To do this, go to the start menu and open Microsoft Platform SDK,
Open Build Environment Window, Windows XP 64-bit Build Environment,
and Set Windows XP x64 Build Env (Retail). This sets up the neccessary
path for Visual Studio. .NET must then be launched from that command
prompt. This can be done by issuing the command:
start "" "C:\Program Files (x86)\Microsoft Visual Studio .NET 2003\
Common7\IDE\devenv.exe" /useenv
3. Generate H5tinit.c
3.1 Open the workspace typegen.dsw from the folder .\windows\misc\typgen.
Visual Studio will convert this to .sln and .vcproj files.
3.2 Set the Target Machine.
In .NET, this is done by right clicking on the "h5tinit" project,
and selecting "Properties". Make sure your configuration is set
to Release, and go to Linker, Advanced. For the "Target Machine",
select "Not Set". Then, under Linker, Command Line, add
"/machine:AMD64" for AMD, or /machine:IA64 for Itanium.
In Visual Studio 2005, go to Build, Configuration Manager. For the
"Active solution platform", select "<New...>". In the dialog,
select x64 for the platform, and copy settings from "Win32". Make
sure "Create new project platforms" is checked.
3.3 Modify H5detect.c
In H5detect.c, find the function sigbus_handler. Windows does have
siglongjmp, but it can be safely removed. Comment out the following
line:
siglongjmp(jbuf_g, 1);
Then, right click on the project h5tinit, and select Properties.
Make sure your configuration is set to Release, and select Linker,
Input. From "Force Symbol References", remove "gethostname@8".
Also, in .NET, in "Additional Dependencies", add
"bufferoverflowU.lib".
3.4 Build H5tinit.exe
Make sure your configuration is set to Release, and build the
project. This will generate H5tinit.exe in the .\src folder.
3.5 Create H5tinit.c
From a command prompt, go to the .\src directory and issue the
command:
.\H5tinit.exe > H5tinit.c
This will generate our H5tinit.c file.
4. Build the library
4.1 Open the workspace all.dsw from the folder .\windows\proj\all. If
using Visual Studio .NET, this should be launched from the same
window, or open another window the same way you did in Step 2.
4.2 Select the Target Machine
In the same way you did in Step 3.2, set the Target Machine for
64-bit. If using .NET, this needs to be done for all projects
that produce an executable or dll. You can recognize these because
in the Property dialog, they have a "Linker" section, rather than
a "Librarian" section.
4.3 Modify Project Settings
Similar to Step 3.3, we must remove "gethostname@8" from the list of
"Force Symbol References" for each project that has it. Although
tedious, this must be done, or Visual Studio will issue a linker
error. For Visual Studio 2005, this must be done for both debug
and release versions. In .NET, we only build release.
In .NET, we also need to add "bufferoverflowU.lib" as a dependency
for several projects. You can simply add it to all projects that
produce an executable or dll, or identify specific projects that
need it at build-time because they will fail with a link error
such as:
error LNK2001: unresolved external symbol __security_cookie
this library must be explicitly added for that project.
4.4 Modify H5pubconf.h
Open H5pubconf.h from the .\src directory. Because we are not using
zlib or szip libraries, we must comment out the following lines:
#define H5_HAVE_FILTER_DEFLATE 1
#define H5_HAVE_ZLIB_H 1
#define H5_HAVE_SZLIB_H 1
#define H5_HAVE_FILTER_SZIP 1
4.5 Disable projects
In Visual Studio, open the configuration manager and disable all
Fortran projects, as well as ttsafedll. Disable the following
projects:
flush1_fortran
flush1_fortrandll
flush2_fortran
flush2_fortrandll
hdf5_f90cstub
hdf5_f90cstubdll
hdf5_fortran
hdf5_fortrandll
hdf5_hl_fortran
hdf5_hl_fortrandll
hl_test_image_fortran
hl_test_image_fortrandll
hl_test_lite_fortran
hl_test_lite_fortrandll
hl_test_table_fortran
hl_test_table_fortrandll
libtest_cstubdll
libtest_fortran
libtest_fortrandll
testhdf5_fortran
testhdf5_fortrandll
ttsafedll
If you aren't using the C++ library, you may disable those projects
as well. For Visual Studio 2005, this must be done for both Release
and Debug versions.
4.6 Build
In Visual Studio, select Build, Build Solution. In Visual Studio
2005, you may build Debug and Release versions, but in .NET, only
release builds are supported.
Testing:
We provide a test suite to verify all libraries and tools were built
successfully. This test suite should work identically on 32- and 64- bit
builds.
Note that because 64-bit binaries were built, these tests must run on a
64-bit machine.
If built with Visual Studio 2005, simply open a command prompt, and from
the root hdf5 directory, issue the command "hdf5check". If C++ libraries
were built, you may test them at the same time with the command
"hdf5check enablecpp".
If built with Visual Studio .NET, debug versions of the library will not
be present, and the test scripts must be altered by hand to reflect this.
In a text editor, open hdf5check.bat from the root hdf5 folder, and comment
or remove test sections for "Debug" or "Debug DLL". The layout is fairly
straight-forward, but as an alternative, you may manually run each of the
other various sub- test scripts with the "release" and "release dll"
parameters.
Installing:
We provide a script that will install all headers, libraries, and tools
into one folder, hdf5lib. From the root hdf5 directory, run the script
"installhdf5lib.bat". This will create the hdf5lib folder, and create
subdirectories containing all relevent files. This should work identically
on 32- an 64-bit Windows.
========================================================================
Section XIII: Misc.
========================================================================
1. Helpful Pointers
Here are some helpful notes if you are not familiar with
using the Visual C++ Development Environment.
1.1 Project name and location issues:
If you must install all.dsw and all.dsp in another directory,
relative to hdf5 directory, you will be asked to locate the
sub-project files, when you open the project all.dsw.
If you want to rename all (the entire project), you will need to
modify two files all.dsw and all.dsp as text (contrary to the
explicit warnings in the files).
You can also modify all.dsw and all.dsp as text, to allow these 2
files to be installed in another directory.
1.2 Settings... details:
If you create your own project, the necessary settings can be read
from the all.dsp file(as text), or from the Project Settings in the
Developer Studio project settings dialog.
Project
Settings
C/C++
Category
Code Generation
Use run-time Library
These are all set to use Single-Threaded
1.3 DLL... hints:
If you want to use DLL versions of HDF5 library in your application,
you should
1) put HDF5 DLL into windows system directory
2) add HDF5 DLL export library into your project
3) Follow "Settings... details" into the last line:
change Single-Threaded into Multithreaded DLL or
Debug Multithreaded DLL
4) Follow "Settings.. details" into PreProcessor:
Project
Settings
C/C++
Category
PreProcessor
Find PreProcessor definations and Add _HDF5USEDLL_ at the
end of the PreProcessor definitions to use HDF5 C DLL.
5)(optional) repeat 4), add HDF5CPP_USEDLL at the
end of the PreProcessor definitions to use HDF5 C++ DLL.
6) (optional) repeat 4), add _HDF5USEHLDLL_ at the
end of the PreProcessor definitions to use HDF5 high level
DLL.
7) (optional) repeat 4), add HDF5USE_HLCPPDLL at the
end of the PreProcessor definitions to use HDF5 high level C++
DLL.
8) (optional) Follow Project->Settings->Fortran->Category->
General->Predefined Preprocess or Symbols, and add
"HDF5F90_WINDOWS" to use HDF5 Fortran DLL.
2. Backward compatibility with 1.6
If you are going to use 1.6 APIs with 1.8 branch, you may do the
following two things:
3.1 Uncomment out /*#define H5_WANT_H5_V1_6_COMPAT 1*/ inside
h5pubconf.h under windows\src.
3.2 Set up an environment variable H5_WANT_H5_V1_6_COMPAT to 1,
this will be used to test compatibility of error APIs.
Remember to undo 1 and 2 after you test if you are not going to use 1.6
backward compatibility option.
************************************************************************
Please send email to help@hdfgroup.org for further assistance.
|