HDF5 Build and Install Instructions for Windows XP (Full Version)

Notes:

The following instructions assume that the HDF5 source code package from HDF website (http://hdf.ncsa.uiuc.edu) is used.

Table of Contents:

Preconditions

Please read CAREFULLY about the following preconditions and notes first.

1. Installed Microsoft Visual C++ 6.0 or Intel C compiler and WinZip.

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.

2. Set up a directory structure to unpack the library.

For example:

3. Download the hdf5-1.8.x source code package

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".

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.

• 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:

  1. Zlib 1.2.2 DLL library can also be downloaded from http://www.zlib.net/zlib122-dll.zip

• 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

  3. 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.

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" -> "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_ZLIB

"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.

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";

• 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

  http://hdf.ncsa.uiuc.edu/h4toh5/

  ftp://hdf.ncsa.uiuc.edu/HDF5/h4toh5/

• 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.

• 10. For .Net and Intel users, if  you are not in Section X How to build HDF5 with Thread-Safe Feature, ttsafedll.dsp should be turned off always.

Go to TOP Preconditions

Go to Table of Contents

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 and 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 examples

Go to Table of Contents

Section II: How to build and test HDF5 libraries and tools

This section includes:

STEP 1: Building HDF5 libraries and tools

STEP 2: Testing HDF5 libraries and tools

STEP 3: Installing HDF5 Libraries

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++, Fortran libraries, HL-CPP, HL-Fortran and Intel compiler

  • 3.1 Skip this step if you do not want to build HDF5 C++ libraries

    Go to "Project" and select "dependencies"; Select "all" in the "Select project to modify:" box, then enable the desired projects:

    • dsets_cpp
    • dsets_cppdll
    • hdf5_cpp
    • hdf5_cppdll
    • testhdf5_cpp
    • testhdf5_cppdll

  • 3.2 Skip this step if you do not want to build HDF5 Fortran libraries

    Go to "Project" and select "dependencies"; Select "all" in the "Select project to modify:" box, then enable the desired 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

  • 3.3 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.4 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

  • 3.5 Skip this step if you do not want to build HDF5 High-Level Fortran 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.2) and the following desired projects:

    • hdf5_hl_f90cstubdll
    • 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

  • 3.6 If you are using Intel compilers, please read Section VII.

• 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".

    Notes:

    1. Both debug and release versions must be built.

    2. 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
  c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Release	hdf5_hldll.lib	HDF5 High Level export Library
  	hdf5_hldll.dll	HDF5 High Level DLL
  c:\MyHDFstuff\hdf5\proj\hdf5_hldll\Debug	hdf5_hldlld.lib	HDF5 High Level export Library
  	hdf5_hldlld.dll	HDF5 High Level DLL

  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
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Release	hdf5_hl_cppdll.lib	HDF5 High Level C++ export Library
  	hdf5_hl_cppdll.dll	HDF5 High Level C++ DLL
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Debug	hdf5_hl_cppdlld.lib	HDF5 High Level C++ export Library
  	hdf5_hl_cppdlld.dll	HDF5 High Level C++ DLL

  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_fortranr.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
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortrandll\Release	hdf5_hl_fortrandll.lib	HDF5 High Level Fortran export Library
  	hdf5_hl_fortrandll.dll	HDF5 High Level Fortran DLL
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortrandll\Debug	hdf5_hl_fortrandlld.lib	HDF5 High Level Fortran export Library
  	hdf5_hl_fortrandlld.dll	HDF5 High Level Fortran DLL
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_f90cstubdll\Release	hdf5_hl_f90cstubdll.lib	HDF5 High Level Fortran C stub export Library
  	hdf5_hl_f90cstubdll.dll	HDF5 High Level Fortran C stub DLL
  c:\MyHDFstuff\hdf5\proj\hdf5_hl_f90cstubdll\Debug	hdf5_hl_f90cstubdlld.lib	HDF5 High Level Fortran C stub export Library
  	hdf5_hl_f90cstubdlld.dll	HDF5 High Level Fortran C stub DLL

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:

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 four versions of HDF5 libraries and tools testing. 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"

  Notes:

  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, go to 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

  Notes:

  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 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.

  • 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"

  Notes:

  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 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.

  • 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"

  Notes:

  Use Notepad or WordPad to check results. You should not find any FAILED marks in your output files.

