Notes:
The following instructions assume that the HDF5 source code package from HDF website (http://hdf.ncsa.uiuc.edu) is used.
Please read CAREFULLY about the following preconditions and notes first.
Installed Compaq Visual Fortran compiler(6.0 or higher version), or Intel Fortran compiler if you want to build HDF5 Fortran libraries.
Notes:
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.
For example:
c:\ (any drive)
MyHDFstuff\ (any folder name)
Use 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".
Currently, two external compression libraries Zlib and Szip can be used with HDF5.
1. HDF5 uses Zlib version 1.2.2 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://hdf.ncsa.uiuc.edu/lib-external/zlib/1.2/bin to download the Zlib library.
Notes:
Zlib 1.2.2 DLL library can also be downloaded from
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://hdf.ncsa.uiuc.edu/lib-external/szip/2.0/bin/windows
Notes:
Please note that Szip is not a totally open-source free software. For licensing issue of Szip, please check "Licensing terms" at http://hdf.ncsa.uiuc.edu/doc_resource/SZIP/index.html.
Szip compression feature inside HDF5 is optional.
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:\zlib122\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.
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";
1. Find the box "Show directories for", choose "Include files", if you can not find your Zlib and Szip header path (for example, c:\zlib122\include, c:\szip\include) from the directory list, add the header path (c:\zlib122\include, c:\szip\include) to the included directories.
2. Find the box "Show directories for", choose "Library files", If you cannot find your Zlib and Szip library path (for example, c:\zlib122\lib, c:\szip\dll) from the directory list, add the library path (c:\zlib122\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. To build HDF5 C++ and FORTRAN libraries, please read through this document.
3. 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.txt.
4. For users who would like to build and test HDF5 package from the command line, please read INSATLL_Windows_From_Command_Line.txt.
5. HDF4-related tools are not built and released with HDF5 library packages any more . To obtain HDF4-releated tools, please check
6. For DLL users, please do read and follow "DLL Hints" Section IV.
7. For .NET users, please read Section VI.
8. For users who would like to build, test and use HDF5 snapshot release, please read Section VIII.
9. For Intel Compiler users, Intel 7.x works with MSVS 6.0 and Intel 8.1 only works with MSVS .net 2003 when you build HDF5-1.8.x.
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 and HDF5 HL-Fortran Library
HDF5 Tools: HDF5 tools
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
HDF5 examples: simple HDF5 C/C++/Fortran examples
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.
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.
Go to "Project" and select "dependencies"; Select "all" in the "Select project to modify:" box, then enable the desired projects:
Go to "Project" and select "dependencies"; Select "all" in the "Select project to modify:" box,then enable the desired projects:
Go to "Project" and select "dependencies"; Select "all" in the "Select project to modify:" box, then enable the desired projects:
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:
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.2) and the following desired projects:
In "Project configurations", select "all -- Win32 Debug", select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "all".
In "Project configurations", select "all -- Win32 Release", select "ok". Select "Build" -> "Build" or "Rebuild All" to build release version of project "all".
Notes:
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:
| Location | File Name | Illustration |
|---|---|---|
| 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 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 c:\MyHDFstuff\hdf5\tools\toolslib\release |
toolslib.lib | the internal tools library |
|
c:\MyHDFstuff\hdf5\tools\toolslibD\debug 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:
| Location | File Name | Illustration |
|---|---|---|
| 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 Fortran libraries:
| Location | File Name | Illustration |
|---|---|---|
| c:\MyHDFstuff\hdf5\proj\hdf5_fortran\debug | hdf5_fortrand.lib | the HDF5 Fortran API static library |
| c:\MyHDFstuff\hdf5\proj\hdf5_fortran\release | hdf5_fortran.lib | the HDF5 Fortran API static library |
| c:\MyHDFstuff\hdf5\proj\hdf5_fortrandll\debug | hdf5_fortranddll.dll | the HDF5 Fortran API DLL |
| hdf5_fortranddll.lib | the HDF5 Fortran API DLL export library | |
| c:\MyHDFstuff\hdf5\proj\hdf5_fortrandll\release | hdf5_fortrandll.dll | the HDF5 Fortran API DLL |
| hdf5_fortrandll.lib | the HDF5 Fortran API DLL export library | |
| c:\MyHDFstuff\hdf5\proj\hdf5_f90sctub\debug | hdf5_f90cstubd.lib | the HDF5 C and Fortran stub static library |
| c:\MyHDFstuff\hdf5\proj\hdf5_f90cstub\release | hdf5_f90cstub.lib | the HDF5 C and Fortran stub static library |
| c:\MyHDFstuff\hdf5\proj\hdf5_f90cstubdll\debug | hdf5_f90cstubddll.dll | the HDF5 C and Fortran stub DLL |
| hdf5_f90cstubddll.lib | the HDF5 C and Fortran stub DLL export library | |
| c:\MyHDFstuff\hdf5\proj\hdf5_f90cstubdll\release | hdf5_f90cstubdll.dll | the HDF5 C and Fortran stub DLL |
| hdf5_f90cstubdll.lib | the HDF5 C and Fortran stub DLL export library | |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_cstubdll\debug | libtest_cstubddll.dll | the HDF5 Fortran test C and Fortran stub DLL |
| libtest_cstubddll.lib | the HDF5 Fortran test C and Fortran stub DLL export library | |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_cstubdll\release | libtest_cstubdll.dll | the HDF5 Fortran test C and Fortran stub DLL |
| libtest_cstubdll.lib | the HDF5 Fortran test C and Fortran stub DLL export library | |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_fortran\debug | libtest_fortrand.lib | the HDF5 Fortran test static library |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_fortran\release | libtest_fortran.lib | the HDF5 Fortran test static library |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_fortrandll\debug | libtest_fortranddll.dll | the HDF5 Fortran test DLL |
| libtest_fortranddll.lib | the HDF5 Fortran test DLL export library | |
| c:\MyHDFstuff\hdf5\fortran\test\libtest_fortran\release | libtest_fortrandll.dll | the HDF5 Fortran test DLL |
| libtest_fortrandll.lib | the HDF5 Fortran test DLL export library |
The directories listed below will contain the following files ONLY when you choose to build HDF5 High Level libraries:
| Location | File Name | Illustration |
|---|---|---|
| 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 |
The directories listed below will contain the following files ONLY when you choose to build HDF5 High Level C++ libraries:
| Location | File Name | Illustration |
|---|---|---|
| c:\MyHDFstuff\hdf5\proj\hdf5_hl_cpp\Release | hdf5_hl_cpp.lib | HDF5 High Level Static Library |
| c:\MyHDFstuff\hdf5\proj\hdf5_hl_cpp\Debug | hdf5_hl_cpp.lib | HDF5 High Level Static Library |
The directories listed below will contain the following files ONLY when you choose to build HDF5 High Level Fortran libraries:
| Location | File Name | Illustration |
|---|---|---|
| c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortran\Release | hdf5_hl_fortran.lib | HDF5 High Level Fortran Static Library |
| c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortran\Debug | hdf5_hl_fortrand.lib | HDF5 High-Level Fortran Static Library |
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.
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:
| Options | Illustration |
|---|---|
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 step I. |
hdf5check enableall |
test HDF5 C/C++/FORTRAN libraries and tools To use this option, HDF5 C++ and Fortran libraries must have been built in step I. |
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.
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.
cd into the hdf5\test directory.
Go to a, b, c, or d to test your chosen version
type:
hdf5test release >"Your output filename"
type:
hdf5test release dll > "Your output filename"
type:
hdf5test debug >"Your output filename"
type:
hdf5test debug dll >"Your output filename"
Go to a, b, c, or d to test your chosen version
type:
hdf5timingtest release >"Your output filename"
type:
hdf5timingtest release dll >"Your output filename"
type:
hdf5timingtest debug >"Your output filename"
type:
hdf5timingtest debug dll >"Your output filename"
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
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
type:
testhdf5tools release
output file: toolstest_release.txt
type:
testhdf5tools release dll
output file: toolstest_releasedll.txt
type:
testhdf5tools debug
output file: toolstest_debug.txt
type:
testhdf5tools debug dll
output file: toolstest_debugdll.txt
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
Skip this step UNLESS you have built HDF5 C++ libraries and want to test them.
DLLs listed below should be placed into to 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.
Run hdf5cpptest.bat in the hdf5\c++\test directory at the command prompt as below:
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
Skip this step UNLESS you have built HDF5 Fortran libraries and want to test them.
DLLs listed below should be placed into to 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.
Run testhdf5_fortran.bat at the command prompt as below:
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
Skip this step UNLESS you have built HDF5 High-Level libraries and want to test them.
Run test_hdf5_hl.bat in the hdf5\hl\test directory at the command prompt as below:
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
Skip this step UNLESS you have built HDF5 High-Level C++ libraries and want to test them.
Run test_hdf5_hl_cpp.bat in the hdf5\hl\c++\test directory at the command prompt as below:
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
Skip this step UNLESS you have built HDF5 High-Level Fortran libraries and want to test them.
Run test_hdf5_hl_fortran.bat in the hdf5\hl\fortran\test directory at the command prompt as below:
Notes:
Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.
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). 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:
You may also find the similar layout for the <debug>.
Simple examples have been provided for users to test HDF5 C/C++/Fortran library and tools.
Notes:
1. To build HDF5 C++ examples, HDF5 C++ library must have been built in step I.
2. To build HDF5 Fortran examples, HDF5 Fortran library must have been built in step I.
3. By default, the debug versions of HDF5 C/C++/Fortran examples are linked with the debug versions of HDF5 C/C++/Fortran libraries and DLLs. The debug versions of HDF5 C/C++/Fortran examples will fail if they are linked with HDF5 binary distribution, which only includes the release versions of HDF5 C/C++/Fortran libraries and DLLs.
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".
In "Project configurations", select "allexamples -- Win32 Debug", select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "allexamples".
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\
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:
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 wil be given.
1. Invoke Microsoft Visual C++, go to "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".
In "Project configurations", select "allcppexamples -- Win32 Debug", select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "allcppexamples".
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\
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:
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.
1. Invoke Compaq Visual Fortran or intel Fortran under Microsoft Visual studio development environment, go to "File" and select the "Open Workspace" option.
Then open the workspace
c:\MyHDFstuff\hdf5\windows\fortran\examples\allf90examples\allf90examples.dsw.
2. Select "Build", then Select "Set Active Configuration".
In "Project configurations", select "allf90examples -- Win32 Debug", select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "allf90examples".
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\
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.
Warings:
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 build an application using HDF5 Static Library, the following locations will need to be specified for locating header files and linking with the HDF static library, for example:
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.
Open your VC++ project in Microsoft Visual C++ and make sure it is the active project.
Go to the Project menu and chose the "Settings" option.
Choose the build configuration you would like to modify in the drop down menu labeled with "Settings For:"
Choose the C/C++ tab
Choose "Preprocessor" in the drop down menu labeled with "Category:"
In a text-area labeled with "Additional include directories:", add HDF5, Zlib, and Szip header files directories. For example:
Then click OK.
(optional) to use HDF5 Fortran static library, the location of Fortran module files should be specifiedbyfollowingProject->Settings->Fortran->Preprocessor, and in a test-area labeled with "INCLUDE and USE Paths:", add HDF5 Fortran module files directories. For example:
Open your VC++ project in Microsoft Visual C++ and make sure it is the active project.
Go to the Project menu and chose the "Add to Project" option and then "Files" option.
Change the "Files of type:" to "Library Files (.lib)"
Navigate through the directories until you find the location of the hdf5.lib.
Select hdf5.lib and click OK.
repeat step i-v, to select zdll.lib and szlibdll.lib.
(optional) repeat step i-v, to select hdf5_cpp.lib to link with HDF5 C++ static library.
(optional) repeat step i-v5, to select hdf5_fortran.lib to link with HDF5 Fortran static library.
Go toTools->Options->Directories,
Insert the correct HDF5, Zlib, Szip paths for both headers(include) and libraries. For example,
Go to the Project menu and choose the "Settings" option.
Find the "link" option and "Input" category, insert "zdll.lib, szlibdll.lib, hdf5.lib".
(Optional) repeat step iii-iv, to insert "hdf5_cpp.lib" if you want to use HDF5 C++ static library.
(Optional) repeat step iii-iv, to insert "hdf5_fortran.lib" if you want to use HDF5 Fortran static library.
Follow the steps for specifying the location of the header files as shown in Method One.
Follow the steps for linking the HDF5 library as shown in Method One. 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.
Place the DLL in a location that Windows will be able to locate it. The searched path and order for DLL's is
The Windows system directory. The GetSystemDirectory function retrieves the path of this directory.
The Windows directory. The GetWindowsDirectory function retrieves the path of this directory.
The directories listed in the PATH environment variable.
To modify your own application settings, please DO FOLLOW the "DLL Hints" at section IV "HELPFUL POINTERS".
Here are some notes that may be of help if you are not familiar with using the Visual C++ Development Environment.
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 two files to be installed in another directory.
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
If you want to use DLL versions of HDF5 library in your application, you should
Put HDF5 DLL into windows system directory
Add HDF5 DLL export library into your project
Follow "Settings... details" into the last line: change Single-Threaded into Multithreaded DLL or Debug Multithreaded DLL
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.
(optional) repeat 4), add HDF5CPP_USEDLL at the end of the PreProcessor definitions to use HDF5 C++ DLL.
(optional)Follow Project->Settings->Fortran->Category->General->Predefined Preprocess or Symbols, and add "HDF5F90_WINDOWS" to use HDF5 Fortran DLL.
Warnings:
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.
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:
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:
This message can be ignored.
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 three lines:
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:
This message can be ignored.
Notes:
To disable Gzip and Szip at the same time, just follow 1.1~1.3 and 2.1~2.3 and run-compile HDF5 library according to Section II.
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.ncsa.uiuc.edu/HDF/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.
We just briefly introduce you how to build HDF5 in VS 7.1(.NET)2003;
1. Open the old workspace file with the "Open solution" option, .NET will automatically convert the data space file to solution file.
2. Then find "Build" and go to "Configuration Manager"; choose "release" or "debug", then choose "build all".
3. 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.
4. You need to specify the zlib and szip include header files andlibrariesunderTools->Options->Projects->VC++ Directories and choose Include and libraries under the category of "show directories for" to add the corresponding path if you want to use compression feature inside HDF5.
Notes:
1. Please read Section V if you do not want to use compression feature inside HDF5.
2. Since Microsoft Visual Studio .NET will automatically enable all project files in the "Configuration Manager", you have to manually disable those project files you don't want to build.
2.1 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:
2.2 If you don't want to build HDF5 Fortran Libraries, Go to "Build" and select "Configuration Manager". Choose "Release" or "Debug" under "Active Solution Configuration"
Disable the following projects:
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:
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:
2.5 If you want to build HDF5 Fortran Libraries without High-Level Fortran Libraries, Go to "Build" and select "Configuration Manager". Choose "Release" or "Debug" under "Active Solution Configuration".
Disable the following projects:
Go toTools-->Select Compiler
Check Intel box and click OK button.
Go toTools-->Select Compiler
Check Intel box and click OK button.
Go toTools-->Customize-->Add-ins and Macro Files and check Intel Fortran Compiler Build Tool
Notes:
Szip library is different when using Intel compiler. You should build Szip source codes with Intel compiler or download binaries for Intel compiler from ftp://ftp.ncsa.uiuc.edu/HDF/szip/2.0/bin/windows/. The Szip library and header path should also be set up accordingly (refer to Precondition 6.)
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.ncsa.uiuc.edu/HDF/szip/2.0/bin/windows/.
The Szip library and header path should also be set up accordingly (refer to Precondition 6.)
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";
Find the box "Show directories for", choose "Include files", if you can not find your Zlib and Szip header path (for example, c:\zlib122\include, c:\szip\include) from the directory list, add the header path (c:\zlib122\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:\zlib122\lib, c:\szip\dll) from the directory list, add the library path (c:\zlib122\lib, c:\szip\dll) to the library directories.
Notes:
1. This step will build ONLY HDF5 Static and DLL C and C++ Library using Intel C++ Compiler.
2.If you want to build HDF5 Static and DLL C and C++ Library using Intel C++ 8.1 Compiler as well as HDF5 Static Fortran Library using Intel Fortran 8.1 Compiler, Please go to 2.2 directly!
2.1.1 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.1.2 Right click on the solution name "all.sln" in the "Solution Explorer". From the pop-up menu select "Convert to use Intel C++ Project System" to convert all .Net project files to Intel C++ project files.
2.1.3 Go to Tools > Options > Intel C++. In the left pane, Click "General".
a. In the right pane, under "Compiler selection", choose Intel C++ 8.1.
b. Click on "Intel C++ 8.1" to set the directories and default options. In "Include", Add Zlib and Szip header path(c:\zlib122\include c:\szip\include). In "Library", Add Zlib and Szip Library Path (c:\zlib122\lib, c:\szip\dll).
c. Then click "OK".
2.1.4 Select "Build", then Select "Set Active Configuration".
Select "all -- Win32 Debug" or "all -- Win32 Release"
Disable all Fortran project files listed below:
Select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "all".
2.1.5 Go back to Section II, continue with STEP 2(Testing HDF5 libraries and tools) to test HDF5 C and C++ Libraries.
Notes:
1. This step will build HDF5 Static and DLL C and C++ Library using Intel C++ 8.1 Compiler as well as HDF5 Static and High Level Fortran Library using Intel Fortran 8.1 Compiler.
2. Users who want to build ONLY HDF5 Static and DLL C and C++ LibraryPlease go to 2.1.
2.2.1 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.2.2 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:
2.2.3 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".
2.2.4 Change project dependencies of "libtest_fortran"
Highlight project "libtest_fortran", choose "Project"-> "Project Dependencies", uncheck "libtest".
2.2.5 Right click on the solution name "all.sln" in the "Solution Explorer". From the pop-up menu select "Convert to use Intel C++ Project System" to convert all .Net C++ project files to Intel C++ project formats.
2.2.6 Select "Build", then Select "Set Active Configuration".
Select "all -- Win32 Debug" or "all -- Win32 Release"
Disable all Fortran DLL project files listed below:
Select "ok". Select "Build" -> "Build" or "Rebuild All" to build Debug or Release version of HDF5 C, C++ Static and DLL Library using Intel C++ 8.1 Compiler and HDF5 Static and High Level Fortran Library using Intel Fortran 8.1 compiler.
2.2.7 Test HDF5 Static and High Level Fortran Library
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
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
Check your output files, there should be no "failures" at all.
Notes:
This section is only for users who would like to build and test HDF5 snapshot release.
For users who would like to build and test HDF5 C and C++ library, 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.
Notes:
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 H5f90i_gen.h and H5fortran_types.f90 except H5Tinit.c before going to section II, step1(3.2). Follow the steps below to generate these three files. Use Microsoft Visual C++ 6.0 to generate H5Tinit.c and Compaq Fortran 6.6c to generate H5f90i_gen.h and H5fortran_types.f90. We don't guarantee that these three files can be created sucessfully by other compilers.
1) Previous step: section II, step 1(1)
2) Follow the steps in Step I to generate H5Tinit.c.
3) Open H5fortran_detect_gen.dsw under directory c:\myHDFstuff\hdf5\windows\misc\H5fortran_detect_gen 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 c:\myHDFstuff\hdf5\windows\misc\fortrantypegen\H5fortran_detect.dsw. 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 c:\myHDFstuff\hdf5\windows\misc\matchtypegen\H5match_types.dsw. Build the project file.
8) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
type
H5fortran_detect_gen.exe
This step will generate H5f90i_gen.h and H5fortran_types.f90 automatically.
9) Go back to section II, step1(3.2)
The default driver on windows we support is sec2 driver. However, stdio driver is also supported. If you want to use stdio driver in your application, you may set environment variable HDF5_DRIVER to "stdio".
On windows XP, the following steps should be followed to set the environment variable,
a) Go to Control panel and find "system",
b) Click "system" and choose "advanced",
c) Choose Environment Variables
d) Add new variable "HDF5_DRIVER"
e) set the "HDF5_DRIVER" to "stdio"
Reminder:
If you don't want to use stdio driver, please remember to delete the environment variable "HDF5_DRIVER" or change the variable value to "sec2".