summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorQuincey Koziol <koziol@hdfgroup.org>2011-02-22 19:37:06 (GMT)
committerQuincey Koziol <koziol@hdfgroup.org>2011-02-22 19:37:06 (GMT)
commit727b687ae6c80c9854cb53814fa1c12f27c2994c (patch)
treefabe359aaddbe3b4d1e2bb58ceb3b94311d66a1c /release_docs
parent25486d50895fa4a30809d289b9aff4de583a9b84 (diff)
downloadhdf5-727b687ae6c80c9854cb53814fa1c12f27c2994c.zip
hdf5-727b687ae6c80c9854cb53814fa1c12f27c2994c.tar.gz
hdf5-727b687ae6c80c9854cb53814fa1c12f27c2994c.tar.bz2
[svn-r20146] Description:
Bring r19714:20145 from trunk to revise_chunks branch. Tested on: FreeBSD/32 6.3 (duty) in debug mode FreeBSD/64 6.3 (liberty) w/C++ & FORTRAN, in debug mode Linux/32 2.6 (jam) w/PGI compilers, w/default API=1.8.x, w/C++ & FORTRAN, w/threadsafe, in debug mode Linux/64-amd64 2.6 (amani) w/Intel compilers, w/default API=1.6.x, w/C++ & FORTRAN, in production mode Solaris/32 2.10 (linew) w/deprecated symbols disabled, w/C++ & FORTRAN, w/szip filter, w/threadsafe, in production mode Linux/PPC 2.6 (heiwa) w/C++ & FORTRAN, w/threadsafe, in debug mode Linux/64-amd64 2.6 (abe) w/parallel, w/FORTRAN, in debug mode Mac OS X/32 10.6.6 (amazon) in debug mode Mac OS X/32 10.6.6 (amazon) w/C++ & FORTRAN, w/threadsafe, in production mode
Diffstat (limited to 'release_docs')
-rwxr-xr-xrelease_docs/CMake.txt65
-rw-r--r--release_docs/INSTALL_parallel6
-rw-r--r--release_docs/RELEASE.txt77
-rw-r--r--release_docs/USING_Windows.txt659
4 files changed, 776 insertions, 31 deletions
diff --git a/release_docs/CMake.txt b/release_docs/CMake.txt
index 1220066..0540fb6 100755
--- a/release_docs/CMake.txt
+++ b/release_docs/CMake.txt
@@ -14,15 +14,21 @@ Notes: This short instruction is written for users who want to quickly build
all the operating systems supported by CMake.
NOTES:
- 1. CMake use is still experimental. While we have attempted to
- provide error-free files, please understand that development
- with CMake has just began. The CMake specific files may change
+ 1. Using CMake for building and using HDF5 is under active development.
+ While we have attempted to provide error-free files, please
+ understand that development with CMake has not been extensively
+ tested outside of HDF. The CMake specific files may change
before the next release.
- 2. CMake has been introduced to support development on Windows, however
- it should be usuable on any system where CMake is supported. Please
- send us any comments on how CMake support can be improved on any
- system.
+ 2. CMake was originally introduced to support development on Windows,
+ however it should be usable on any system where CMake is supported.
+ Please send us any comments on how CMake support can be improved on
+ any system. Visit the KitWare site for more information about CMake.
+
+ 3. Build and test results can be submitted to our CDash server at:
+ www.cdash.hdfgroup.org.
+ Please read the HDF and CDash document at:
+ www.hdfgroup.org/CDash/HowToSubmit.
========================================================================
@@ -32,10 +38,26 @@ Notes: This short instruction is written for users who want to quickly build
1. We suggest you obtain the latest CMake for windows from the Kitware
web site. The HDF5 1.8.x product requires CMake version 2.8.2.
- 2. If you plan to use Zlib or Szip, download the packages and install them
- in a central location. For example on Windows, create a folder extlibs
- and install the packages there. Windows users should also read Section V
- in INSTALL_Windows.txt.
+ 2. If you plan to use Zlib or Szip;
+ A. Download the packages and install them
+ in a central location. For example on Windows, create a folder extlibs
+ and install the packages there. Windows users should also read Section V
+ in INSTALL_Windows.txt.
+ B. Use source packages from a SVN server by adding the following CMake
+ options:
+ HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="SVN"
+ ZLIB_SVN_URL:STRING="http://some_location/zlib/trunk"
+ SZIP_SVN_URL:STRING="http://some_location/szip/trunk"
+ where "some_location" is the URL to the SVN repository.
+ C. Use source packages from a compressed file by adding the following CMake
+ options:
+ HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ"
+ ZLIB_TGZ_NAME:STRING="zlib_src.ext"
+ SZIP_TGZ_NAME:STRING="szip_src.ext"
+ TGZ_PATH:STRING="some_location"
+ where "some_location" is the URL or full path to the compressed file and
+ ext is the type of compression file.
+
========================================================================
Building HDF5 C/C++ Libraries with CMake
@@ -147,15 +169,30 @@ Notes: This short instruction is written for users who want to quickly build
file in your build directory. Be sure to select either Debug or
Release and build the solution.
- 3.2 The external libraries (zlib, szip, and jpeg) can be configured
+ 3.2.1 The external libraries (zlib and szip) can be configured
to allow building the libraries by downloading from a SVN repository.
The option is 'HDF5_ALLOW_EXTERNAL_SUPPORT'; by adding the following
configuration option:
-DHDF5_ALLOW_EXTERNAL_SUPPORT:STRING="SVN"
- The options to control the SVN URL are by defualt:
+ The options to control the SVN URL (config/cmake/cacheinit.cmake file):
ZLIB_SVN_URL:STRING="http://svn.hdfgroup.uiuc.edu/zlib/trunk"
SZIP_SVN_URL:STRING="http://svn.hdfgroup.uiuc.edu/szip/trunk"
+ These should be changed to your location.
+
+ 3.2.2 Or the external libraries (zlib and szip) can be configured
+ to allow building the libraries by using a compressed file.
+ The option is 'HDF5_ALLOW_EXTERNAL_SUPPORT'; by adding the following
+ configuration option:
+ -DHDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ"
+
+ The options to control the SVN URL (config/cmake/cacheinit.cmake file):
+ ZLIB_TGZ_NAME:STRING="zlib_src.ext"
+ SZIP_TGZ_NAME:STRING="szip_src.ext"
+ TGZ_PATH:STRING="some_location"
+ where "some_location/xxxx_src.ext" is the URL or full path to the
+ compressed file and where ext is the type of the compression file like:
+ .bz2, .tar, .tar.gz, .tgz, .zip
4. Test HDF5.
@@ -172,7 +209,7 @@ Notes: This short instruction is written for users who want to quickly build
To package the build into a simple installer using the NullSoft installer NSIS
on Windows, or into compressed files (.tar.gz, .sh, .zip), use the CPack tool.
- To pacakage the build, navigate to your build directory and execute;
+ To package the build, navigate to your build directory and execute;
cpack -C {Debug | Release} CPackConfig.cmake
diff --git a/release_docs/INSTALL_parallel b/release_docs/INSTALL_parallel
index 04643b2..d771c0b 100644
--- a/release_docs/INSTALL_parallel
+++ b/release_docs/INSTALL_parallel
@@ -232,10 +232,10 @@ compiler is `mpicc' and the user hasn't specified values for RUNSERIAL and
RUNPARALLEL then configure chooses `mpiexec' from the same directory as `mpicc':
RUNSERIAL: /usr/local/mpi/bin/mpiexec -np 1
- RUNPARALLEL: /usr/local/mpi/bin/mpiexec -np $${NPROCS:=3}
+ RUNPARALLEL: /usr/local/mpi/bin/mpiexec -np $${NPROCS:=6}
-The `$${NPROCS:=3}' will be substituted with the value of the NPROCS
-environment variable at the time `make check' is run (or the value 3).
+The `$${NPROCS:=6}' will be substituted with the value of the NPROCS
+environment variable at the time `make check' is run (or the value 6).
4. Parallel test suite
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index 9aba063..5e5f49c 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -1,4 +1,4 @@
-HDF5 version 1.9.79-FA_a5 currently under development
+HDF5 version 1.9.80-FA_a5 currently under development
================================================================================
@@ -39,6 +39,15 @@ New Features
Configuration:
-------------
+ - Added mpicc and mpif90 as the default C and Fortran compilers for Linux
+ systems when --enable-parallel is specified but no $CC or $FC is defined.
+ (AKC - 2011/2/7)
+ - Added a new configure option, "--enable-unsupported", which can
+ be used to stop configure from preventing the use of unsupported
+ configure option combinations, such as c++ in parallel or parallel
+ HDF5 with threadsafe. Use at your own risk, as it may result in a
+ library that won't compile or run as expected!
+ (MAM - 2010/11/17 - Bug 2061)
- PHDF5 changed to use "mpiexec", instead of mpirun, as the default MPI
applications startup command as defined in the MPI-2 definition, section
4.1. (AKC - 2010/6/11 - Bug 1921)
@@ -76,6 +85,12 @@ New Features
Library:
--------
+ - Added ability to cache files opened through external links. Added new
+ public functions H5Pset_elink_file_cache_size(),
+ H5Pget_elink_file_cache_size(), and H5Frelease_file_cache().
+ (NAF - 2011/02/17)
+ - Removed all old code for Metraowerks compilers, bracketed by
+ __MWERKS__). Metraowerks compiler is long gone. (AKC - 2010/11/17)
- Added support for threadsafety on windows using the windows threads
library. Use the HDF5_ENABLE_THREADSAFE option in CMake while on a
windows platform to enable this functionality. This is supported on
@@ -249,6 +264,17 @@ Bug Fixes since HDF5-1.8.0 release
Library
-------
+ - The datatype handler created with H5Tencode/decode used to have the
+ reference count 0 (zero). I have fixed it. It is 1 (one) now.
+ (SLU - 2011/2/18)
+ - Fixed a bug that caused big endian machines to generate corrupt files
+ when using the scale-offset filter with floating point data or
+ fill values. Note that such datasets will no longer be readable
+ by any machine after this patch. (NAF - 2010/02/02 - Bug 2131)
+ - Retrieving a link's name by index in the case where the link is
+ external and the file that the link refers to doesn't exist will
+ now fail gracefully rather than cause a segmentation fault.
+ (MAM - 2010/11/17)
- Modified library to always cache symbol table information. Libraries
version 1.6.3 have a bug which causes them to require this
information for some operations. (NAF - 2010/09/21 - 1864)
@@ -474,6 +500,20 @@ Bug Fixes since HDF5-1.8.0 release
Tools
-----
+ - Fixed h5dump for skipping array indices every certain number
+ when the array type dataset is relatively big. The certain number
+ varies according to the size of array. Bug#2092 (JKM 2011/2/15).
+ - Fixed h5diff for the segfault when compares compound datasets
+ with combination of fixed length string types and vlen string types
+ in certain orders. bug#2089 (JKM 2010/12/28)
+ - Improve h5diff performance. 1) use HDmemcmp() before comparing each
+ elements. 2) replace expensive H5Tequals() calls 3) retrieve datatype
+ information at dataset level not each element level for compound
+ datasets
+ - Fixed h5ls to display nested compound type with curly bracket
+ when -S (--simple) option is used with -l (--label), so it shows
+ which member (in curly bracket) belong to which nested compound type
+ and make the output make sense. bug#1979 (JKM 2010/11/09)
- Fixed h5diff to handle variable-length strings in a compound dataset
correctly. (also variable-length string array in a compound dataset)
Garbage values were displayed when h5diff compared multiple
@@ -607,11 +647,12 @@ Bug Fixes since HDF5-1.8.0 release
Platforms Tested
================
- AIX 5.3 xlc 7.0.0.8, 8.0.0.20, 9.0.0.4
- (LLNL Up) xlC 7.0.0.8, 8.0.0.20, 9.0.0.4
- xlf 9.1.0.8, 10.1.0.9, 11.1.0.7
- mpcc_r 7.0.0.8
- mpxlf_r 09.01.0000.0008
+ AIX 6.1 xlc 11.1.0.3
+ (NCSA BP) xlC 11.1.0.3
+ xlf 13.1.0.3
+ mpcc_r 11.1.0.3
+ mpxlf_r 13.1.0.3
+
FreeBSD 6.2-STABLE i386 gcc 3.4.6 [FreeBSD] 20060305
(duty) g++ 3.4.6 [FreeBSD] 20060305
gcc 4.2.1 20080123
@@ -686,10 +727,7 @@ Platform C F90 F90 C++ zlib SZIP
parallel parallel
SunOS5.10 64-bit n y n y y y
SunOS5.10 32-bit n y n y y y
-AIX-5.2 32-bit y y y y y y
-AIX-5.2 64-bit y y y y y y
-Cray XT3 (not tested
- for this release) n n n n n n
+AIX 6.1 32- and 64-bit n y n y y y
Windows XP n y(3) n(3) y y y
Windows XP x64 n y(3) n(3) y y y
Windows Vista n y(3) n(3) y y y
@@ -717,10 +755,7 @@ Platform Shared Shared Shared static- Thread-
C libs F90 libs C++ libs exec safe
SunOS 5.10 32-bit y y y x y
SunOS 5.10 64-bit y y y x y
-AIX-5.2 32-bit n n n x n
-AIX-5.2 64-bit n n n x n
-Cray XT3 (not tested
- for this release) n n n x n
+AIX 6.1 32- and 64-bit n n n x y
Windows XP y y(3) y y n
Windows XP x64 y y(3) y y n
Windows Vista y y(3) y y y
@@ -753,6 +788,20 @@ SuSe Linux 2.6.5
Known Problems
==============
+* examples/run-all-ex.sh does not work on Cygwin. (NAF - 2011/02/11)
+
+* While working on the 1.8.6 release of HDF5, a bug was discovered that can
+ occur when reading from a dataset in parallel shortly after it has been
+ written to collectively. The issue was exposed by a new test in the parallel
+ HDF5 test suite, but had existed before that. We believe the problem lies with
+ certain MPI implementations and/or filesystems.
+
+ We have provided a pure MPI test program, as well as a standalone HDF5
+ program, that can be used to determine if this is an issue on your system.
+ They should be run across multiple nodes with a varying number of processes.
+ These programs can be found at:
+ http://www.hdfgroup.org/ftp/HDF5/examples/known_problems/
+
* Parallel mode in AIX will fail some of the testcheck_version.sh tests where
it treats "exit(134) the same as if process 0 had received an abort signal.
This is fixed and will be available in the next release. AKC - 2009/11/3
diff --git a/release_docs/USING_Windows.txt b/release_docs/USING_Windows.txt
new file mode 100644
index 0000000..4e78c68
--- /dev/null
+++ b/release_docs/USING_Windows.txt
@@ -0,0 +1,659 @@
+
+***********************************************************************
+* HDF5 Build and Install Instructions for Windows XP/VISTA *
+* (Full Version) *
+***********************************************************************
+
+The following instructions assume that the HDF5 binary code package from
+HDF website (http://hdfgroup.org) is used.
+
+Warnings:
+Please read CAREFULLY about the following preconditions and notes first.
+
+Contents:
+
+ Section : Preconditions and Notes
+ Section I : What do we provide?
+ Section II : How to build examples (optional)
+ Section III : How to build an application using the HDF5 library or DLL
+ Section IV : How to build HDF5 for 64-bit Windows
+ Section V : How to build HDF5 applications using Visual Studio 2010
+ Section VI : Misc.
+
+
+========================================================================
+ Preconditions and Notes
+========================================================================
+
+Preconditions:
+
+ 1. Installed Microsoft Visual Studio. This document is written for Visual
+ Studio 2008. Express Editions may work with the project files
+ but not from the command line. We do not support the Express Editions.
+
+ 2. (Optional) Installed Intel Compiler 10.1 or 11.1 if you want to use HDF5
+ Fortran libraries.
+
+ 3. Install Winzip or 7-zip for extracting source tarball.
+
+ Note: 1. 7zip is an open-source alternative to WinZip. Some of the
+ advanced functionality is disabled in WinZip unless you buy the
+ software. With 7zip, most of this functionality is included for
+ free.
+
+ 5. Set up a directory structure to unpack the library. For example:
+
+ c:\ (any drive)
+ MyHDFstuff\ (any folder name)
+
+ 6. Download the hdf5-1.8.x binary code package and use 7zip or 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".
+
+ 7. HDF5 provide options to do in-memory compression within HDF5 library.
+ Currently, two external compression libraries Zlib and Szip can be used
+ with HDF5.
+
+ 7.1 HDF5 uses Zlib version 1.2.5 for compression and Zlib is
+ distributed with HDF5 library in 1.8.x release.
+
+ 7.2 HDF5 uses Szip version 2.1 for compression and Szip compression
+ software is provided with HDF5 products in 1.8.x release.
+
+ Please note that Szip is not a totally open-source free software.
+ For licensing issue of Szip, please check "Licensing terms" at
+ http://hdfgroup.org/doc_resource/SZIP/index.html.
+
+ Szip compression feature inside HDF5 is enabled by default.
+
+ 8. 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", click "Control Panel", and then double-click "System".
+ On the "Advanced" tab, click "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 and
+ "Variable value" as zlib1.lib, then click OK.
+
+ Similarly, you can set:
+
+ HDF5_EXT_SZIP environment variable as szip.lib
+
+ Notes:
+
+ a. You will have to close and reopen running programs for the new
+ environment variable settings to take effect.
+
+ b. c:\zlib\zlib1.dll and c:\szip\dll\szip.dll should be copied
+ into a location that the application can find.
+
+ 9. Set up path for libraries and headers
+
+ Invoke Microsoft Visual Studio and go to "Tools" and select "Options",
+ find "Projects", and then "VC++ Directories".
+
+ 9.1 If you are building on 64-bit Windows, find the "Platform" dropdown
+ and select "x64".
+
+ 9.2 Find the box "Show directories for", choose "Include files", if you
+ can not find your HDF5 header path (for example,
+ c:\MyHDFstuff\include) from the directory list, add the
+ header path (c:\MyHDFstuff\include) to the included
+ directories.
+
+ 9.3 Find the box "Show directories for", choose "Library files". If you
+ cannot find your HDF5 library path (for example,
+ c:\MyHDFstuff\dll for dynamic-shared and c:\MyHDFstuff\lib for static)
+ from the directory list, add the library
+ path (c:\MyHDFstuff\dll or c:\MyHDFstuff\lib) to the library directories.
+
+ 9.4 If building Fortran applications, you will also need to setup the path
+ for the Intel Fortran compiler. Please see Section VI.
+
+Notes:
+
+ 1. HDF4-related tools are not built and released with HDF5 library packages
+ any more. To obtain HDF4 related tools, please check
+ http://hdfgroup.org/h4toh5/ and ftp://ftp.hdfgroup.org/HDF5/h4toh5
+
+ 2. For Fortran users, Intel Fortran Compiler 10.1 is currently supported
+ -- please see Section VI. Intel Compiler 11.1 can be used but the project files
+ must be upgraded within the Visual Studio IDE.
+
+ 3. The szip and zlib dlls must be in the PATH for using the tools (including static).
+
+
+========================================================================
+ Section I: What do we provide?
+========================================================================
+
+ 1. Provide
+
+ HDF5 static library:
+ release version
+
+ HDF5 Dynamic Link Library(DLL):
+ release version as well as export libraries for DLL
+
+ HDF5 High-Level Library (Optional):
+ HDF5 C++ Library
+ HDF5 HL-Fortran Library
+
+ HDF5 tools:
+ HDF5 tools
+
+ HDF5 tool library:
+ release version
+
+ HDF5 tool export library for DLL:
+ release version
+
+ 2. Examples (Included in the binary distribution as a zip file)
+
+ Unpack the examples, hdf5-examples.zip, into your "hdf5" folder
+ (c:\MyHDFstuff\hdf5).
+ The resulting structure under this folder should be:
+ c++
+ c++/examples
+ examples
+ fortran
+ fortran/examples
+ hl
+ hl/c++
+ hl/c++/examples
+ hl/examples
+ hl/fortran
+ hl/fortran/examples
+ windows
+ windows/c++
+ windows/c++/examples
+ windows/examples
+ windows/fortran
+ windows/fortran/examples
+ windows/hl
+ windows/hl/examples
+ windows/hl/fortran
+ windows/hl/fortran/examples
+ hdf5build_examples.bat
+ InstallExamples.bat
+
+ HDF5 examples:
+ Simple HDF5 C/C++/Fortran and High level C/Fortran examples
+
+========================================================================
+ Section II: How To Build Examples (Optional)
+========================================================================
+
+Simple examples have been provided for users to test HDF5 C/C++/Fortran and
+High level C/Fortran library and tools.
+
+Note:
+ 1) To build HDF5 C++ examples, HDF5 C++ library must have been installed in
+ Step I.
+
+ 2) To build HDF5 Fortran or HL Fortran examples, please see Section VI,
+ Step 3.
+
+ 3) To build HDF5 High Level C examples, HDF5 High level library must have
+ been installed in step I.
+
+ 4) By default, the HDF5 binary distribution only includes the release
+ versions of HDF5 C/C++ libraries and DLLs.
+
+To build and test HDF5 C examples:
+----------------------------------
+ 1. Invoke Microsoft Visual Studio, go to "File" and select the "Open
+ Solution" option.
+
+ Then open the solution
+ c:\MyHDFstuff\hdf5examples\windows\examples\allexamples\allexamples.sln.
+
+ 2. Select "Build", and "Configuration Manager".
+
+ To build release versions of C examples.
+
+ In "Active Solution Configuration", select "Release". Select "Close".
+ Select "Build" -> "Build Solution" or "Rebuild Solution" to build
+ release version of project "allexamples".
+
+ When the release build is done, there should be the following
+ subdirectories in c:\MyHDFstuff\hdf5examples\examples\
+
+ attributetest
+ attributetestdll
+ chunkread
+ chunkreaddll
+ compoundtest
+ compoundtestdll
+ extendwritetest
+ extendwritetestdll
+ grouptest
+ grouptestdll
+ readtest
+ readtestdll
+ selectest
+ selectestdll
+ writetest
+ writetestdll
+
+ 3. Invoke a command prompt window and run the batch file InstallExamples.bat
+ which resides in the top level directory (c:\MyHDFstuff\hdf5examples). This file
+ creates new directories, examplesREL, examplesRELDLL in the
+ c:\MyHDFstuff\hdf5examples\examples directory and places
+ all the executables in it.
+
+ 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 HDF5 C examples.
+
+ testExamples.bat batch file has options:
+
+ testExamples release -- for release version
+
+ testExamples release dll -- for release DLL version
+
+ Invoke a command prompt and run testExamples.bat 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.
+
+To build and test HDF5 C++ examples:
+------------------------------------
+
+ 1. Invoke Microsoft Visual Studio, go to "File" and select the "Open
+ Solution" option.
+
+ Then open the solution
+ c:\MyHDFstuff\hdf5examples\windows\examples\allexamples\allcppexamples.sln.
+
+ 2. Select "Build", and "Configuration Manager".
+
+ To build release versions of C examples.
+
+ In "Active Solution Configuration", select "Release". Select "Close".
+ Select "Build" -> "Build Solution" or "Rebuild Solution" to build
+ release version of project "allcppexamples".
+
+ When the release build is done, there should be the following
+ subdirectories in c:\MyHDFstuff\hdf5examples\c++\examples\
+
+ chunks
+ chunksdll
+ compound
+ compounddll
+ create
+ createdll
+ extend_ds
+ extend_dsll
+ h5group
+ h5groupdll
+ readdata
+ readdatadll
+ writedata
+ writedatadll
+
+ 3. Invoke a command prompt window and run the batch file
+ InstallcppExamples.bat which resides in the top level directory
+ (c:\MyHDFstuff\hdf5examples). This file creates new directories,
+ cppexamplesREL, cppexamplesRELDLL in the
+ c:\MyHDFstuff\hdf5examples\c++\examples directory and places all
+ the executables in it.
+
+ 4. We provide a batch file named testcppExamples.bat in
+ c:\MyHDFstuff\hdf5examples\c++\examples directory for you to test HDF5 C++
+ examples.
+
+ testcppExamples.bat batch file has options:
+
+ testcppExamples release -- for release version
+
+ testcppExamples release dll -- for release DLL version
+
+ Invoke a command prompt and run testcppExamples.bat 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.
+
+
+To build and test HDF5 High Level C examples:
+---------------------------------------------
+
+ 1. Invoke Microsoft Visual Studio, go to "File" and select the "Open
+ Solution" option.
+
+ Then open the solution
+ c:\MyHDFstuff\hdf5examples\windows\hl\examples\allhlcexamples\allhlcexamples.sln
+
+ 2. Select "Build", and "Configuration Manager".
+
+ To build release versions of C examples.
+
+ In "Active Solution Configuration", select "Release". Select "Close".
+ Select "Build" -> "Build Solution" or "Rebuild Solution" to build
+ release version of project "allhlcexamples".
+
+ When the release build is done, binaries will be built in the
+ following subdirectories of c:\MyHDFstuff\hdf5\examples\
+
+ ex_image[1-2](dll)
+ ex_lite1(dll)
+ ex_table[01-12](dll)
+ ex_ds1(dll)
+ ptExample[FL+VL](dll)
+
+ 3. Invoke a command prompt and run the batch file Install_hlcexamples.bat
+ which resides in the top level directory (c:\MyHDFstuff\hdf5examples). This file
+ creates new directories, HLCexamplesRELEASE, HLCexamplesRELEASEDLL in the
+ c:\MyHDFstuff\hdf5examples\hl\examples directory and places all the executables in
+ it.
+
+ 4. We provide a batch file named test_hl_cexamples.bat in
+ c:\MyHDFstuff\hdf5examples\hl\examples directory for you to test HDF5 high level C
+ examples.
+
+ test_hl_cexamples.bat batch file has options:
+
+ Options purpose
+
+ test_hl_cexamples release -- for release version
+
+ test_hl_cexamples release dll -- for release DLL version
+
+ Invoke a command prompt window and run test_hl_cexamples with
+ appropriate options.
+
+ Invoke a command prompt and run testExamples.bat with appropriate options.
+ You should get "All of the HL C Examples Passed!" when the HL C examples
+ are built successfully. Otherwise, the difference between the expected
+ outputs and actual outputs will be given.
+
+
+========================================================================
+ 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.
+
+
+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:
+
+c:\MyHDFstuff\hdf5\hdf5lib\release\include
+c:\MyHDFstuff\hdf5\hdf5lib\release\lib
+
+We assume that you will use Zlib and Szip compression with HDF5 library.
+
+1. Specifying Include Directories
+
+To specify the include 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 "C/C++" tab, and select "General".
+
+ 5. 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:\zlib\include
+ c:\szip\include
+
+ Then click OK.
+
+ 6. (Optional) To use HDF5 Fortran static library, the location of
+ Fortran module files should be specified by following Project->
+ Settings->Fortran->Preprocessor, and in the text-area labeled
+ "Additional Include Directories", add HDF5 Fortran module files
+ directories. For example:
+
+ c:\MyHDFstuff\hdf5\hdf5lib\release\include
+
+ Method Two: Visual Studio Settings
+
+ 1. In Visual STudio, go to Tools->Options->Projects->
+ VC++ Directories. Under "Show Directories For", select "Include files"
+
+ 2. Insert the correct HDF5, Zlib, Szip paths for headers(include). For
+ example,
+
+ c:\MyHDFstuff\hdf5\hdf5lib\release\include
+ c:\zlib\include
+ 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, and 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:\zlib\dll
+ 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.
+
+ Then click OK.
+
+
+ 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:\zlib\dll
+ 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:
+
+ 1. In Visual Studio, go to the Project menu and choose "Properties".
+
+ 2. Find the "Link" option and "Input" category. In the "Additional
+ Dependencies" field, insert "zlib.lib, libszip.lib, hdf5.lib".
+
+ 3. (Optional) Also insert "hdf5_cpp.lib" if you want to use HDF5 C++
+ static library.
+
+ 4. (Optional) Also insert "hdf5_fortran.lib" if you want to use HDF5
+ Fortran static library.
+
+ 5. (Optional) Also insert "hdf5_hl.lib" if you want to use HDF5 high
+ level static library.
+
+ 6. (Optional) Also insert "hdf5_hl_cpp.lib" if you want to use HDF5 High
+ Level C++ static library.
+
+ 7. (Optional) Also insert "hdf5_hl_fortran.lib" if you want to use HDF5
+ High Level Fortran static library.
+
+
+ To link the HDF5 DLL library with your application:
+
+ 1. Follow the steps for linking the HDF5 static library as shown above,
+ 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.
+
+ 2. In the Project Properties dialog, go to the C/C++ > Preprocessor
+ subsection. In the "Preprocessor Definitions" box, add "_HDF5USEDLL_"
+ to the list.
+
+ 3. (Optional) Also add HDF5CPP_USEDLL to use HDF5 C++ DLL.
+
+ 4. (Optional) Also add _HDF5USEHLDLL_ to use HDF5 high level DLL.
+
+ 5. (Optional) Also add HDF5USE_HLCPPDLL use HDF5 high level C++ DLL.
+
+ 6. (Optional) Follow Project->Settings->Fortran->Category->General->
+ Predefined Preprocess or Symbols, and add "HDF5F90_WINDOWS" to use HDF5
+ Fortran DLL.
+
+ 7. Place the DLLs in a location that Windows will be able to locate. The
+ searched path and order for DLL's is
+
+ a) The directory where the executable module for the current
+ process is located.
+ b) The current directory.
+ c} The Windows system directory. The GetSystemDirectory function
+ retrieves the path of this directory.
+ d) The Windows directory. The GetWindowsDirectory function
+ retrieves the path of this directory.
+ e) The directories listed in the PATH environment variable.
+
+
+========================================================================
+ Section IV: How to build HDF5 for 64-bit Windows
+========================================================================
+
+HDF5 is available for 64-bit Windows in Visual Studio 2008.
+
+Prerequisites:
+
+ 1. A 64-bit Windows machine.
+
+ 2. Microsoft Visual Studio 2008 installed with x64 Extensions.
+
+
+Building:
+
+ Building 64-bit Windows binaries is very similar to the process for 32-bit.
+ Therefore, you may follow the instructions in Section II with the following
+ modifications.
+
+ 1. The x64 platform must be selected in the build configuration for
+ debug and release versions. Before building, go to "Build",
+ "Configuration Manager". In the "Active solution platform" box,
+ select "x64", and press "Close".
+
+ 2. 64-bit HDF5 applications must be built with 64-bit external libraries.
+ 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
+ Fortran libraries are to be built.
+
+========================================================================
+ Section V: How to build HDF5 applications using Visual Studio 2010
+========================================================================
+Building with Visual Studio 2010 is very similar to building with Visual Studio
+2008, with some minor changes. Therefore, follow the build instructions above,
+with the following considerations:
+
+ 1. Visual Studio 2010 uses a new format for project files, but Visual Studio
+ 2008 project files can be easily converted. The HDF5 project files
+ will need to be converted on first use. To do so:
+
+ 1.1. Open the HDF5 Visual Studio 2008 solution file as in Section II
+ (all.sln)
+
+ NOTE. Intel Fortran 11.1 currently does not integrate with Visual Studio 2010.
+
+ 1.2. You will be prompted with an automatic conversion wizard. Click
+ through, accepting the default values. You may choose to create
+ backups of the project files, although it isn't necessary.
+
+ 1.3. When it is finished, it should state that all projects were
+ converted successfully with no errors. Warnings can be ignored.
+
+ 2. Once the project files have been converted, build and test normally.
+ Note that the converted project files aren't backwards compatible with
+ previous versions of Visual Studio.
+
+
+========================================================================
+ Section VI: Misc.
+========================================================================
+
+1. Helpful Pointers
+
+Here are some helpful notes if you are not familiar with
+using the Visual C++ Development Environment.
+
+ 1.1 Project name and location issues:
+
+ It is recommended that you use the given directory structure for building
+ HDF5 Examples. However, it is possible to create your own structure. If you must
+ install all.sln and all.vcproj in another directory, relative to hdf5
+ directory, you will be asked to locate the sub-project files, when you open
+ the project all.sln.
+
+ If you want to rename "all" (the entire project), you will need to modify
+ two files all.sln and all.vcproj as text (contrary to the explicit warnings
+ in the files).
+
+
+ 1.2 Settings... details:
+
+ 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
+ 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
+
+
+************************************************************************
+ Please send email to help@hdfgroup.org for further assistance.