summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorXuan Bai <xuanbai@hdfgroup.org>2005-02-09 23:33:38 (GMT)
committerXuan Bai <xuanbai@hdfgroup.org>2005-02-09 23:33:38 (GMT)
commit8f487df795e862e81f0be215448a70b77d56c157 (patch)
tree5498637aea64ab8691c1fa4940e9eac486dbb9d0 /release_docs
parent9f76f83f48271a3966e0afdaf25fcc412b402d4d (diff)
downloadhdf5-8f487df795e862e81f0be215448a70b77d56c157.zip
hdf5-8f487df795e862e81f0be215448a70b77d56c157.tar.gz
hdf5-8f487df795e862e81f0be215448a70b77d56c157.tar.bz2
[svn-r9974] Purpose:
Update. Description: Update installation file on how to link HDF5 with Zlib 1.2.2 and Szip 2.0 DLL libraries. Solution: Platforms tested: Misc. update:
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_Windows.txt200
1 files changed, 53 insertions, 147 deletions
diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt
index 35ac5b8..36c4f7f 100644
--- a/release_docs/INSTALL_Windows.txt
+++ b/release_docs/INSTALL_Windows.txt
@@ -36,26 +36,30 @@ Preconditions
c:\ (any drive)
MyHDFstuff\ (any folder name)
- 3. Download the hdf5-1.6.x source code package and use WinZip to
+ 3. Download the hdf5-1.8.x source code package and use WinZip to
extract the HDF5 package into c:\MyHDFstuff. This creates a
- directory called 'hdf5-1.6.x' under MyHDFstuff which contains
- several files and directories. Rename "hdf5-1.6.x" to "hdf5".
+ 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
- Szlib can be used with HDF5.
+ Szip 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.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/)
+ 4.1 HDF5 uses Zlib version 1.2.2 for compression and Zlib is NOT
+ distributed with HDF5 library in 1.6.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/bin/windows
to download the Zlib library.
+
+ Note: Zlib 1.2.2 DLL library can also be downloaded from
+ http://www.zlib.net/zlib122-dll.zip
- 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.
+ 4.2 HDF5 uses Szip version 2.0 for compression and Szip
+ compression software is provided with HDF5 products starting
+ from 1.6.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/bin/windows
+
Please note that Szip is not a totally open-source free
software. For licensing issue of Szip, please check
"Licensing terms" at
@@ -67,9 +71,6 @@ Preconditions
HDF5_EXT_ZLIB
HDF5_EXT_SZIP
- HDF5_SZIP_ENCODE
- HDF5_EXT_ZLIB_DLL
- HDF5_EXT_SZIP_DLL
In this section, Zlib and Szip compression software are assumed
to be used. Please read section V as well as this section if you
@@ -86,36 +87,21 @@ Preconditions
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.
+ and "Variable value" as zdll.lib, then click OK.
Similarly, you can set:
- HDF5_EXT_SZIP environment variable as szlib.lib
- HDF5_SZIP_ENCODE environment variable as 1
- HDF5_EXT_ZLIB_DLL environment variable as c:\zlib114\dll\zlib.lib
- HDF5_EXT_SZIP_DLL environment variable as szlibdll.lib.
+ HDF5_EXT_SZIP environment variable as szlibdll.lib
Notes:
- a. When setting environment variables, only include path for
- 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
- it with the correct path in the HDF5_EXT_ZLIB_DLL
- environment variable.
-
- c. You might have to close and reopen running programs for
+ a. You might have to close and reopen running programs for
the new environment variable settings to take effect.
- 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
- using DLLs.
+ 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:\WINNT\system or
+ c:\WINDOWS\system
6. Set up path for external libraries and headers
@@ -123,25 +109,24 @@ Preconditions
provided by HDF5. Please do 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.
+ or Szip. You also need to read section V.
Invoke Microsoft Visual C++ and go to "Tools" and select
"Options", find "Directories";
6.1 Find the box "Show directories for", choose
"Include files",
- If you cannot find your Zlib and Szlib header path
- (for example, c:\zlib114\include, c:\szlib\include)
+ If you cannot find your Zlib and Szip header path
+ (for example, c:\zlib122\include, c:\szip\include)
from the directory list, add the header path
- (c:\zlib114\include, c:\szlib\include) to the
+ (c:\zlib122\include, c:\szip\include) to the
included directories.
6.2 Find the box "Show directories for", choose "Library files",
- If you cannot find your Zlib and Szlib library path
- (for example, c:\zlib114\lib, c:\szlib\lib, c:\szlib\dll)
+ 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:\zlib114\lib, c:\szlib\lib, c:\szlib\dll) to the
- library directories.
+ (c:\zlib122\lib, c:\szip\dll) to the library directories.
Notes
@@ -195,9 +180,6 @@ Section I: What do we build and install?
HDF5 Dynamic Link Library(DLL):
debug and release version as well as export libraries for DLL
- HDF5 high level static library:
- debug and release version
-
HDF5 tools:
HDF5 tools
@@ -211,9 +193,6 @@ Section I: What do we build and install?
HDF5 library testing programs:
HDF5 library comprehensive tests
-
- HDF5 high level library testing programs:
- HDF5 high level library comprehensive tests
HDF5 related tools testing programs:
HDF5 tools comprehensive tests
@@ -275,10 +254,6 @@ STEP 1: Building HDF5 libraries and tools
hdf5_f90cstubdll
hdf5_fortran
hdf5_fortrandll
- hdf5_hl_fortran
- hl_test_lite_fortran
- hl_test_image_fortran
- hl_test_table_fortran
libtest_cstubdll
libtest_fortran
libtest_fortrandll
@@ -343,14 +318,6 @@ STEP 1: Building HDF5 libraries and tools
hdf5dll.dll- DLL
hdf5dll.lib- the DLL export library
- c:\MyHDFstuff\hdf5\proj\hdf5_hl\debug -
-
- hdf5_hld.lib- the HDF5 high level static library
-
- c:\MyHDFstuff\hdf5\proj\hdf5_hl\release -
-
- hdf5_hl.lib- the HDF5 high level static library
-
c:\MyHDFstuff\hdf5\test\libtest\debug -
and c:\MyHDFstuff\hdf5\test\libtest\release -
@@ -446,16 +413,6 @@ STEP 1: Building HDF5 libraries and tools
hdf5_f90cstubdll.lib- the HDF5 C and Fortran stub DLL
export library
- c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortran\debug -
-
- hdf5_hl_fortrand.lib- the HDF5 Fortran high level static
- library
-
- c:\MyHDFstuff\hdf5\proj\hdf5_hl_fortran\release -
-
- hdf5_hl_fortran.lib- the HDF5 Fortran high level static
- library
-
c:\MyHDFstuff\hdf5\fortran\test\libtest_cstubdll\debug -
libtest_cstubddll.dll- the HDF5 Fortran test C and
@@ -648,18 +605,7 @@ 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.
- 3. HDF5 high level library test
-
- 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 debug >"Your output filename"
-
- Use Notepad or WordPad to check results. You should
- not find any FAILED marks in your output files.
-
- 4. HDF5 C++ library test
+ 3. HDF5 C++ library test
Skip this step UNLESS you have built HDF5 C++ libraries
and want to test them.
@@ -683,7 +629,7 @@ 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.
- 5. HDF5 Fortran library test
+ 4. HDF5 Fortran library test
Skip this step UNLESS you have built HDF5 Fortran libraries
and want to test them.
@@ -713,20 +659,6 @@ 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.
- 6. HDF5 Fortran high level library test
-
- Skip this step UNLESS you have built HDF5 Fortran high level library
- and want to test it.
-
- 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 debug >"Your output filename"
-
- Use Notepad or WordPad to check results. You should
- not find any FAILED marks in your output files.
-
STEP 3: Installing HDF5 Libraries
@@ -993,7 +925,7 @@ To use HDF5 static library
1) Method One
- To insert the path that specifies HDF5 and Zlib, Szlib header files:
+ 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.
@@ -1009,11 +941,11 @@ To use HDF5 static library
"Category:"
6. In a text-area labeled with "Additional include directories:",
- add HDF5, Zlib, and Szlib header files directories. For example:
+ add HDF5, Zlib, and Szip header files directories. For example:
c:\MyHDFstuff\hdf5\hdf5lib\include
- c:\zlib114\include
- c:\szlib\include
+ c:\zlib122\include
+ c:\szip\include
Then click OK.
@@ -1040,50 +972,38 @@ To use HDF5 static library
5. Select hdf5.lib and click OK.
- 6. repeat 1-5, to select zlib.lib and szlib.lib.
-
- 7. (optional) repeat 1-5, to select hdf5_hl.lib to link with HDF5
- high level static library.
+ 6. repeat 1-5, to select zdll.lib and szlibdll.lib.
- 8. (optional) repeat 1-5, to select hdf5_cpp.lib to link with HDF5
+ 7. (optional) repeat 1-5, to select hdf5_cpp.lib to link with HDF5
C++ static library.
- 9. (optional) repeat 1-5, to select hdf5_fortran.lib to link with
+ 8. (optional) repeat 1-5, to select hdf5_fortran.lib to link with
HDF5 Fortran static library.
- 10.(optional) repeat 1-5, to select hdf5_hl_fortran.lib to link with
- HDF5 high level 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,
+ 2. Insert the correct HDF5, Zlib, Szip 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
+ 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
- "zlib.lib, szlib.lib, hdf5.lib".
-
- 5. (Optional) repeat 3-4, to insert "hdf5_hl.lib" if you want to
- use HDF5 high level static library.
+ "zdll.lib, szlibdll.lib, hdf5.lib".
- 6. (Optional) repeat 3-4, to insert "hdf5_cpp.lib" if you want to
+ 5. (Optional) repeat 3-4, to insert "hdf5_cpp.lib" if you want to
use HDF5 C++ static library.
- 7. (Optional) repeat 3-4, to insert "hdf5_fortran.lib" if you want
- to use HDF5 Fortran static library.
-
- 8. (Optional) repeat 3-4, to insert "hdf5_hl_fortran.lib" if you
- want to use HDF5 Fortran high level 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:
@@ -1200,17 +1120,13 @@ Warning: When you modify the H5pubconf.h file as described below,
1.2 Delete HDF5_EXT_ZLIB environment variable if you have
set it in preconditions.
- 1.3 Delete HDF5_EXT_ZLIB_DLL environment variable if you have
- set it in preconditions.
-
- 1.4 Run-compile HDF5 library according to section II.
+ 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)
- $(HDF5_EXT_ZLIB_DLL)
This message can be ignored.
@@ -1231,21 +1147,14 @@ Warning: When you modify the H5pubconf.h file as described below,
2.2 Delete HDF5_EXT_SZIP environment variable if you have
set it in preconditions.
-
- 2.3 Delete HDF5_EXT_SZIP_DLL environment variable if you have
- set it in preconditions.
-
- 2.4 Delete HDF5_SZIP_ENCODE environment variable if you have
- set it in preconditions.
- 2.5 Run-compile HDF5 library according to section II.
+ 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)
- $(HDF5_EXT_SZIP_DLL)
This message can be ignored.
@@ -1275,10 +1184,7 @@ Warning: When you modify the H5pubconf.h file as described below,
then save the file.
- 3.3 Delete HDF5_SZIP_ENCODE environment variable if you have
- set it in preconditions.
-
- 3.4 Run-compile HDF5 library according to section II.
+ 3.3 Run-compile HDF5 library according to section II.
************************************************************************