mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2024-11-27 02:10:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

[svn-r15005] Purpose: Minor updates to Windows documentation.

Browse Source 
Description:
-- INSTALL_Windows.txt:
   -- Update szip version number to 2.1
   -- Extra details for setting up 64-bit builds
   -- Explain adding HDF5 link settings more clearly
   -- Add link to FAQ
   -- Misc. typos and formatting
-- INSTALL_Windows_From_Command_Line.txt
   -- Add note about 64-bit support
-- INSTALL_Windows_Short_NET.TXT
   -- Add notes detailing features unsupported on VS.NET
-- INSTALL_Windows_Short_VS2005.TXT
   -- Add notes about extra features.
This commit is contained in:
Scott Wegner 2008-05-15 09:21:11 -05:00
parent 7b7f10a444
commit fb1776dd9e
4 changed files with 127 additions and 96 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

189
release_docs/INSTALL_Windows.txt
View File

@ -79,9 +79,9 @@ Preconditions:
to download the Zlib library.
6.2 HDF5 uses Szip version 2.0 for compression and Szip compression
6.2 HDF5 uses Szip version 2.1 for compression and Szip compression
software is provided with HDF5 products in 1.8.1 release. To use
Szip 2.0 library, you can download Szip source codes and binaries from
Szip 2.1 library, you can download Szip source codes and binaries from
ftp://ftp.hdfgroup.org/lib-external/szip/2.1/bin/windows
Please note that Szip is not a totally open-source free software.
@ -135,29 +135,35 @@ Preconditions:
Invoke Microsoft Visual Studio and go to "Tools" and select "Options",
find "Projects", and then "VC++ Directories".
6.1 If you are building on 64-bit Windows, find the "Platform" dropdown
and select "x64".
6.1 Find the box "Show directories for", choose "Include files", if you
6.2 Find the box "Show directories for", choose "Include files", if you
can not find your Zlib and Szip header path (for example,
c:\zlib123\include, c:\szip\include) from the directory list, add the
header path (c:\zlib123\include, c:\szip\include) to the included
directories.
6.2 Find the box "Show directories for", choose "Library files". If you
6.3 Find the box "Show directories for", choose "Library files". If you
cannot find your Zlib and Szip library path (for example,
c:\zlib123\lib, c:\szip\dll) from the directory list, add the library
path (c:\zlib123\lib, c:\szip\dll) to the library directories.
6.4 If building Fortran libraries, you will also need to setup the path
for the Intel Fortran compiler. Please see Section VI.
Notes:
1. As of 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
directory, run copy_hdf.bat first and then open all.sln under
hdf5/windows/proj/all to start building process.
2. Visual Studio 6.0 will not be supported in HDF5 1.8 or later release.
2. Users who prefer to use Visual Studio .NET can follow instructions in
INSTALL_Windows_Short_Net.txt. Note, however, HDF5 Fortran product
will not be supported in HDF5 1.8 release.
will not be supported in HDF5 1.8 release with Visual Studio .NET.
3. For users who want to quickly build HDF5 library or do not want to know
HDF5 building and installation details, please read the
@ -230,7 +236,7 @@ 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
copy all the necessary batch files, Windows-specific source code and
text files saved under c:\MyHDFstuff\hdf5\windows directory to the
corresponding directories under hdf5.
@ -276,6 +282,11 @@ STEP 1: Building HDF5 Libraries and Tools
hl_test_dsdll
hl_test_packet
hl_test_packetdll
Note: Disabling some projects will likely produce false errors in the
testing script. Check the output carefully to ensure that the
errors are related to the disabled projects, and then safely
ignore them.
4. Select "Build", then Select "Configuration Manager".
@ -292,7 +303,7 @@ STEP 1: Building HDF5 Libraries and Tools
Select "Build" -> "Build Solution" or "Rebuild Solution" to build release
version of project "all".
Both debug and release versions must be built.
Both debug and release versions must be built for testing.
Warning messages can be ignored.
@ -549,29 +560,7 @@ We provide 2 options for users to test HDF5 libraries and tools.
Use a text editor 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 in Section
VII, and want to test them.
Open a command prompt in the hdf5\fortran\test directory
a) Release Static, type:
checkfortrantests release >"Your output filename"
b) Release DLL, type:
checkfortrantests release dll >"Your output filename"
c) Debug Static, type:
checkfortrantests debug >"Your output filename"
d) Debug DLL, type:
checkfortrantests debug dll >"Your output filename"
Use a text editor to check results. You should not find any FAILED marks
in your output files.
5. HDF5 High-Level library test
4. HDF5 High-Level library test
Skip this step UNLESS you have built HDF5 High-Level libraries and want to
test them.
@ -593,7 +582,7 @@ We provide 2 options for users to test HDF5 libraries and tools.
Use a text editor to check results. You should not find any FAILED marks
in your output files.
6. HDF5 High-Level C++ library test
5. HDF5 High-Level C++ library test
Skip this step UNLESS you have built HDF5 High-Level C++ libraries and want
to test them.
@ -615,28 +604,7 @@ We provide 2 options for users to test HDF5 libraries and tools.
Use a text editor 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.
Open a command prompt in the hdf5\hl\fortran\test directory
a) Release Static, type:
checkhlfortrantests release >"Your output filename"
b) Release DLL, type:
checkhlfortrantests release dll >"Your output filename"
c) Debug Static, type:
checkhlfortrantests debug >"Your output filename"
d) Debug DLL, type:
checkhlfortrantests debug dll >"Your output filename"
Use a text editor to check results. You should not find any FAILED marks
in your output files.
Note: See Section VI for instructions on testing Fortran libraries.
STEP 3: Installing HDF5 Libraries
@ -898,8 +866,6 @@ 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.
1. Specifying Include Directories
@ -939,21 +905,65 @@ project, you may choose one of the following two methods.
Method Two: Visual Studio Settings
1. In Visual STudio, go to Tools->Options->Projects->
VC++ Directories.
VC++ Directories. Under "Show Directories For", select "Include files"
2. Insert the correct HDF5, Zlib, Szip paths for both headers(include)
and libraries. For example,
2. Insert the correct HDF5, Zlib, Szip paths for headers(include). For
example,
c:\MyHDFstuff\hdf5\hdf5lib\release\include
c:\MyHDFstuff\hdf5\hdf5lib\release\lib
c:\zlib123\include
c:\zlib123\lib
c:\szip\include
2. Specifying Library Directories
To specify the library directories in the settings for your Visual Studio
project, you may choose one of the following two methods.
Method One: Project-wide Settings
1. Open your project in Microsoft Visual Studio and make sure it is the
active project.
2. Go to the Project menu and chose the "Properties" option.
3. Choose the build configuration you would like to modify in the drop
down menu labeled "Configuration:"
4. Choose the "Linker" tab, anc select "General".
5. In a text-area labeled with "Additional Library Directories:", add
HDF5, Zlib, and Szip library files directories. For example:
c:\MyHDFstuff\hdf5\hdf5lib\release\lib
c:\zlib123\lib
c:\szip\dll
Note: To link with HDF5 DLLs rathern that static libraries, simply
specify the "dll" directory rather than "lib", and link with the
corresponding DLL link library below.
3. Go to the Project menu and choose the "Settings" option.
Then click OK.
2. Specifying Linking Directories
Method Two: Visual Studio Settings
1. In Visual STudio, go to Tools->Options->Projects->
VC++ Directories. Under "Show Directories For", select "Library files"
2. Insert the correct HDF5, Zlib, Szip paths for link libraries. For
example,
c:\MyHDFstuff\hdf5\hdf5lib\release\lib
c:\zlib123\lib
c:\szip\dll
Note: To link with HDF5 DLLs rathern that static libraries, simply
specify the "dll" directory rather than "lib", and link with the
corresponding DLL link library below.
3. Specifying Libraries to Link
To link the HDF5 static library with your application:
@ -1026,6 +1036,10 @@ Warning: When you modify the H5pubconf.h file as described below, DO NOT just
To disable Gzip and Szip at the same time, just make the appropriate
modifications to H5pubconf.h and the environmental variables all together,
and then Run-compile.
These instructions assume that copy_hdf.bat has already been run in Section
II. If you can't find H5pubconf.h file in the specified directory, please
verify that this script has been run.
1. Disable Gzip (Zlib) Compression
@ -1085,11 +1099,13 @@ Warning: When you modify the H5pubconf.h file as described below, DO NOT just
library and header path should also be set up accordingly (refer to
precondition 6).
3.2 Run-compile HDF5 library according to Section II.
3.2 Run-compile HDF5 library according to Section II. The encoding
functionality is detected dynamically.
========================================================================
Section VI: How to build HDF5 with Intel Fortran 9.1
Section VI: How to build HDF5 with Fortran Support
========================================================================
Notes: 1. For Intel Compiler users, Intel fortran Compiler 9.1 is currently
supported-- please see below. Intel Compiler verion 7.x and 8.x are no
longer supported.
@ -1099,16 +1115,15 @@ Notes: 1. For Intel Compiler users, Intel fortran Compiler 9.1 is currently
3. Intel Fortran 9.1 works only under Visual Studio 2005 environments.
4. Parallel builds should be disabled. To do so: Go to Tools >
Options > Projects and Solutions > Build and Run. Set "Maximum Number of
Parallel Project Builds" to 1.
Options > Projects and Solutions > Build and Run. Set "Maximum Number
of Parallel Project Builds" to 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
Szip source codes or binaries for Windows compilers can be downloaded
from the following address:
ftp://ftp.hdfgroup.org/lib-external/szip/2.1/bin/windows.
@ -1366,14 +1381,14 @@ Notes: 1. For Intel Compiler users, Intel fortran Compiler 9.1 is currently
Notes: In Visual Studio 2005, the Single-threaded runtime libraries have been
depreciated, and Multi-threaded is built by default. Therefore, no extra
work needs to be done to build Multi-threaded libraries in Visual Studio
2005.
2005. This section applies only to Visual Studio .NET
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.
In Visual Studio.Net, users have the option of building multi-threaded
In Visual Studio .NET, users have the option of building multi-threaded
libraries by manipulating the project settings. Otherwise, the build process
is very much the same. Therefore, follow the instructions below, and refer
to the earlier sections of this document for details on building and testing.
@ -1494,7 +1509,7 @@ to the earlier sections of this document for details on building and testing.
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
copy all the necessary batch files, Windows-specific source code and text
files saved under c:\MyHDFstuff\hdf5\windows directory to the corresponding
directories under hdf5.
@ -1555,7 +1570,7 @@ to the earlier sections of this document for details on building and testing.
Right-click on project ttsafedll and click "Build" 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
@ -1601,8 +1616,8 @@ Visual Studio 2005 for 64-bit builds.
Notes:
1. Building 64-bit HDF5 from a 32-bit machine is also unsupported. Because
we generate H5tinit.c from a generated 64-bit executable, this must be
done on a 64-bit machine.
we generate source file H5tinit.c from a generated 64-bit executable,
this must be done on a 64-bit machine.
Prerequisites:
@ -1623,12 +1638,7 @@ Building:
"Configuration Manager". In the "Active solution platform" box,
select "x64", and press "Close".
2. If building Fortran libraries, the 64-bit Intel Fortran compiler
must be selected. In Visual Studio, go to "Tools", "Options". In
the right pane, select "Intel(R) Fortran", "General". In the
"Target Platform" box, select "x64".
3. 64-bit HDF5 must be built with 64-bit external libraries, unless
2. 64-bit HDF5 must be built with 64-bit external libraries, unless
external library support is disabled. You must add the include and
library paths for x64 configurations as you have in the
"Prerequisites" section. This is also true for Intel Fortran if
@ -1638,7 +1648,7 @@ Building:
Testing:
We provide a test suite to verify all libraries and tools were built
successfully. This test suite should work identically on 32- and 64- bit
successfully. This test suite should work identically on 32- and 64-bit
builds. Therefore, you may follow the instructions in Section II about
testing. Note that because 64-bit binaries were built, these tests must
run on a 64-bit machine.
@ -1649,7 +1659,7 @@ Installing:
into one folder, hdf5lib. This script should work identically on 32- and
64-bit builds. Therefore, you may follow the instructions in Section II
about installing.
========================================================================
Section X: How to build HDF5 on Windows Vista
========================================================================
@ -1734,7 +1744,18 @@ using the Visual C++ Development Environment.
If you create your own project, the necessary settings can be read
from the all.vcproj file (as text), or from the Project Settings in the
Developer Studio project settings dialog.
Visual Studio project settings dialog.
1.3 FAQ
Many other common questions and hints are located online and being updated
in the HDF5 FAQ. For Windows-specific questions, please see:
http://www.hdfgroup.uiuc.edu/windows/faq.html
For all other general questions, you can look in the general FAQ:
http://hdfgroup.org/HDF5-FAQ.html
************************************************************************