• 5. HDF5 High-Level C 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"

  Notes:

  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 DLLs will be copied to the system directory.

  • c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Release\hdf5_hl_cppdll.dll
  • c:\MyHDFstuff\hdf5\proj\hdf5_hl_cppdll\Debug\hdf5_hl_cppdlld.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"

  Notes:

  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 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_hl_fortrandll\Release\hdf5_hl_fortrandll.dll
  • c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortrandll\Debug\hdf5_hl_fortrandlld.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"

  Notes:

  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). 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>.

Go to TOP Section II

Go to Table of Contents

Section III: How to build Examples (Optional)

This section include:

How to build and test C examples

How to build and test C++ examples

How to build and test Fortran examples

How to build and test High Level C examples

How to build and test High Level Fortran examples

Notes:

• 1. To build HDF5 C++ examples, HDF5 C++ library must have been built in Section III, step I.

• 2. To build HDF5 Fortran examples, HDF5 Fortran library must have been built in Section III, step I.

• 3. To build HDF5 High Level C examples, HDF5 High Level C library must have been built in Section III, step I.

• 4. By default, the debug versions of HDF5 C/C++/Fortran/HL examples are linked with the debug versions of HDF5 C/C++/Fortran/HL libraries and DLLs. The debug versions of HDF5 C/C++/Fortran/HL 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.

• How to build and test C examples:

  • 1. Open C Examples Workspace

    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. Compile/Build C Examples

    Select "Build", then Select "Set Active Configuration".

    • 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".

    • 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
    • readtestdll
    • selectest
    • selectestdll
    • writetest
    • writetestdll

  • 3. Install C Examples

  • 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.Test C examples

    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 wil be given.

• How to build and test C++ examples

  • 1. Open C++ Examples Workspace

    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. Compile/Build C++ Examples

    Select "Build", then Select "Set Active Configuration".

    • 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".

    • 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. Install C++ Examples

  • 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. Test C++ Examples

    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.

• How to Build and test HDF5 Fortran examples:

  • 1. Open Fortran Examples Workspace

    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. Compile/Build Fortran Examples

    Select "Build", then Select "Set Active Configuration".

    • 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".

    • 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. Install Fortran Examples

  • 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.

  • 4. Test Fortran Examples

  • The batch file is not available for the time being.

