Instructions for Building and Testing HDF5 from Command Line on Windows XP

Notes:

1. This instruction is written for users who would like to build HDF5 libraries and tools from the HDF5 source code package on command line.

2. Currently, we support:

• (1) Building and testing HDF5 on command line with Microsoft Visual C++ 6.0 and Compaq Visual Fortran 6.0.

• (2) Building and testing HDF5 C and C++ Library on command line with Microsoft Visual C++ .Net (2003)

• (3) Building and testing HDF5 C and C++ Library on command line with Intel C++ Compiler 8.1 integration with Microsoft Visual C++ .Net 2003.

  For all other Windows development tools, HDF5 should be built in the development environment. Please refer to INSTALL_Windows.txt for detailed HDF5 building and installation information, or INSTALL_Windows_short.txt for quick HDF5 building and installation instructions.

• (4) Different compiler is using different batch files on command line to build HDF5 Libraries.

  Compiler Name	Batch File 1		Batch File 2
  MSVS 6.0	hdf5bt.bat		hdf5build.bat
  MSVS .Net	hdf5bt_net.bat		hdf5build_net.bat
  Intel C++	hdf5bt_intelc.bat		hdf5build_intelc.bat

  Be careful to choose the corresponding batch file when you choose a procedure below to build HDF5 Libraries.

3. Please read CAREFULLY about HDF5 build and install preconditions and notes in INSTALL_Windows.txt before starting below procedures.

Preconditions

1. Add WinZip command line support (Optional)

To use WinZip command line utility, you have to install WinZip 9.0 or higher version.

If you want to extract zip files on the command line, you should

• 1.1 Install WinZip command line support add-on 1.1

  Download WinZip command line support add-on 1.1 from http://www.winzip.com and install it.

• 1.2 Add WinZip into environment path

  Open "System" in Control Panel. On the "Advanced" tab, click "Environment Variables", click "Path" in the "System variables" box, then click "Edit" and add your WinZip path (For example C:\Program Files\WinZip) into "Variable Value" and click "OK".

  Notes:

  You can also extract zip files from interactive WinZip interface without the above two steps.

Section I: Building and testing HDF5 with Microsoft Visual C++ 6.0 and Compaq Visual Fortran 6.0.

1. Extra Preconditions:

• 1.1 Set path for Visual C++ 6.0 and Compaq Visual Fortran 6.0

  Open "System" in Control Panel.

  On the "Advanced" tab, click "Environment Variables", click "Path" in the "System variables" box, then click "Edit" and add your Visual C++ 6.0 path (For example, C:\Program Files\Microsoft Visual Studio\Common\MSDev98\Bin\) and Compaq Visual Fortran 6.0 path (For example, C:\Program Files\Microsoft Visual Studio\Common\MSDev98\Bin\) into "Variable Value" and click "OK".

• 1.2 Run batch file copy_hdf.bat.

  Go to c:\MyHDFstuff\hdf5\windows and run copy_hdf.bat.

2. Building and testing HDF5 libraries and tools

We provide 2 options for users to build test HDF5 libraries and tools.

• 2.1 Options A: Build and test in one step

  A batch file named hdf5bt.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build and test HDF5 library and tools together from command line.

  hdf5bt.bat has four options:

  Options	Illustration
  hdf5bt	build and test C library and tools
  hdf5bt enablecpp	build and test C/C++ libraries and tools
  hdf5bt enablefortran	build and test C/Fortran libraries and tools
  hdf5bt enableall	build and test C/C++/Fortran libraries and tools

  Invoke a command prompt window and run hdf5bt with appropriate options.

  Test results are saved in two files:

  • c:\MyHDFstuff\hdf5\hdf5_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 hdf5_results.txt. If some tests failed, check hdf5_results.txt can help you figure out what was wrong.

• 2.2 Options B: Build and test in two steps

  We also provide users with the option to build and test HDF5 libraries and tools seperately.

  • Step 1) Build HDF5 Libraries and Tools

    A batch file named hdf5build.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build HDF5 library and tools from command line.

    hdf5build.bat has four options:

    Options	Illustration
    hdf5build	build C library and tools
    hdf5build enablecpp	build C/C++ libraries and tools
    hdf5build enablefortran	build C/Fortran libraries and tools
    hdf5build enableall	build C/C++/Fortran libraries and tools

    Invoke a command prompt window and run hdf5build with appropriate options. Compiling outputs are saved in c:\MyHDFstuff\hdf5\build_results.txt. You can check the file to find out whether there are any compilation errors.

  • Step 2) Test HDF5 Libraries and Tools

    A batch file named hdf5check.bat in c:\MyHDFstuff\hdf5 directory is provided for users to test HDF5 library and tools from command line.

    hdf5check.bat has four options:

    Options	Illustration
    hdf5check	test C library and tools
    hdf5check enablecpp	test C/C++ libraries and tools
    hdf5check enablefortran	test C/Fortran libraries and tools
    hdf5check enableall	test C/C++/Fortran libraries and tools

    Invoke a command prompt window and run hdf5check with appropriate options.

    Test results are saved into file:

    • c:\MyHDFstuff\hdf5\check_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.

  3. Installing HDF5 Libraries

  Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib directory.

  For further information, please refer to INSTALL_WINDOWS.txt.

  ---

  SECTION II: Building and testing HDF5 C and C++ Library with Microsoft Visual C++ .Net 2003

  ---

  1. Extra Preconditions:

  • 1.1 Microsoft Visual C++ .Net 2003 Installed

  • 1.2 Command-based script host (CScript.exe) installed

    Cscript.exe is a command-line version of the Windows Script Host. Users can check windows system directory to make sure Cscript.exe installed. Cscript.exe will be used during converting project files from MSVS 6.0 Format to Visual C++ .Net 2003 format from command line.

  • 1.3 Set path for Microsoft Visual C++ .Net

    Open "System" in Control Panel.

    On the "Advanced" tab, click "Environment Variables", click "Path" in the "System variables" box, then click "Edit" and add your Visual C++ .Net path (For example, C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\IDE) into "Variable Value" and click "OK".

  • 1.4 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 and text files saved under c:\MyHDFstuff\hdf5\windows directory to the directories where they will be used.

  • 1.5 Convert project files format from MSVS 6.0 to MSVS .Net

    Go to directory c:\MyHDFstuff\hdf5 and run convert_to_vcproj.bat in the following format:

    • convert_to_vcproj "Absolute path of directory hdf5"

    For example:

    • convert_to_vcproj c:\MyHDFstuff\hdf5

    The converting results will be saved into file convert.log under the directory c:\MyHDFstuff\hdf5. The messages should look like

    • Converting: c:\MyHDFstuff\hdf5\windows\proj\all\all.dsp
    • New Project Name: c:\MyHDFstuff\\hdf5\windows\proj\all\all.vcproj

    Notes:

    all.sln was provided with HDF5-1.8.0 Release. Users don't need to convert the workspace from MSVS 6.0 format to MSVS .Net Format

  2. Building HDF5 C and C++ Libraries :

  We provide 2 options for users to build HDF5 libraries and tools.

  • 2.1 Options A: Build and test in one step

    A batch file named hdf5bt_net.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build and test HDF5 library and tools together from command line.

    hdf5bt_net.bat has two options:

    Options	Illustration
    hdf5bt_net	build and test C library and tools
    hdf5bt_net enablecpp	build and test C/C++ libraries and tools

    Invoke a command prompt window and run hdf5bt_net with appropriate options.

    Test results are saved in two files:

    • c:\MyHDFstuff\hdf5\hdf5_results_net.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 hdf5_results_net.txt. If some tests failed, check hdf5_results_net.txt can help you figure out what was wrong.

  • 2.2 Options B: Build and test in two steps

    We also provide users with the option to build and test HDF5 libraries and tools seperately.

    • Step 1) Build HDF5 Libraries and Tools

      A batch file named hdf5build_net.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build HDF5 library and tools from command line.

      hdf5build_net.bat has two options:

      Options	Illustration
      hdf5build_net	build C library and tools
      hdf5build_net enablecpp	build C/C++ libraries and tools

      Invoke a command prompt window and run hdf5build_net with appropriate options. building results will be saved in c:\MyHDFstuff\hdf5\build_results_net.txt. You can check the file to find out whether there are any compilation errors.

    • Step 2) Build HDF5 Libraries and Tools

      Go to directory, run batch file hdf5check with the following options:

      Options	Illustration
      hdf5check	test HDF5 C library and tools
      hdf5check enablecpp	test HDF5 C/C++ libraries and tools

      Notes:

      hdf5check.bat has ONLY TWO options listed above in this case.

      Testing results will be saved in c:\MyHDFstuff\hdf5\check_results.txt. There should be no failures at all.

  3. Installing HDF5 Libraries

  Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib directory.

  ---

  SECTION III: Building and testing HDF5 C and C++ Library with Intel C++ Compiler 8.1 integration with Microsoft Visual C++ .Net 2003

  ---

  1. Extra Preconditions:

  • 1.1 Set path for Microsoft Visual C++ .Net and Intel C++ 8.1

    Open "System" in Control Panel.

    On the "Advanced" tab, click "Environment Variables", click "Path" in the "System variables" box, then click "Edit" and add your Visual C++ .Net path (For example, C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\IDE) and Intel C++ 8.1 path (For example, C:\Program Files\Intel\CPP\Compiler80\Ia32\Bin) into "Variable Value" and click "OK".

  • 1.2 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 and text files saved under c:\MyHDFstuff\hdf5\windows directory to the directories where they will be used.

  • 1.3 Convert project files format from MSVS 6.0 to MSVS .Net Format

    Go to directory c:\MyHDFstuff\hdf5 and run convert_to_vcproj.bat in the following format:

    • convert_to_vcproj "Absolute path of directory hdf5"

    For example:

    • convert_to_vcproj c:\MyHDFstuff\hdf5

    The converting results will be saved into file convert.log under the directory c:\MyHDFstuff\hdf5. The messages should look like

    • Converting: c:\MyHDFstuff\hdf5\windows\proj\all\all.dsp
    • New Project Name: c:\MyHDFstuff\\hdf5\windows\proj\all\all.vcproj

  2. Building HDF5 C and C++ Libraries :

  We provide 2 options for users to build HDF5 libraries and tools.

  • 2.1 Options A: Build and test in one step

    A batch file named hdf5bt_intelc.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build and test HDF5 library and tools together from command line.

    hdf5bt_intelc.bat has two options:

    Options	Illustration
    hdf5bt_intelc	build and test C library and tools
    hdf5bt_intelc enablecpp	build and test C/C++ libraries and tools

    Invoke a command prompt window and run hdf5bt_intelc with appropriate options.

    Test results will be saved in two files:

    • c:\MyHDFstuff\hdf5\hdf5_results_intelc.txt
    • c:\MyHDFstuff\hdf5\tests_results.txt.

    Project conversion results from MSVS .Net format to Intel C++ fomat will be saved in

    • c:\MyHDFstuff\hdf5\convert_intel.txt

    Check convert_intel.txt to see if all of the project files have been converted successfully. Conversion messages should look like:

    • "projname.vcproj": has been converted from Microsoft VC++ project system to the Intel C++ 8.x project system.

    In general, you only need to check tests_results.txt. If all the tests passed, then you do not have to check hdf5_results_intelc.txt. If some tests failed, check hdf5_results_intelc.txt can help you figure out what was wrong.

  • 2.2 Options B: Build and test in two steps

    We also provide users with the option to build and test HDF5 libraries and tools seperately.

    • Step 1) Build HDF5 Libraries and Tools

      A batch file named hdf5build_intelc.bat in c:\MyHDFstuff\hdf5 directory is provided for users to build HDF5 library and tools from command line.

      hdf5build_intelc.bat has two options:

      Options	Illustration
      hdf5build_intelc	build C library and tools
      hdf5build_intelc enablecpp	build C/C++ libraries and tools

      Invoke a command prompt window and run hdf5build_intelc with appropriate options. Compiling outputs are saved in c:\MyHDFstuff\hdf5\build_results_intelc.txt. You can check the file to find out whether there are any compiling errors.

    • Step 2) Testing HDF5 Libraries and Tools

      Go to directory, run batch file hdf5check with the following options:

      Options	Illustration
      hdf5check	test HDF5 C library and tools
      hdf5check enablecpp	test HDF5 C/C++ libraries and tools

      Notes:

      hdf5check.bat has ONLY TWO options listed above in this case.

      Testing results will be saved in c:\MyHDFstuff\hdf5\check_results.txt. There should be no failures at all.

  3. Installing HDF5 Libraries

  Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to install all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib directory.

  ---

  Thank you for using Hierarchical Data Format (HDF). For users who need further assistance, please send email to hdfhelp@ncsa.uiuc.edu