summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorXuan Bai <xuanbai@hdfgroup.org>2004-11-02 22:22:53 (GMT)
committerXuan Bai <xuanbai@hdfgroup.org>2004-11-02 22:22:53 (GMT)
commit41e6f46c3f321877d43f3eb4065c048d9fc20e3e (patch)
treedf180a30bdf1ec8ea5eb583ab8220cc8179b6d28
parent82412dfbc75054cb6150cd44a4e10e9bc922f8a9 (diff)
downloadhdf5-41e6f46c3f321877d43f3eb4065c048d9fc20e3e.zip
hdf5-41e6f46c3f321877d43f3eb4065c048d9fc20e3e.tar.gz
hdf5-41e6f46c3f321877d43f3eb4065c048d9fc20e3e.tar.bz2
[svn-r9499] Purpose:
Update. Description: Update HDF5 Windows installation documenations to include information about HDF5 Fortran DLL, HDF5 C/C++/Fortran examples. Solution: Platforms tested: Not Necessary. Misc. update:
-rw-r--r--release_docs/INSTALL_Windows.txt548
-rwxr-xr-xrelease_docs/INSTALL_Windows_Short.txt16
2 files changed, 359 insertions, 205 deletions
diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt
index 505152f..9d3d542 100644
--- a/release_docs/INSTALL_Windows.txt
+++ b/release_docs/INSTALL_Windows.txt
@@ -6,7 +6,7 @@ HDF website (http://hdf.ncsa.uiuc.edu) is used.
***************************WARNINGS*************************************
-Please read CAREFULLY about the following preconditions and notes first
+Please read CAREFULLY about the following preconditions and notes first.
Preconditions
@@ -36,28 +36,28 @@ Preconditions
c:\ (any drive)
MyHDFstuff\ (any folder name)
- 3. Download the hdf5-1.6.3 source code package and use WinZip to
+ 3. Download the hdf5-1.6.x source code package and use WinZip to
extract the HDF5 package into c:\MyHDFstuff. This creates a
- directory called 'hdf5-1.6.3' under MyHDFstuff which contains
- several files and directories. Rename "hdf5-1.6.3" to "hdf5".
+ directory called 'hdf5-1.6.x' under MyHDFstuff which contains
+ several files and directories. Rename "hdf5-1.6.x" to "hdf5".
4. HDF5 provide options to do in-memory compress within HDF5
- library. Currently, two external compression libraries zlib and
- szlib can be used with HDF5.
+ library. Currently, two external compression libraries Zlib and
+ Szlib can be used with HDF5.
- 4.1 HDF5 uses zlib version 1.1.4 for compression and zlib is NOT
- distributed with HDF5 lib in 1.6.3 release. To use zlib
- library, you have to install your own zlib library or go to
+ 4.1 HDF5 uses Zlib version 1.1.4 for compression and Zlib is NOT
+ distributed with HDF5 lib in 1.6.x release. To use Zlib
+ library, you have to install your own Zlib library or go to
HDF web site
(ftp://ftp.ncsa.uiuc.edu/HDF/gzip/bin/windows/zlib114/)
- to download the zlib library.
+ to download the Zlib library.
- 4.2 HDF5 uses szlib(szip) for compression and szlib is
- distributed with HDF5 lib starting from 1.6.2 binary
- release. You can also download szlib source codes and
- binaries from ftp://ftp.ncsa.uiuc.edu/HDF/szip/bin/windows.
- Please note that szip is not a totally open-source free
- software. For licensing issue of szip, please check
+ 4.2 HDF5 uses Szlib(Szip) for compression and Szlib compression
+ software is provided with HDF5 products starting from 1.6.0
+ release. You can download Szlib source codes and binaries
+ from ftp://ftp.ncsa.uiuc.edu/HDF/szip/bin/windows.
+ Please note that Szip is not a totally open-source free
+ software. For licensing issue of Szip, please check
"Licensing terms" at
http://hdf.ncsa.uiuc.edu/doc_resource/SZIP/index.html.
@@ -71,9 +71,9 @@ Preconditions
HDF5_EXT_ZLIB_DLL
HDF5_EXT_SZIP_DLL
- In this section, zlib and szip 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.
+ In this section, Zlib and Szip compression software 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:
@@ -85,8 +85,8 @@ Preconditions
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 zlib.lib, then click OK.
+ In the New Variable window, set "Variable name" as HDF5_EXT_ZLIB
+ and "Variable value" as zlib.lib, then click OK.
Similarly, you can set:
@@ -98,13 +98,13 @@ Preconditions
Notes:
a. When setting environment variables, only include path for
- the zlib DLL library, as the zlib static and DLL libraries
+ the Zlib DLL library, as the Zlib static and DLL libraries
share the same name -- zlib.lib. For all other
environment variables, you MUST NOT include the path.
Otherwise, some of HDF5 tools tests will get unexpected
results.
- b. If the zlib DLL library path is not C:\zlib114\dll, replace
+ b. If the Zlib DLL library path is not c:\zlib114\dll, replace
it with the correct path in the HDF5_EXT_ZLIB_DLL
environment variable.
@@ -114,33 +114,33 @@ Preconditions
d. By default, c:\zlib114\dll\zlib.dll and
c:\szlib\dll\szibdll.dll should be copied into the location
that the application can find, one suggestion is to use the
- C:\WINNT\system or C:\WINDOWS\system directory before
+ c:\WINNT\system or c:\WINDOWS\system directory before
using DLLs.
6. Set up path for external libraries and headers
- Skip this part if you don't want to use any compression features
+ Skip this part if you don't want to use ANY compression feature
provided by HDF5. Please do read section V.
- You have to read this part is you want to only use gzip or szip.
- You also need to read section V.
+ You have to read this part even if you want to only use Zlib
+ or Szlib. You also need to read section V.
Invoke Microsoft Visual C++ and go to "Tools" and select
"Options", find "Directories";
6.1 Find the box "Show directories for", choose
"Include files",
- If you cannot find your zlib and szlib header path
- (for example, C:\zlib114\include, C:\szlib\include)
+ If you cannot find your Zlib and Szlib header path
+ (for example, c:\zlib114\include, c:\szlib\include)
from the directory list, add the header path
- (C:\zlib114\include, C:\szlib\include) to the
+ (c:\zlib114\include, c:\szlib\include) to the
included directories.
6.2 Find the box "Show directories for", choose "Library files",
- If you cannot find your zlib and szlib library path
- (for example, C:\zlib114\lib, C:\szlib\lib, C:\szlib\dll)
+ If you cannot find your Zlib and Szlib library path
+ (for example, c:\zlib114\lib, c:\szlib\lib, c:\szlib\dll)
from the directory list, add the library path
- (C:\zlib114\lib, C:\szlib\lib, C:\szlib\dll) to the
+ (c:\zlib114\lib, c:\szlib\lib, c:\szlib\dll) to the
library directories.
Notes
@@ -152,7 +152,7 @@ Notes
want to know HDF5 building and installation details, please
read INSATLL_Windows_Short.txt.
- 3. For users who would like to build and test HDF5 package on
+ 3. For users who would like to build and test HDF5 package from the
command line, please read INSATLL_Windows_From_Command_Line.txt.
4. HDF4-related tools are not built and released with HDF5 library
@@ -177,7 +177,7 @@ The following sections discuss installation procedures in detail:
Section III: How to build an application using the HDF5 library
or DLL
Section IV: Helpful pointers
- Section V: How to disable gzip(zlib)/szip compression
+ Section V: How to disable Gzip(Zlib)/Szip compression
Section VI: How to build in HDF5 in VS 7.0(.NET)
Section VII: How to build and test HDF5 snapshot release
Section VIII: Misc.
@@ -215,7 +215,7 @@ Section I: What do we build and install?
3. Examples (Not included in the binary distribution)
HDF5 examples:
- simple HDF5 C examples
+ simple HDF5 C/C++/Fortran examples
************************************************************************
@@ -228,13 +228,13 @@ STEP 1: Building HDF5 libraries and tools
Unpack all.zip in c:\MyHDFstuff\hdf5\windows directory. Files in
all.zip has path hdf5\.... Make sure that you extract files into
- the C:\myHDFstuff directory.
+ the c:\MyHDFstuff directory.
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\proj\all\all.dsw workspace.
+ c:\MyHDFstuff\hdf5\proj\all\all.dsw workspace.
You should find windows project files listed as "all files,
big files etc." on the left.
@@ -259,17 +259,22 @@ STEP 1: Building HDF5 libraries and tools
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
-
- Note: HDF5 Fortran DLL currently does not work with
- DEC Fortran 6.0 and Intel compiler.
-
+ testhdf5_fortrandll
+
3.3 Skip this step if you are not using Intel compilers
a. Intel C Compiler
@@ -282,33 +287,33 @@ STEP 1: Building HDF5 libraries and tools
Go to Tools-->Customize-->Add-ins and Macro Files
and check Intel Fortran Compiler Build Tool
- Note: szip library is different when using Intel compiler.
- You should build szip source codes with Intel
+ Note: 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/bin/windows.
- The szip library and header path should also be
+ The Szip library and header path should also be
set up accordingly (refer to precondition 6).
4. Select "Build", then Select "Set Active Configuration".
In "Project configurations", select the active configuration
- "all -- Win32 Debug" to build debug versions of
- single-threaded static libraries, Debug
- multithreaded DLLs and tests.
+ "all -- Win32 Debug" to build debug versions of
+ single-threaded static libraries, Debug
+ multithreaded DLLs and tests.
- or
+ or
- "all -- Win32 Release" to build release versions of
- single-threaded static libraries,
- multithreaded DLLs and tests.
+ "all -- Win32 Release" to build release versions of
+ single-threaded static libraries,
+ multithreaded DLLs and tests.
- Then build project "all".
+ Then build project "all".
- Warning messages can be ignored.
+ Warning messages can be ignored.
- When the debug or release build is done the directories
- listed below will contain the following files:
+ When the debug or release build is done the directories
+ listed below will contain the following files:
c:\MyHDFstuff\hdf5\proj\hdf5\debug -
@@ -358,7 +363,7 @@ STEP 1: Building HDF5 libraries and tools
where tools are located
The directories listed below will contain the following files
- ONLY when you choose to build HDF5 c++ libraries:
+ ONLY when you choose to build HDF5 C++ libraries:
c:\MyHDFstuff\hdf5\proj\hdf5_cpp\debug -
@@ -383,11 +388,23 @@ STEP 1: Building HDF5 libraries and tools
c:\MyHDFstuff\hdf5\proj\hdf5_fortran\debug -
- hdf5_fortran.lib- the HDF5 Fortran API static library
+ 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 -
@@ -399,6 +416,32 @@ STEP 1: Building HDF5 libraries and tools
hdf5_f90cstub.lib- the HDF5 C and Fortran stub static
library
+ c:\MyHDFstuff\hdf5\proj\hdf5_f90sctubdll\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\proj\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\proj\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\proj\libtest_fortran\debug -
libtest_fortrand.lib- the HDF5 Fortran test static
@@ -408,7 +451,19 @@ STEP 1: Building HDF5 libraries and tools
libtest_fortran.lib- the HDF5 Fortran test static
library
-
+
+ c:\MyHDFstuff\hdf5\proj\libtest_fortrandll\debug -
+
+ libtest_fortranddll.dll- the HDF5 Fortran test DLL
+ libtest_fortranddll.lib- the HDF5 Fortran test DLL
+ export library
+
+ c:\MyHDFstuff\hdf5\proj\libtest_fortran\release -
+
+ libtest_fortrandll.dll- the HDF5 Fortran test DLL
+ libtest_fortrandll.lib- the HDF5 Fortran test DLL
+ export library
+
STEP 2: Testing HDF5 libraries and tools
@@ -465,10 +520,10 @@ We provide 2 options for users to test HDF5 libraries and tools.
They are:
- release version
- release dll version
- debug version
- debug dll version
+ 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
@@ -481,7 +536,7 @@ We provide 2 options for users to test HDF5 libraries and tools.
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\release\hdf5dll.dll
hdf5\proj\hdf5dll\debug\hdf5ddll.dll
hdf5\test\libtestD\release\libtestD.dll
hdf5\test\libtestD\debug\libtestDd.dll
@@ -530,7 +585,6 @@ We provide 2 options for users to test HDF5 libraries and tools.
type:
hdf5timingtest debug dll >"Your output filename"
-
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
@@ -590,30 +644,44 @@ We provide 2 options for users to test HDF5 libraries and tools.
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\proj\libtest_cstubdll\release\libtest_cstubdll.dll
+ hdf5\proj\libtest_cstubdll\debug\libtest_cstubddll.dll
+ hdf5\proj\libtest_fortrandll\release\libtest_fortrandll.dll
+ hdf5\proj\libtest_fortrandll\debug\libtest_fortranddll.dll
Run testhdf5_fortran.bat at the command prompt as below:
testhdf5_fortran release >"Your output filename"
+ testhdf5_fortran release dll >"Your output filename"
testhdf5_fortran debug >"Your output filename"
+ testhdf5_fortran debug dll >"Your output filename"
Use Notepad or WordPad to check results. You should
not find any FAILED marks in your output files.
-
- Note: Now we only support Fortran static libraries.
-
+
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 1). The file is called
+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.
+file, you may see a folder called hdf5lib under c:\MyHDFstuff\hdf5.
The <release> layout of <hdf5lib> should be:
@@ -628,66 +696,85 @@ You may also find the similar layout for the <debug>.
STEP 4: Building HDF5 C/C++/Fortran examples (Optional)
-Several simple examples have been provided for users to test
-HDF5 C/C++/Fprtran library and tools.
+Simple examples have been provided for users to test HDF5
+C/C++/Fortran library and tools.
+
+Note:
+ 1) To build HDF5 C++ examples, HDF5 C++ library must have been
+ built in step I.
-To build and test HDF5 C example:
+ 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.
+
+To build and test HDF5 C examples:
1. Invoke Microsoft Visual C++, go to "File" and select
the "Open Workspace" option.
Then open the workspace
- c:\myHDFstuff\hdf5\examples\allexamples\allexamples.dsw.
+ c:\MyHDFstuff\hdf5\examples\allexamples\allexamples.dsw.
2. Select "Build", then Select "Set Active Configuration".
In "Project configurations", select the active configuration
- "allexamples -- Win32 Debug" to build debug versions of the
- examples.
+ "allexamples -- Win32 Debug" to build debug versions of the
+ C examples.
- or
+ or
- "allexamples -- Win32 Release" to build release versions the
- examples.
+ "allexamples -- Win32 Release" to build release versions the
+ C examples.
When the debug build or release build is done, there should be the
- following subdirectories in C:\myHDFstuff\hdf5\examples\
+ following subdirectories in c:\MyHDFstuff\hdf5\examples\
attributetest
-
+ attributetestdll
chunkread
-
+ chunkreaddll
compoundtest
-
+ compoundtestdll
extendwritetest
-
+ extendwritetestdll
grouptest
-
+ grouptestdll
readtest
-
+ readtestdll
selecttest
-
+ selecttestdll
writetest
+ writetestdll
3. Invoke a command prompt window and run the batch file
- "InstallExamples.bat" which resides in the top level directory
- (C:\MyHDFstuff\hdf5). This file creates 2 new directories,
- examplesREL and examplesDBG, in the C:\MyHDFstuff\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.
+ 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 the
- examples.
+ in c:\MyHDFstuff\hdf5\examples directory for you to test HDF5
+ C examples.
- testExamples.bat batch file has two options:
+ testExamples.bat batch file has 4 options:
- testExamples release -- test release version of the examples
+ testExamples release -- for release version
- testExamples debug -- test debug version of the examples
+ 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
@@ -695,7 +782,7 @@ To build and test HDF5 C example:
the difference between the expected outputs and actual outputs
will be given.
-To build and test HDF5 C++ example:
+To build and test HDF5 C++ examples:
1. Invoke Microsoft Visual C++, go to "File" and select
the "Open Workspace" option.
@@ -707,49 +794,54 @@ To build and test HDF5 C++ example:
In "Project configurations", select the active configuration
- "allcppexamples -- Win32 Debug" to build debug versions of the
- examples.
+ "allcppexamples -- Win32 Debug" to build debug versions of the
+ C++ examples.
- or
+ or
- "allcppexamples -- Win32 Release" to build release versions the
- examples.
+ "allcppexamples -- Win32 Release" to build release versions the
+ C++ examples.
When the debug build or release build is done, there should be the
- following subdirectories in C:\myHDFstuff\hdf5\c++\examples\
+ following subdirectories in c:\MyHDFstuff\hdf5\c++\examples\
chunkstest
-
+ chunkstestdll
compoundtest
-
+ compoundtestdll
createtest
-
+ createtestdll
extend_dstest
-
+ extend_dstestdll
h5grouptest
-
+ h5grouptestdll
readdatatest
-
+ readdatatestdll
writedatatest
+ writedatatestdll
3. Invoke a command prompt window and run the batch file
- "InstallcppExamples.bat" which resides in the top level directory
- (C:\MyHDFstuff\hdf5). This file creates 2 new directories,
- cppexamplesREL and cppexamplesDBG, 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.
-
+ 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\examples directory for you to test the
- examples.
+ c:\MyHDFstuff\hdf5\c++\examples directory for you to test HDF5
+ C++ examples.
- testcppExamples.bat batch file has two options:
+ testcppExamples.bat batch file has 4 options:
+
+ testcppExamples release -- for release version
- testcppExamples release -- test release version of the examples
+ testcppExamples release dll -- for release DLL version
- testcppExamples debug -- test debug version of the examples
+ 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
@@ -757,114 +849,137 @@ To build and test HDF5 C++ example:
the difference between the expected outputs and actual outputs
will be given.
-To build and test HDF5 C++ example:
+To build and test HDF5 Fortran example:
1. Invoke Microsoft Visual C++, go to "File" and select
the "Open Workspace" option.
Then open the workspace
- c:\myHDFstuff\hdf5\fortran\examples\allf90examples\allf90examples.dsw.
+ c:\MyHDFstuff\hdf5\fortran\examples\allf90examples\allf90examples.dsw.
2. Select "Build", then Select "Set Active Configuration".
In "Project configurations", select the active configuration
- "allf90cppexamples -- Win32 Debug" to build debug versions of the
- examples.
+ "allf90cppexamples -- Win32 Debug" to build debug versions of the
+ Fortran examples.
- or
+ or
- "allf90cppexamples -- Win32 Release" to build release versions the
- examples.
+ "allf90cppexamples -- Win32 Release" to build release versions the
+ Fortran examples.
When the debug build or release build is done, there should be the
- following subdirectories in C:\myHDFstuff\hdf5\fortran\examples\
+ following subdirectories in c:\MyHDFstuff\hdf5\fortran\examples\
attreexampletest
-
+ attreexampletestdll
compoundtest
-
+ compoundtestdll
dsetexampletest
-
+ dsetexampletestdll
fileexampletest
-
+ fileexampletestdll
groupexampletest
-
+ groupexampletestdll
grpdsetexampletest
-
+ grpdsetexampletestdll
grpittest
-
+ grpittestdll
grpsexampletest
-
+ grpsexampletestdll
hyperslabtest
-
+ hyperslabtestdll
+ mountexampletest
mountexampletest
-
refobjexampletest
-
+ refobjexampletestdll
refregexampletest
-
+ refregexampletestdll
rwdsetexampletest
-
+ rwdsetexampletestdll
selecteletest
+ selecteletestdll
3. Invoke a command prompt window and run the batch file
- "Installf90Examples.bat" which resides in the top level directory
- (C:\MyHDFstuff\hdf5). This file creates 2 new directories,
- f90examplesREL and f90examplesDBG, 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.
+ 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.
************************************************************************
Section III: Building an application using the HDF5 library or DLL
========================================================================
+Waring: The instructions below will only describe how to build an
+ application using the release version of the HDF5 library or
+ DLL. To use the debug version of the HDF5 library or DLL, you
+ need to substitute the release version of the HDF5 library or
+ DLL with the debug version.
-If you are building an application that uses the HDF5 library the
-following locations will need to be specified for locating header files
-and linking in the HDF libraries:
+To use HDF5 static library
- <top-level HDF5 directory>\src
+ To build an application that uses the HDF5 static library the
+ following locations will need to be specified for locating header
+ files and linking with the HDF static library, for example:
-where <top-level HDF5 directory> may be
+ c:\MyHDFstuff\hdf5\hdf5lib\include
+ c:\MyHDFstuff\hdf5\hdf5lib\release\lib
- C:\MyHDFstuff\hdf5\
+ if you have installed HDF5 library in Section II, step 3.
-We assume that you will use gzip and szip compression with HDF5 library.
+ We assume that you will use Zlib and Szip compression with HDF5
+ library.
-To specify this location in the settings for your VC++ project, you may
-choose one of the following two methods.
+ To specify these locations in the settings for your VC++ project,
+ you may choose one of the following two methods.
- 1)
- To insert the path that specifics HDF5 and zlib, szlib header files:
+ 1) Method One
- 1. Open your VC project in Microsoft Visual C++ and make sure it is
- the active project.
+ To insert the path that specifies HDF5 and Zlib, Szlib header files:
- 2. Go to the Project menu and chose the 'Settings' option.
+ 1. Open your VC++ project in Microsoft Visual C++ and make sure it
+ is the active project.
- 3. Chose the build configuration you would like to modify in the
- drop down menu labeled with 'Settings For:'
+ 2. Go to the Project menu and chose the "Settings" option.
- 4. Chose the C/C++ tab
+ 3. Choose the build configuration you would like to modify in the
+ drop down menu labeled with "Settings For:"
- 5. At the bottom of the window, there should be a text-area labeled
- with 'Project Options:'. In this text-area, scroll until you
- reach the end and type /I "<top-level HDF5 directory>\src" and
- then click OK.
+ 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 Szlib header files directories. For example:
+
+ c:\MyHDFstuff\hdf5\hdf5lib\include
+ c:\zlib114\include
+ c:\szlib\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\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.
+ 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.
+ 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)'
+ 3. Change the "Files of type:" to "Library Files (.lib)"
4. Navigate through the directories until you find the location of
the hdf5.lib.
@@ -873,15 +988,38 @@ choose one of the following two methods.
6. repeat 1-5, to select zlib.lib and szlib.lib.
- 2)
- Go to tools/options/directories,
+ 7. (optional) repeat 1-5, to select hdf5_cpp.lib to link with HDF5
+ C++ static library.
- 1. Insert the correct HDF5,zlib,szlib paths for both headers(include)
- and libraries.
- 2. Go to the Project menu and choose the 'Settings' option.
- 3. Find the "link" option and "Input" category, insert
+ 8. (optional) repeat 1-5, to select hdf5_fortran.lib to link with
+ HDF5 Fortran static library.
+
+ 2) Method Two
+
+ 1. Go to Tools->Options->Directories,
+
+ 2. Insert the correct HDF5, Zlib, Szlib paths for both headers(include)
+ and libraries. For example,
+
+ c:\MyHDFstuff\hdf5\hdf5lib\include
+ c:\MyHDFstuff\hdf5\hdf5lib\lib
+ c:\zlib114\include
+ c:\zlib114\lib
+ c:\szlib\include
+ c:\szlib\lib
+
+ 3. Go to the Project menu and choose the "Settings" option.
+
+ 4. Find the "link" option and "Input" category, insert
"zlib.lib, szlib.lib, hdf5.lib".
+ 5. (Optional) repeat 3-4, to insert "hdf5_cpp.lib" if you want to
+ use HDF5 C++ static library.
+
+ 6. (Optional) repeat 3-4, to insert "hdf5_fortran.lib" if you want to
+ use HDF5 Fortran static library.
+
+
To use the DLL:
1. Follow the steps for specifying the location of the header files
@@ -889,8 +1027,9 @@ To use the DLL:
2. Follow the steps for linking the HDF5 library as shown above
except now link the export library that is created with the DLL.
- The export library is called hdf5dll.lib or hdf5ddll.lib for
- debug version.
+ 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
@@ -961,20 +1100,27 @@ DLL... hints:
PreProcessor
Find PreProcessor definations and Add _HDF5USEDLL_ at the
- end of the PreProcessor definitions.
+ 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.
************************************************************************
-Section V: How to disable gzip(zlib)/szip compression
+Section V: How to disable Gzip(Zlib)/Szip compression
Warning: When you modify the H5pubconf.h file as described below,
DO NOT just change the values of these macros from 1 to 0.
Please DO remove(or comment out) appropriate lines.
- 1. Disable gzip compression
+ 1. Disable Gzip compression
- If you would like to remove gzip compression from the HDF5
+ 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
@@ -993,7 +1139,7 @@ Warning: When you modify the H5pubconf.h file as described below,
1.4 Run-compile HDF5 library according to section II.
- When you disable gzip, you may get the following message
+ When you disable Gzip, you may get the following message
when building HDF5 libraries:
The following environment variables were not found
@@ -1002,9 +1148,9 @@ Warning: When you modify the H5pubconf.h file as described below,
This message can be ignored.
- 2. Disable szip compression (both encoder and decoder)
+ 2. Disable Szip compression (both encoder and decoder)
- If you would like to remove szip compression from the HDF5
+ 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
@@ -1028,7 +1174,7 @@ Warning: When you modify the H5pubconf.h file as described below,
2.5 Run-compile HDF5 library according to section II.
- When you disable szip, you may get the following message
+ When you disable Szip, you may get the following message
when building HDF5 libraries:
The following environment variables were not found
@@ -1039,21 +1185,21 @@ Warning: When you modify the H5pubconf.h file as described below,
Note:
- To disable gzip and szip at the same time, just follow 1.1~1.3
+ To disable Gzip and Szip at the same time, just follow 1.1~1.3
and 2.1~2.4 and run-compile HDF5 library according to section II.
- 3. Disable szip encoder
+ 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
+ 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
+ 3.1 Download Szip library without encoder
- szip library is different if you want to disable szip encoder.
+ Szip library is different if you want to disable Szip encoder.
Download szip_noencoder binaries from
ftp://ftp.ncsa.uiuc.edu/HDF/szip/bin/windows.
- The szip library and header path should also be set up
+ The Szip library and header path should also be set up
accordingly (refer to precondition 6).
3.2 Open the H5pubconf.h file from the c:\MyHDFstuff\hdf5\src
diff --git a/release_docs/INSTALL_Windows_Short.txt b/release_docs/INSTALL_Windows_Short.txt
index 8232b79..534e579 100755
--- a/release_docs/INSTALL_Windows_Short.txt
+++ b/release_docs/INSTALL_Windows_Short.txt
@@ -9,8 +9,9 @@ Note: This short instruction is written for users who want to quickly
trouble following any steps in the instructions, please refer to
INSTALL_Windows.txt for further information.
- For users who would like to build and test HDF5 package on command
- line, please refer to INSATLL_Windows_From_Command_Line.txt.
+ For users who would like to build and test HDF5 package from the
+ command line, please refer to
+ INSATLL_Windows_From_Command_Line.txt.
***************************WARNINGS*************************************
Please read CAREFULLY about HDF5 build and install preconditions and
@@ -22,11 +23,11 @@ STEP 1: Building HDF5 Libraries and Tools
1. Unpack all.zip
Unpack all.zip in c:\MyHDFstuff\hdf5\windows into the
- C:\myHDFstuff directory.
+ c:\MyHDFstuff directory.
2. Open all.dsw workspace
- Open the c:\myHDFstuff\hdf5\proj\all\all.dsw workspace.
+ Open the c:\MyHDFstuff\hdf5\proj\all\all.dsw workspace.
3. (Optional) Add C++ and/or FORTRAN related projects
@@ -44,11 +45,18 @@ STEP 1: Building HDF5 Libraries and Tools
ONLY if you want to build HDF5 FORTRAN libraries
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
4. Select "Build", then Select "Set Active Configuration".