• How to build and test HDF5 High Level C examples

  • 1. Open HL C Examples Workspace.

    Invoke Microsoft Visual C++ 6.0, go to "File" and select the "Open Workspace" option.

    Then open the workspace

    c:\MyHDFstuff\hdf5\windows\hl\hl_c_examples\hl_c_examples.dsw.

  • 2. Compile/Build HL C Examples

    Select "Build", then Select "Set Active Configuration".

    • To build debug versions of High Level C examples,

      In "Project configurations", select "hl_c_examples -- Win32 Debug", select "ok". Select "Build" -> "Build" or "Rebuild All" to build debug version of project "hl_c_examples".

    • To build release versions of High Level C examples,

      In "Project configurations", select "hl_c_examples -- Win32 Release", select "ok". Select "Build" -> "Build" or "Rebuild All" to build release version of project "hl_c_examples".

    When the debug build or release build is done, there should be the following subdirectories in c:\MyHDFstuff\hdf5\hl\hl_c_examples.

    • ex_images
    • ex_imagesdll
    • ex_lite
    • ex_litedll
    • ex_table
    • ex_tabledll
    • ex_ds
    • ex_dsdll
    • ex_packet
    • ex_packetdll

  • 3. Install HL C examples

  • 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\hl\hl_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. Test HL C examples

    We provide a batch file named test_hl_cexamples.bat in c:\MyHDFstuff\hdf5\hl\hl_c_examples\ directory for you to test HDF5 High Level C examples.

    test_hl_cexamples.bat batch file has 4 options:

    • test_hl_cexamples release -- for release version
    • ttest_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.bat with appropriate options. When you run "test_hl_cexamples release", 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.

    How to  build and test HDF5 High Level Fortran examples:

    • 1. Open HL Fortran Examples Workspace

    • Invoke Compaq Visual Fortran 6.6c, open the workspace c:\MyHDFstuff\hdf5\windows\hl\fortran\examples\allhlf90examples\allhlf90examples.dsw

    • 2. Compile/Build HL Fortran Examples

      Select "Build", then Select "Set Active Configuration"

      • 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".

      • 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. Install HL Fortran Examples

      Invoke a command prompt window and run the batch fileInstall_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 directory c:\MyHDFstuff\hdf5\hl\fortran\examples 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. Test HL Fortran Examples

      We provide a batch file named test_hl_f90examples.bat in directory c:\MyHDFstuff\hdf5\hl\fortran\examples for you to test HDF5 high level fortran examples.

      test_hl_f90examples.bat batch file has 4 options:

      • 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.bat 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.

  Go to TOP Section III

  Go to Table of Contents

  ---

  Section IV: Building an application using the HDF5 library or DLL

  ---

  Warnings:

  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.

  • 1. To use HDF5 static library

    • 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:

      • 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.

      • 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:\zlib122\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 the "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 step i-v, to select zdll.lib and szlibdll.lib.

          7. (optional) repeat step i-v, to select hdf5_cpp.lib to link with HDF5 C++ static library.

          8. (optional) repeat step i-v5, to select hdf5_fortran.lib to link with HDF5 Fortran static library.

      • 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:\zlib122\include
           • c:\zlib122\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 step iii-iv, to insert "hdf5_cpp.lib" if you want to use HDF5 C++ static library.

        6. (Optional) repeat step iii-iv, to insert "hdf5_fortran.lib" if you want to use HDF5 Fortran static library.

  • 2. To use HDF5 Dynamic Link Library

    1. Follow the steps for specifying the location of the header files as shown in Method One.

    2. 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.

    3. Place the DLL in a location that Windows will be able to locate it. The searched path and order for DLL's is

       1. The Windows system directory. The GetSystemDirectory function retrieves the path of this directory.

       2. The Windows directory. The GetWindowsDirectory function retrieves the path of this directory.

       3. 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".

  Go to TOP Section IV

  Go to Table of Contents

  ---

  Section V: How to disable Gzip(Zlib)/Szip compression

  ---

  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.

  • 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.3 and 2.1~2.3 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.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.

  Go to TOP Section V

  Go to Table of Contents

  ---

  Section VI: How to build HDF5 in Microsoft Visual Studio .Net 2003

  ---

  • 1. Open the 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.

    • Notes: If  you are not in Section X How to build HDF5 with Thread-Safe Feature, ttsafedll.dsp should be turned off always.

  • 2. Building HDF5 C/C++ Libraries

    • Users can choose the desirable libraries to be built according to the following description.

    • 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:
        • 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
        • ttsafedll

    • 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:
        • 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_fortrandll
        • hdf5_hl_f90cstubdll
        • 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

    • 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
        • ttsafedll

    • 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
        • ttsafedll

    • 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:
        • hdf5_hl_fortran
        • hdf5_hl_fortrandll
        • hdf5_hl_f90cstubdll
        • 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

  •  

  • Find "Build" and go to "Configuration Manager"; choose "release" or "debug", then choose "build all" to build HDF5 with desired options.

  Notes:

  • 1.  You need to specify the zlib and szip include header files and libraries under Tools ->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.

  • 2. Please read Section V if you do not want to use compression feature inside HDF5.

  • 3. 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.

    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.

  Go to TOP Section VI

  Go to Table of Contents

  ---

  Section VII: How to build HDF5 with INTEL Compiler

  ---

  • 1. INTEL compiler 7.1

    • 1.1. Intel C Compiler

      • Go to Tools-->Select Compiler
      • Check Intel box and click OK button.

    • 1.2. Intel Fortran Compiler

      • Go to Tools-->Select Compiler
      • Check Intel box and click OK button.
      • Go to Tools-->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.)

  • 2. INTEL compiler 8.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.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.)

    • 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++ 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.

  • 2.1 Intel C++ Compiler 8.1 under MSVS C++ .Net 2003 Environment

    • 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".
    • In the right pane, under "Compiler selection", choose Intel C++ 8.1.
    • 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).
    • 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 and ttsafedll project file:
    • 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
    • hl_test_image_fortran
    • hl_test_lite_fortran
    • hl_test_table_fortran
    • ttsafedll
    • 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.

  • 2.2 Intel Fortran Compiler 8.1 under MSVS C++ .Net 2003 Environment

    • 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:
    • flush2_fortran
    • hdf5_fortran
    • testhdf5_fortran
    • hl_test_image_fortran
    • hl_test_lite_fortran
    • hl_test_table_fortran

  • 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".  Do the same thing for "hdf5_hl_fortran".

  • 2.2.4 Change project dependencies of "libtest_fortran" and "hdf5_hl_fortran"

    • Highlight project "libtest_fortran", choose "Project"-> "Project Dependencies", uncheck "libtest".
    • Highlight project "hdf5_hl_fortran", choose "Project"-> "Project Dependencies", uncheck "hdf5_hl" and "hdf5_fortran".

  • 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 and ttsafedll project file:
    • flush1_fortrandll
    • flush2_fortrandll
    • hdf5_fortrandll
    • hdf5_hl_fortrandll
    • hl_test_image_fortrandll
    • hl_test_lite_fortrandll
    • hl_test_table_fortrandll
    • libtest_fortrandll
    • testhdf5_fortrandll
    • ttsafedll
    • 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

    • 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.

    • 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.

  Go to TOP Section VII

  Go to Table of Contents

  ---

  Section VIII: Building and testing 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 (see notes below). Change "Single-Threaded" to "Multithreaded".
        • 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" .

    Notes:

    1. All of the dll project files have "dll" at the end of  their file names.

    2. Static project files don't have "dll" at the end of their file names.

  • 5. Go back to Section II, Step 1 (4), continue to build and test HDF5 library.

  Go to TOP Section VIII

  Go to Table of Contents

  ---

  Section IX: Building and testing HDF5 snapshot release

  ---

  Notes:

  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, 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 successfully 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 Fortran 6.6c

  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 successfully by other compilers.

  • 1. Previous step: section II, step 1(1)

    2. Extra Steps:

    • 1)Follow the steps in Step I to generate H5Tinit.c.
    • 2) Open H5fortran_detect_gen.dsw under directory c:\myHDFstuff\hdf5\windows\misc\H5fortran_detect_gen Build the project file.
    • 3) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
    • type
    • H5fortran_detect_gen.exe > H5fortran_detect.f90
    • 4) Open c:\myHDFstuff\hdf5\windows\misc\fortrantypegen\fortrantypegen.dsw. Build the project file.
    • 5) Invoke command prompt and go to c:\myHDFstuff\hdf5\fortran\src.
    • type
    • H5fortran_detect.exe > H5fort_type_defines.h
    • 6) Open c:\myHDFstuff\hdf5\windows\misc\matchtypegen\matchtypegen.dsw. Build the project file.
    • 7) 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.

  Step III: Go back to section II, step1(3.2)

  Go to TOP Section IX

  Go to Table of Contents

   

  ---

  Section X: How to build HDF5 with Thread-Safe Feature

  ---

  Preconditions:

  • 1. All of the Preconditions in Preconditions.

  • 2. 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.

  • 3. 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).
  •  

  • 4. 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 1

  • #define H5_HAVE_SYSTEM_SCOPE_THREADS 1

  • #if defined TTSAFE_H

  • #define sleep Sleep

  • #endif

  • #endif 

  • */ <----

  • 5. 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.

  • 6. 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 Open workspace all.dsw

  • Invoke Microsoft Visual C++ compiler Invoke Microsoft Visual C++.
  • From the main menu, go to "File" -> "Open Workspace", browse and 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" -> "Add Files to Folder...", browse to add in file "c:\MYHDFSTUFF\hdf5\src\H5TS.c"

  • 1.4 Add 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.7 release 51

  • 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 similar 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.  

  Go to TOP Section X

  Go to Table of Contents

   

  ---

  Section XI: Misc.

  ---

  1. drivers we support

  • 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".

  2.  Helpful Pointers

  • Here are some notes that may be of help if you are not familiar with using the Visual C++ Development Environment.

  • 2.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 two files to be installed in another directory.

  • 2.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

  • 2.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) Follow Project->Settings->Fortran->Category->General->Predefined Preprocess or Symbols, and add "HDF5F90_WINDOWS" to use HDF5 Fortran DLL.

Go to TOP Section XI

Go to Table of Contents

Need further assistance? email to hdfhelp@ncsa.uiuc.edu or go to http://hdf.ncsa.uiuc.edu/windows/questions to get help on windows

Thank  you  for  using  Hierarchical  Data  Format  (HDF)