6
release_docs/INSTALL_Windows_From_Command_Line.txt
View File

@ -9,7 +9,7 @@ Note: This instruction is written for users who would like to build HDF5
Currently, we support
1. Building and testing HDF5 C/C++/Fortran libraries on command line with
Microsoft Visual Studio 2005
Microsoft Visual Studio 2005 for 32- or 64-bit Windows.
For all other Windows development tools, HDF5 should be built in
the development environment. Please refer to INSTALL_Windows.txt
@ -61,8 +61,8 @@ notes in INSTALL_Windows.txt before starting below procedures.
Similarly, set HDF5_EXT_SZIP to the name of the szip library on your system.
(Optional) If you will be building using the /useenv switch, you must also
define variables INCLUDE and LIBPATH with a semi-colon deliminated list of
paths for szip and zlib include files, and libraries, respectively. Set
define variables INCLUDE and LIB with a semi-colon deliminated list of
paths for szip and zlib include files and libraries, respectively. Set
these variables in the same way you set HDF5_EXT_ZLIB and HDF5_EXT_SZIP.

17
release_docs/INSTALL_Windows_Short_NET.TXT
View File

@ -7,6 +7,11 @@ Notes: This short instruction is written for users who want to quickly
build HDF5 library and tools from the HDF5 source code package
with Microsoft Visual Studio .NET 2003 but do not want to know
HDF5 building and installation details on Windows XP.
Visual Studio .NET 2003 is NOT supported on Windows Vista, as Microsoft
has ended their support. Also, we do not support building 64-bit
libraries or Fortran libraries with Visual Studio .NET 2003. If you
need any of these features, please upgrade to Visual STudio 2005.
For detailed HDF5 build and install information, or if you have
trouble following any steps in the instructions, please refer to
@ -14,7 +19,8 @@ Notes: This short instruction is written for users who want to quickly
For users who would like to build and test HDF5 package from the
command line, please refer to
INSATLL_Windows_From_Command_Line.txt.
INSATLL_Windows_From_Command_Line.txt. Note, however, that building
from the command line requires Visual Studio 2005.
WARNINGS:
@ -136,19 +142,12 @@ HDF5 libraries and tools should be tested to make sure that they were
built correctly. c:\MyHDFstuff\hdf5\hdf5check.bat was provided to test
HDF5 libraries and tools.
hdf5check.bat has four options:
hdf5check.bat has the following options:
hdf5check test HDF5 C library and tools only
hdf5check enablecpp test HDF5 C/C++ libraries and tools
hdf5check enablefortran test HDF5 C/Fortran libraries and tools
hdf5check enableall test HDF5 C/C++/Fortran libraries and tools
Notes: Users who only build HDF5 C/C++ libraries ONLY have the first
two options.
Invoke a command prompt window and run hdf5check with appropriate option.
Users are encouraged to pipe the test output into a file. You should find

11
release_docs/INSTALL_Windows_Short_VS2005.TXT
View File

@ -14,6 +14,17 @@ Notes: This short instruction is written for users who want to quickly build
For users who would like to build and test HDF5 package from the
command line, please refer to INSATLL_Windows_From_Command_Line.txt.
Notes:
1. HDF5 1.8 can also be built using Visual Studio 2005 on Windows
Vista. For details, please see Section X of INSTALL_Windows.txt.
2. 64-bit builds are also supported in Visual STudio 2005. For details
please see Section IX of INSTALL_Windows.txt.
3. Fortran libraries can be built with Visual Studio 2005 and Intel
Fortran 9.1. For details, see Section VI of INSTALL_Windows.txt.
WARNINGS: