diff options
Diffstat (limited to 'release_docs')
| -rwxr-xr-x | release_docs/CMake.txt | 111 | ||||
| -rw-r--r-- | release_docs/INSTALL_Cygwin.txt | 37 | ||||
| -rw-r--r-- | release_docs/INSTALL_MinGW.txt | 263 | ||||
| -rw-r--r-- | release_docs/INSTALL_Windows.txt | 126 | ||||
| -rwxr-xr-x | release_docs/INSTALL_Windows_From_Command_Line.txt | 8 | ||||
| -rwxr-xr-x | release_docs/INSTALL_Windows_Short_VS2008.TXT | 192 | ||||
| -rw-r--r-- | release_docs/RELEASE.txt | 93 |
7 files changed, 466 insertions, 364 deletions
diff --git a/release_docs/CMake.txt b/release_docs/CMake.txt new file mode 100755 index 0000000..8a9dd03 --- /dev/null +++ b/release_docs/CMake.txt @@ -0,0 +1,111 @@ +************************************************************************ +* Build and Install HDF5 C/C++ Library with CMake * +************************************************************************ + +Notes: This short instruction is written for users who want to quickly build + HDF5 library and tools from the HDF5 source code package using the + CMake tools. + + More information about using CMake can be found at the KitWare site, + www.cmake.org. + + CMake uses the command line, however the visual CMake tool is + recommended for the configuration step. The steps are similiar for + all the operating systems supported by CMake. + + NOTES: + 1. CMake is being introduced in this release as early-access. While + we have attempted to provide error-free files, please understand + that this development with CMake has just began. The CMake + specific files may change before the next release. + + +======================================================================== + Preconditions +======================================================================== + + 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.1. + + 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. + +======================================================================== + Building HDF5 C/C++ Libraries with CMake +======================================================================== + + 1. Run CMake + + The CMake executable is named "cmake-gui.exe" on Windows and should be + available in your Start menu. For Linux, UNIX, and Mac users the + executable is named "cmake-gui" and can be found where CMake was + installed. + Specify the source and build directories. It is recommemded that you + choose a build directory different then the source directory + (for example on Windows, if the source is at c:\MyHDFstuff\hdf5, then + use c:\MyHDFstuff\hdf5\build or c:\MyHDFstuff\build\hdf5). + + 2. Configure the cache settings + + Click the Configure button. If this is the first time you are + running cmake-gui in this directory, you will be prompted for the + generator you wish to use (for example on Windows, Visual Studio 9 2008). + CMake will read in the CMakeLists.txt files from the source directory and + display options for the HDF5 project. After the first configure you + can adjust the cache settings and/or specify locations of other programs. + + Any conflicts or new values will be highlighted by the configure + process in red. Once you are happy with all the settings and there are no + more values in red, click the Generate button to produce the appropriate + build files. + + On Windows, if you are using a Visual Studio generator, the solution and + project files will be created in the build folder. + + On linux, if you are using the Unix Makefiles generator, the Makefiles will + be created in the build folder. + + 3. Build HDF5 + + On Windows, you can build HDF5 using either the Visual Studio Environment + or the command line. The command line is used on linux, Unix, and Mac. + + To build from the command line, navigate to your build directory and + execute the following; + + cmake --build . --config {Debug | Release} + + NOTE: "--config {Debug | Release}" may be optional on your platform. We + recommend choosing either Debug or Release on Windows. + + 3.1 If you wish to use the Visual Studio environment, open the solution + file in your build directory. Be sure to select either Debug or + Release and build the solution. + + + 4. Test HDF5. + + To test the build, navigate to your build directory and execute; + + ctest . -C {Debug | Release} + + NOTE: "-C {Debug | Release}" may be optional on your platform. We + recommend choosing either Debug or Release to match the build + step on Windows. + + 5. The files that support building HDF5 with CMake are all the files in the + Resources folder, the CMakeLists.txt files in each source folder, and two + additional files, ConfigureChecks.cmake and CTestConfig.cmake. The + CTestConfig.cmake is specific to the internal testing performed by The HDF + Group. It should be altered for the users installation and needs. + + 6. More information about using CMake can be found at the KitWare site, + www.cmake.org. + + +************************************************************************ + +Need further assistance, send email to help@hdfgroup.org + diff --git a/release_docs/INSTALL_Cygwin.txt b/release_docs/INSTALL_Cygwin.txt index 36e7cd7..8416dfc 100644 --- a/release_docs/INSTALL_Cygwin.txt +++ b/release_docs/INSTALL_Cygwin.txt @@ -2,12 +2,10 @@ HDF5 Build and Install Instructions for Cygwin ************************************************************************ -Needs Updating to latest versions - Preconditions: -------------- -1. Installed Cygwin 1.5.17 or higher +1. Installed Cygwin 1.7.5 or higher To install the Cygwin net release, go to http://www.cygwin.com and click on "Install or update now!" icon. This will download a GUI @@ -27,25 +25,18 @@ Preconditions: 2.1 C/C++ Compilers HDF5-1.8 Supported - gcc-3.4.4 is included in Cygwin, which includes: - gcc : GNU C compiler - gcc-g++: GNU C++ compiler - - 2.2 Fortran Compiler HDF5-1.8 Supported - - HDF5-1.8 supports g95(GCC 4.0.1 (g95!) Jul 22 2005) and higher. - - g95 is a free, open source Fortran 95 compiler. Users can - download the g95 binaries for Cygwin in the following website: - http://www.g95.org. + gcc (4.3.4), which includes: + gcc4-core : C compiler + gcc4-g++ : C++ compiler + gcc4-fortran : fortran compiler - 2.3 Using Compilers Not Supported + 2.2 Using Compilers Not Supported - The compilers in 2.1 and 2.2 are supported and tested by HDF + The compilers in 2.1 are supported and tested by HDF group. Any other compilers may still work but they are not guaranteed by HDF group. - If users want to use other compilers except those in 2.1 and 2.2, + If users want to use other compilers except those in 2.1, try to set the following variables to override the default choices. @@ -85,28 +76,28 @@ Install HDF5 on Cygwin The HDF5 source code is distributed in a variety of formats which can be unpacked with the following commands, each of which creates - an `hdf5-1.8.1' directory. + an `hdf5-1.8.5' directory. 2.1 Non-compressed tar archive (*.tar) - $ tar xf hdf5-1.8.1.tar + $ tar xf hdf5-1.8.5.tar 2.2 Gzip'd tar archive (*.tar.gz) - $ gunzip < hdf5-1.8.1.tar.gz | tar xf - + $ gunzip < hdf5-1.8.5.tar.gz | tar xf - 2.3 Bzip'd tar archive (*.tar.bz2) - $ bunzip2 < hdf5-1.8.1.tar.bz2 | tar xf - + $ bunzip2 < hdf5-1.8.5.tar.bz2 | tar xf - 2. Setup Environment In Cygwin, most compilers and setting are automatically detected during the configure script. However, if you are building Fortran we recommend that you explicitly set the "FC" variable in your environment to use the - g95 Fortran compiler. For example, issue the command: + gfortran compiler. For example, issue the command: - $ export FC=g95 + $ export FC=gfortran 4. Configuring diff --git a/release_docs/INSTALL_MinGW.txt b/release_docs/INSTALL_MinGW.txt deleted file mode 100644 index 75ef07f..0000000 --- a/release_docs/INSTALL_MinGW.txt +++ /dev/null @@ -1,263 +0,0 @@ -************************************************************************
- HDF5 Build and Install Instructions for MinGW
-************************************************************************
-
-Preconditions:
---------------
-
-1. Installed MinGW (5.1.4 or higher) and MSYS (1.0.10 or higher)
-
- To install the MinGW net release, go to http://www.mingw.org and
- click on "Install or update now!" icon. This will download a GUI
- installer called setup.txt which can be run to download a complete
- MinGW installation via the internet. Then follow the instructions
- on each screen to install MinGW.
-
-2. Compilers Installed
-
- 2.1 C/C++ Compilers HDF5-1.8.1 Supported
-
- gcc-3.4.2 is included in MinGW, which includes:
- gcc : GNU C compiler
- gcc-g++: GNU C++ compiler
-
- 2.2 Using Compilers Not Supported
-
- The compilers in 2.1 are supported and tested by The HDF
- Group. Any other compilers may still work but they are not
- guaranteed by HDF group.
-
- If users want to use other compilers except those in 2.1,
- try to set the following variables to override the default
- choices.
-
- CC : C compiler command
- CXX : C++ compiler command
- FC : Fortran compiler command
-
-3. HDF5 Dependencies
-
- 3.1 Zlib
-
- zlib-1.2.2 or later is supported and tested on MinGW.
-
- 3.2 Szip
- The HDF5 library has a predefined compression filter that uses
- the extended-Rice lossless compression algorithm for chunked
- datatsets. For more information about Szip compression and
- license terms see
- http://hdfgroup.org/HDF5/doc_resource/SZIP/index.html.
-
- Szip is currently not supported on MinGW, although we plan to add
- support in the future.
-
-
-Build HDF5 on MinGW
-----------------------
-
-1. Get HDF5 source code package
- Users can download HDF5 source code package from HDF website
- (http://hdfgroup.org).
-
-2. Unpacking the distribution
-
- The HDF5 source code is distributed in a variety of formats which
- can be unpacked with the following commands, each of which creates
- an `hdf5-1.8.1' directory.
-
- 2.1 Non-compressed tar archive (*.tar)
-
- $ tar xf hdf5-1.8.1.tar
-
- 2.2 Gzip'd tar archive (*.tar.gz)
-
- $ gunzip < hdf5-1.8.1.tar.gz | tar xf -
-
- 2.3 Bzip'd tar archive (*.tar.bz2)
-
- $ bunzip2 < hdf5-1.8.1.tar.bz2 | tar xf -
-
-3. Setup Environment
-
- Building HDF5 1.8.1 requires an explicit link to libws2_32.a
- to handle Windows Sockets. To do this, issue the command:
-
- $ export LIBS=-lws2_32
-
- Also, the default search path can cause trouble using ./configure in HDF5
- 1.8.1. Check that non-MinGW or non-msys directories are not added to the
- PATH. You can do this by:
-
- $ echo $PATH
-
- If there are spurious entries, specifically those related to other Windows
- compilers or tools, remove them by setting a new PATH without them. For
- example,
-
- $ export PATH=.:/usr/local/bin:/mingw/bin:/bin
-
-
-4. Remove Unsupported Source
-
- There are some projects which are built by default to test performance on
- POSIX systems. They are irrelevent on MinGW, and can cause compiler errors.
-
- To remove these projects from the build script, open ./perform/Makefile.in
- Find all instances of "h5perf_serial", and remove them (along with their
- respective extension or targets, if they exist). Then save the file.
-
-
-5. Remove Tests
-
- When building with MinGW, many tests must be removed from the
- test suite run with "make check". This is because of the way
- MinGW and Windows handles certain parsing. For example, MinGW
- treats any command parameter starting with '/' as a path, and
- replaces it with it's root directory on Windows, such as
- 'C:\msys\1.0\'.
-
- To remove the tests, open the given 'Makefile.in' and edit the
- line begining with "TEST_SCRIPT = " to remove the test script.
- For example, to remove the "testerror.sh" from ./test/Makefile.in:
-
- 1) Open ./test/Makefile.in
-
- 2) Find the line "TEST_SCRIPT = $(top_srcdir)/test/testerror.sh"
-
- 3) Change it to simply read "TEST_SCRIPT =", and save.
-
- Do this for the following Makefiles and tests:
-
- - ./test/Makefile.in: "testerror.sh"
-
- - ./tools/h5dump/Makefile.in: "testh5dump.sh" and "testh5dumpxml.sh"
-
- - ./tools/h5diff/Makefile.in: "testh5diff.sh"
-
- - ./tools/misc/Makefile.in: "testh5mkgrp.sh"
-
- - ./tools/h5copy/Makefile.in: "testh5copy.sh"
-
- - ./tools/h5ls/Makefile.in: "testh5ls.sh"
-
- - ./tools/h5stat/Makefile.in: "testh5stat.sh"
-
-
-6. Configuring
-
- Notes:
- 1) Building Fortran libraries is also currently unsupported. This is
- because the current release of gcc for mingw (3.4.5) is not compatible
- with the current g95 for mingw (g95 0.91!, gcc version 4.0.3).
-
- However, MinGW offers versions of gcc 4.x as a "Technology Preview"
- or "Testing" release. These should be compatible with the latest
- MinGW g95, but is untested. Keep in mind that this is UNSUPPORTED,
- and any Fortran binaries build should be considered experimental.
-
- 2) Shared libraries can not be built on MinGW in release 1.8.1.
-
- 3) See detailed information in hdf5/release_docs/INSTALL,
- part 5. Full installation instructions for source
- distributions
-
- In short,
-
- To configure HDF5 with C Library, use
-
- $ ./configure
-
- If you would like to build the C++ library, add the parameter:
-
- --enable-cxx
-
- If you would like to build without the Zlib library, add the parameter:
-
- --without-zlib
-
- If you would like to specify the the Zlib library, there are two ways:
-
- Using
-
- --with-zlib=INCDIR,LIBDIR
-
- For example, if the zlib library is installed in
- /usr, which is the parent directory of directories
- "include" and "lib",
-
- --with-zlib=/usr/include,/usr/lib
-
- Through the CPPFLAGS and LDFLAGS Variables
-
- For example, if zlib was installed in the directory
- /c/usr then using the following command to configure
- HDF5 with zib
-
- $ export CPPFLAGS=-I/usr/include
- $ export LDFLAGS=-L/usr/lib
-
- If you would like to specify the install directory, add the parameter:
-
- --prefix="path for installation"
-
- By default, HDF5 library, header files, examples, and
- support programs will be installed in /usr/local/lib,
- /usr/local/include, /usr/local/doc/hdf5/examples, and
- /usr/local/bin. To use a path other than /usr/local specify
- the path with the `--prefix=PATH' switch as in the above
- command.
-
- Combination of Switches
-
- All of the above switches can be combined together. For
- example, if users want to configure HDF5 C/C++
- library, with zlib library at /c/usr/, and
- install HDF5 into directory /c/hdf5 using
- gcc/g++ as C/C++ compiler:
-
- $ ./configure
- --with-zlib=/usr/include,/usr/lib
- --prefix=/c/hdf5
- --enable-cxx
- <"If no more switches, then hit Enter">
-
- Notes: The command format above is for readilibity. In practice,
- please type in the command above with at least one
- space between each line, No "Enter" until users finish
- the switches and want to run the configure.
-
-
- or do it through CPPFLAGS and LDFLAGS variables:
-
- $ CPPFLAGS=-I/usr/include \
- $ LDFLAGS=-L/usr/lib \
-
- $ ./configure
- --prefix=/c/hdf5
- --enable-cxx
- <"If no more switches, then hit Enter">
-
-7. Make and Make Check
-
- After configuration is done successfully, run the following series of
- commands to build, test and install HDF5
-
- $ make > "output file name"
- $ make check > "output file name"
-
- Before run "make install", check output file for "make check", there
- should be no failures at all.
-
-8. Make Install
-
- $ make install > "output file name"
-
-
-9. Check installed HDF5 library
-
- After step 4, go to your installation directory, there should be
- three subdirectories: "bin" "include" and "lib".
-
------------------------------------------------------------------------
-
-Need Further assistance, email help@hdfgroup.org
diff --git a/release_docs/INSTALL_Windows.txt b/release_docs/INSTALL_Windows.txt index de31747..7344006 100644 --- a/release_docs/INSTALL_Windows.txt +++ b/release_docs/INSTALL_Windows.txt @@ -35,11 +35,11 @@ Contents: Preconditions: 1. Installed Microsoft Visual Studio. This document is written for Visual - Studio 2008. We no longer support building HDF5 - using Microsoft Visual Studio .NET 2003, or Visual Studio 2005. + Studio 2008. We no longer support building HDF5 using Microsoft Visual + Studio .NET 2003 or 2005. 2. (Optional) Installed Intel Compiler 10.1 or 11.1 if you want to build HDF5 - Fortran libraries. + Fortran libraries. We no longer support Intel Fortran Compiler 9.1. 3. Install Winzip or 7-zip for extracting source tarball. @@ -61,28 +61,34 @@ Preconditions: Click the "Miscellaneous" tab and uncheck "TAR file smart CR/LF conversion" option, then click OK. - 4. Set up a directory structure to unpack the library. For example: + 4. CMake is available for this release on a experimental basis. CMake 2.8.1 + can be downloaded from the KitWare website at http://www.kitware.com. + + Note: We have attempted to mirror our Autoconf configuration files for + maintainence reasons. We are still working out the problems with + some issues like fortran shared libraries and tools testing. We + will maintain the current VS2008 project files for the 1.8 product. + + 5. Set up a directory structure to unpack the library. For example: c:\ (any drive) MyHDFstuff\ (any folder name) - 5. Download the hdf5-1.9.x source code package and use 7zip or WinZip to + 6. Download the hdf5-1.9.x source code package and use 7zip or WinZip to extract the HDF5 package into c:\MyHDFstuff. This creates a directory called 'hdf5-1.9.x' under MyHDFstuff which contains several files and directories. Rename "hdf5-1.9.x" to "hdf5". - 6. HDF5 provide options to do in-memory compression within HDF5 library. + 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. - 6.1 HDF5 uses Zlib version 1.2.3 for compression and Zlib is NOT + 7.1 HDF5 uses Zlib version 1.2.5 for compression and Zlib is NOT distributed with HDF5 library in 1.9.x release. To use Zlib library, you have to install your own Zlib DLL library or go to - ftp://ftp.hdfgroup.org/lib-external/zlib/1.2/bin/windows - to download the Zlib library. - + http://www.zlib.net/ to download the Zlib library. - 6.2 HDF5 uses Szip version 2.1 for compression and Szip compression + 7.2 HDF5 uses Szip version 2.1 for compression and Szip compression software is provided with HDF5 products in 1.9.x release. To use Szip 2.1 library, you can download Szip source codes and binaries from ftp://ftp.hdfgroup.org/lib-external/szip/2.1/bin/windows @@ -93,7 +99,7 @@ Preconditions: Szip compression feature inside HDF5 is optional. - 7. Define the following environment variables: + 8. Define the following environment variables: HDF5_EXT_ZLIB HDF5_EXT_SZIP @@ -117,18 +123,17 @@ Preconditions: Similarly, you can set: - HDF5_EXT_SZIP environment variable as szlibdll.lib + 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:\zlib123\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:\WINDOWS\system. + b. c:\zlib\zlib1.dll and c:\szip\szip.dll should be copied + into a location that the application can find. - 6. Set up path for external libraries and headers + 9. Set up path for external libraries and headers Skip this part if you don't want to use ANY compression features provided by HDF5. Please do read Section V. @@ -139,21 +144,21 @@ 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 + 9.1 If you are building on 64-bit Windows, find the "Platform" dropdown and select "x64". - 6.2 Find the box "Show directories for", choose "Include files", if you + 9.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 + c:\zlib\include, c:\szip\include) from the directory list, add the + header path (c:\zlib\include, c:\szip\include) to the included directories. - 6.3 Find the box "Show directories for", choose "Library files". If you + 9.3 Find the box "Show directories for", choose "Library files". If you cannot find your Zlib and Szip library path (for example, - c:\zlib123\dll, c:\szip\dll) from the directory list, add the library - path (c:\zlib123\dll, c:\szip\dll) to the library directories. + c:\zlib\dll, c:\szip\dll) from the directory list, add the library + path (c:\zlib\dll, c:\szip\dll) to the library directories. - 6.4 If building Fortran libraries, you will also need to setup the path + 9.4 If building Fortran libraries, you will also need to setup the path for the Intel Fortran compiler. Please see Section VI. Notes: @@ -164,28 +169,30 @@ Notes: 2. Visual Studio 6.0 is no longer supported in HDF5 1.8 or later releases. Visual Studio .NET is no longer support in HDF5 1.8.4 or later releases. Visual Studio 2005 is no longer support in HDF5 1.8.5 or later releases. + Intel Fortran 9.1 is no longer support in HDF5 1.8.5 or later releases. 3. For users who want to quickly build HDF5 library or do not want to know HDF5 building and installation details, please read the - INSTALL_Windows_Short_***.txt relating to your compiler. + INSTALL_Windows_Short_2008.txt relating to your compiler. 4. For users who would like to build and test HDF5 package from the command - line, please read INSATLL_Windows_From_Command_Line.txt. + line, please read INSTALL_Windows_From_Command_Line.txt. - 5. HDF4-related tools are not built and released with HDF5 library packages + 5. For users who would like to build and test HDF5 package using CMake, + please read CMake.txt. + + 6. 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 - 6. For Fortran users, Intel fortran Compiler 10.1 and 11.1 is currently - supported-- please see Section VI. Intel Compiler verion 9.x or earlier are - no longer supported. + 7. For Fortran users, Intel Fortran Compiler 10.1 is currently supported + -- please see Section VI. Intel Compiler verion 7.x, 8.x and 9.x are + no longer supported. Intel Compiler 11.1 can be used but the project files + must be upgraded within the Visual Studio IDE. - 7. For users who would like to build Muti-threaded version of HDF5 library, + 8. Visual Studio now only builds muti-threaded versions of HDF5 library, please read Section VII. - 8. To build HDF5 in Visual Studio 2010, be sure to read the instructions in - Section XI. - ======================================================================== Section I: What do we build and install? @@ -306,7 +313,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 for testing. + Release version must be built for testing, debug version is optional. Warning messages can be ignored. @@ -459,6 +466,9 @@ We provide 2 options for users to test HDF5 libraries and tools. To use this option, HDF5 C++ and Fortran libraries must have been built. + nodebug -- can be added to any of the above to + not test debug versions + 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 no "*FAILED*" marks. @@ -796,7 +806,7 @@ To build and test HDF5 High Level C examples: Solution" option. Then open the solution - c:\MyHDFstuff\hdf5\windows\hl\examples\allhlcexamples\allhlcexamples.dsw + c:\MyHDFstuff\hdf5\windows\hl\examples\allhlcexamples\allhlcexamples.sln 2. Select "Build", and "Configuration Manager". @@ -894,7 +904,7 @@ project, you may choose one of the following two methods. HDF5, Zlib, and Szip header files directories. For example: c:\MyHDFstuff\hdf5\hdf5lib\release\include - c:\zlib123\include + c:\zlib\include c:\szip\include Then click OK. @@ -916,7 +926,7 @@ project, you may choose one of the following two methods. example, c:\MyHDFstuff\hdf5\hdf5lib\release\include - c:\zlib123\include + c:\zlib\include c:\szip\include @@ -941,7 +951,7 @@ project, you may choose one of the following two methods. HDF5, Zlib, and Szip library files directories. For example: c:\MyHDFstuff\hdf5\hdf5lib\release\lib - c:\zlib123\dll + c:\zlib\dll c:\szip\dll Note: To link with HDF5 DLLs rathern that static libraries, simply @@ -960,7 +970,7 @@ project, you may choose one of the following two methods. example, c:\MyHDFstuff\hdf5\hdf5lib\release\lib - c:\zlib123\dll + c:\zlib\dll c:\szip\dll Note: To link with HDF5 DLLs rathern that static libraries, simply @@ -975,7 +985,7 @@ project, you may choose one of the following two methods. 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 "zlib1.lib, szlibdll.lib, hdf5.lib". + 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. @@ -1111,13 +1121,16 @@ Warning: When you modify the H5pubconf.h file as described below, DO NOT just Section VI: How to build HDF5 with Fortran Support ======================================================================== -Notes: 1. For Intel Compiler users, Intel fortran Compiler 10.1 and 11.1 are - currently supported-- please see below. Intel Compiler verion 9.x and - earlier are no longer supported. +Notes: 1. For Intel Compiler users, Intel fortran Compiler10.1 is + currently supported. Intel Compiler verion 7.x, 8.x and + 9.x are no longer supported. Intel Compiler 11.1 can be used, however + the fortran project files must be upgraded from within the IDE. - 2. The Compaq Fortran Compiler is no longer supported for HDF5 1.9. + 2. The Compaq Fortran Compiler is no longer supported for HDF5 1.8. - 3. Parallel builds should be disabled. To do so: Go to Tools > + 3. Visual Studio 2008 is supported only with Intel Fortran 10.1 and 11.1. + + 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. @@ -1145,19 +1158,19 @@ Notes: 1. For Intel Compiler users, Intel fortran Compiler 10.1 and 11.1 are right panel, make sure your "Selected Compiler" is Intel Fortran. 3) Select the right-most box for "Libraries", and add Zlib and Szip - library paths (c:\zlib123\dll, c:\szip\dll for example). + library paths (c:\zlib\dll, c:\szip\dll for example). 4) Select right-most box for "Includes", and add Zlib and Szip header - paths (c:\zlib123\include c:\szip\include, for example). + paths (c:\zlib\include c:\szip\include, for example). 5) Then click "OK". -1. Build with Intel Fortran Compiler 10.1 or 11.1 under Visual Studio 2008 +1. Build with Intel Fortran Compiler 11.1 under Visual Studio 2008 Note: This step will build HDF5 Static and DLL C and C++ Library using Visual Studio compiler as well as HDF5 Static and High Level - Fortran Library using Intel Fortran Compiler. + Fortran Library using Intel Fortran 11.1 Compiler. 1.1 Open all_fortran.sln @@ -1381,10 +1394,11 @@ Notes: 1. For Intel Compiler users, Intel fortran Compiler 10.1 and 11.1 are Section VII : How to build Multi-threaded version of HDF5 library ======================================================================== -Notes: In Visual Studio 2008 Multi-threaded is built by default. Therefore, no extra +Notes: In Visual Studio 2008, 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 - 2008. - + 2008. + ======================================================================== Section VIII: How To Build And Test HDF5 With Thread-Safe Feature @@ -1577,7 +1591,7 @@ Notes: Prerequisites: - 1. A 64-bit Windows machine. Either AMD64 and Itanium is supported. + 1. A 64-bit Windows machine. 2. Microsoft Visual Studio 2008 installed with x64 Extensions. @@ -1623,7 +1637,7 @@ some minor changes. Therefore, follow the build instructions above, with the following considerations: 1. Only Visual Studio 2008 is currently supported on Windows Vista. - + 2. Elevated security permissions are required to test the HDF5 libraries. This is because DLLs are installed in the system directory. To enable elevated security: diff --git a/release_docs/INSTALL_Windows_From_Command_Line.txt b/release_docs/INSTALL_Windows_From_Command_Line.txt index 771bcf0..7557441 100755 --- a/release_docs/INSTALL_Windows_From_Command_Line.txt +++ b/release_docs/INSTALL_Windows_From_Command_Line.txt @@ -5,12 +5,15 @@ Note: This instruction is written for users who would like to build HDF5 libraries and tools from the HDF5 source code package on command line. We no longer support building HDF5 using Microsoft Visual - Studio 2005. + Studio .NET 2003 or Visual Studio VS2005 or Intel Fortran 91. Currently, we support: 1. Building and testing HDF5 C/C++/Fortran libraries on command line with Microsoft Visual Studio 2008 for 32- or 64-bit Windows. + + 2. Building and testing HDF5 C/C++/Fortran libraries and utilities using + CMake tools. Refer to the CMAKE.txt file for detailed information. For all other Windows development tools, HDF5 should be built in the development environment. Please refer to INSTALL_Windows.txt @@ -42,7 +45,7 @@ notes in INSTALL_Windows.txt before starting below procedures. This should output a path similar to: C:\Program Files\Microsoft Visual Studio 9\Common7\Tools\ - + 1.2 Run batch file copy_hdf.bat. Go to c:\MyHDFstuff\hdf5\windows and run copy_hdf.bat. @@ -112,6 +115,7 @@ notes in INSTALL_Windows.txt before starting below procedures. /ivf101 Build HDF5 Fortran using Intel Visual Fortran 10.1 /ivf111 Build HDF5 Fortran using Intel Visual Fortran 11.1 /nodebug Build HDF5 release versions only + Note: Default is to build debug and release versions /useenv Build HDF5 using compiler settings defined in the environment, rather than the IDE. /? Help information diff --git a/release_docs/INSTALL_Windows_Short_VS2008.TXT b/release_docs/INSTALL_Windows_Short_VS2008.TXT new file mode 100755 index 0000000..8ff8866 --- /dev/null +++ b/release_docs/INSTALL_Windows_Short_VS2008.TXT @@ -0,0 +1,192 @@ +************************************************************************ +* Build and Install HDF5 C/C++ Library with Visual Studio 2008 * +* with Windows XP (Short Version) * +************************************************************************ + +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 2008 but do not want to know HDF5 building and installation + details on Windows XP. + + For detailed HDF5 build and install information, or if you have 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 from the + command line, please refer to INSTALL_Windows_From_Command_Line.txt. + + Notes: + + 1. HDF5 1.8 can also be built using Visual Studio 2008 on Windows + Vista. For details, please see Section X of INSTALL_Windows.txt. + + 2. 64-bit builds are also supported in Visual Studio 2008. For details + please see Section IX of INSTALL_Windows.txt. + + 3. Fortran libraries can be built with Visual Studio 2008 and Intel + Fortran 10.1. For details, see Section VI of INSTALL_Windows.txt. + +WARNINGS: + +Please read CAREFULLY about HDF5 build and install preconditions and +notes in INSTALL_Windows.txt before starting below procedures. + + +======================================================================== + Preconditions +======================================================================== + + 1. Set up path for external libraries and headers + + Skip this part if you don't want to use ANY compression features provided + by HDF5. Please do read Section V in INSTALL_Windows.txt. + + You have to read this part even if you want to only use Zlib or Szip. You + also need to read Section V in INSTALL_Windows.txt. + + Invoke Microsoft Visual Studio and go to "Tools" and select "Options". In + the left pane of "Option" window poped up, choose and expand "Projects", + Click on "VC++ Directories". In the right pane, Find the box "Show + directories for", choose "Include files", if you can not find your Zlib + and Szip header path (for example, c:\zlib125\include, c:\szip\include) + from the directory list, add the header path (c:\zlib125\include, + c:\szip\include) to the included directories. + + Find the box "Show directories for", choose "Library files", If you cannot + find your Zlib and Szip library path (for example, c:\zlib125\dll, + c:\szip\dll) from the directory list, add the library path + (c:\zlib125\dll, c:\szip\dll) to the library directories. + +======================================================================== + Building HDF5 C/C++ Libraries with Visual Studio 2005 +======================================================================== + + 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 files saved under c:\MyHDFstuff\hdf5\windows directory to the + corresponding directories under hdf5. + + 2. Invoke Microsoft Visual Studio compiler + + Invoke Microsoft Visual Studio. From the main menu, go to "File" and + select the "Open Solution" option. Then open the + c:\MyHDFstuff\hdf5\windows\proj\all\all.sln solution if you are building + without Fortran libraries, or + c:\MyHDFstuff\hdf5\windows\proj\all_fortran\all_fortran.sln if you would + like to use Fortran. + + You should find Windows project files listed as "all", "big", etc. on the + left. + + + 3. (Optional) Disable HDF5 C++ and High level C++ + + In HDF5 1.8, C++ and HL C++ libraries are built by default. To opt-out, + you must explicitly disable them. + + 3.1 Skip this step if you do want to build HDF5 High-Level C++ libraries + + Go to "Project" and select "Project Dependencies". Select "all", and + disable all of the following projects: + + hdf5_hl_cpp + hdf5_hl_cppdll + hl_test_table_cpp + hl_test_table_cppdll + + 3.2 Skip this step if you do want to build HDF5 High-Level libraries + + Go to "Project" and select "Project Dependencies". Select "all", and + disable all of the project files listed in the previous step, as well + as the following projects: + + hdf5_hl + hdf5_hldll + hl_test_image + hl_test_imagedll + hl_test_lite + hl_test_litedll + hl_test_table + hl_test_tabledll + hl_test_ds + hl_test_dsdll + hl_test_packet + hl_test_packetdll + + Click on "OK", From the main menu, choose "Build"-> "Build" or + "Rebuild ALL" to build both release and debug version of HDF5 + Libraries. + + + 4. Select "Build", then Select "Configuration Manager". + + 4.1 To build debug static libraries, debug multithreaded DLLs, and tests: + + In "Active Solution Configuration", select "Debug". Select "Close". + Select "Build" -> "Build Solution" or "Rebuild Solution" to build debug + version of project "all". + + 4.2 To build release static libraries, multithreaded DLLs and tests: + + In "Active Solution Configuration", select "Release". Select "Close". + Select "Build" -> "Build Solution" or "Rebuild Solution" to build release + version of project "all". + + Both debug and release versions must be built. + + Warning messages can be ignored. + +======================================================================== + Testing HDF5 C/C++ Libraries +======================================================================== + +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 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 + + nodebug -- can be added to any of the above to not + test debug versions + +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 +no "*FAILED*" marks. + +If you want to test HDF5 libraries and tools one by one, please refer to +Section II, step 2 in INSTALL_Windows.txt. + + +======================================================================== + Installing HDF5 C/C++ Libraries +======================================================================== + +Run the batch file c:\MyHDFstuff\hdf5\installhdf5lib.bat to install +all HDF5 libraries and tools into c:\MyHDFstuff\hdf5\hdf5lib directory. + +======================================================================== + Building HDF5 Examples and Applications +======================================================================== + +Building HDF5 Examples is Optional. Please read Section II, step 4 and +the following part in INSTALL_Windows.txt for detailed information. + + + +************************************************************************ + +Need further assistance, send email to help@hdfgroup.org + diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt index a3946a7..3ea01a6 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -1,4 +1,4 @@ -HDF5 version 1.9.69-FA_a4 currently under development +HDF5 version 1.9.73-FA_a4 currently under development ================================================================================ @@ -39,6 +39,15 @@ New Features Configuration: ------------- + - 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) + - Configure now adds appropriate defines for supporting large (64-bit) + files on all systems, where supported, by default, instead of only linux. + This largefile support is controllable with the --enable-largefile + configure option. This is replacing the linux-specific --enable-linux-lfs + option, which has been removed from configure. + (MAM - 2010/05/05 - 1772/1434) - Upgraded versions of autotools used to generate configuration suite. We now use Automake 1.11.1, Autoconf 2.65, and Libtool 2.2.6b. MAM 2010/04/15. @@ -67,6 +76,8 @@ New Features Library: -------- + - Improved performance of the chunk cache by avoiding unnecessary b-tree + lookups of chunks already in cache. (NAF - 2010/06/15) - Greatly improved performance of extending a dataset with early allocation. (NAF - 2010/03/24 - 1637) - Added support for filtering densely stored groups. Many of the API @@ -127,10 +138,12 @@ New Features C++ Library: ------------ - - Added function CommonFG::getObjnameByIdx to take char* for name. - (BMR - 2010/05/02) - - Added function CommonFG::getObjTypeByIdx to return type name as - a char*. + - New member functions + + Overloaded CommonFG::getObjnameByIdx to take char* for name + + Overloaded CommonFG::getObjTypeByIdx to return type name as a char*. + (BMR - 2010/05/02) + + DataSet::getInMemDataSize() to simplify getting the dataset's + data size in memory. (BMR - 2009/07/26) - These member functions were added as wrapper for H5Rdereference to replace the incorrect IdComponent::dereference(). void H5Object::dereference(H5File& h5file, void* ref) @@ -151,9 +164,11 @@ New Features Tools: ------ + - h5ls: Add new flag --follow-symlinks. (refer to --help for details) + (JKM - 2010/05/25) - h5diff: Add new flag --no-dangling-links. (refer to --help for details) (JKM - 2010/02/10) - - h5diff: Add new flag --follow-links. (refer to --help for details) + - h5diff: Add new flag --follow-symlinks. (refer to --help for details) (JKM - 2010/01/25) - h5diff: fix for displaying garbage value on LE machine for BE data. (JKM - 2009/11/20) @@ -217,6 +232,10 @@ Bug Fixes since HDF5-1.8.0 release Library ------- + - Fixed a file corruption bug that could happen when shrinking a + compressed dataset. (NAF - 2010/05/20) + - Fixed some memory leaks in VL datatype conversion when strings are + used as fill values. (MAM - 2010/05/12 - BZ# 1826) - Fixed a bug when copying objects with NULL references with the H5O_COPY_EXPAND_REFERENCE_FLAG flag set. (NAF - 2010/04/08 - 1815) - Files can now be concurrently opened more than once using the core file @@ -411,6 +430,16 @@ Bug Fixes since HDF5-1.8.0 release Tools ----- + - Change h5ls not to manipulate special characters in object name or + attribute name for smart display. bug#1784 (JKM 2010/06/28) + - Fixed h5ls to return exit code 1 (error) when non-existent file is + specified. bug#1793. (JKM 2010/04/27) + - h5copy failed to copy dangling link when the link is specified + directly. bug#1817. (JKM 2010/04/22) + - h5repack lost attributes from a dataset of reference type. bug#1726. + (JKM 2010/3/25) + - h5repack sets NULL for object reference value for group or + named datatype. bug#1814. (JKM 2010/03/19) - h5diff: fixed incorrect behavior (hang) in parallel mode when specify invalid options (ex: -v and -q) (JKM 2010/02/17) - h5dump/h5ls display buffer resize fixed in tools library. @@ -451,6 +480,18 @@ Bug Fixes since HDF5-1.8.0 release High-Level APIs: ------ + - Fixed a bug in H5DSattach_scale, H5DSis_attached and H5DSdetach_scale + caused by using H5Tget_native_type function to determine the native + type for reading REFERENCE_LIST attribute. The bug was exposed + on Mac PPC. + (EIP - 2010/05/22 -1851) + - Fixed a bug in the H5DSdetach_scale function when 0 bytes + were allocated after the last reference to a dim. scale + was removed from the list of references in a VL element of the + DIMENSION_LIST attribute; modified the function to comply + with the Spec: DIMENSION_LIST attribute is deleted now when no + dimension scales left attached. + (EIP - 2010/05/14 -1822) - Fixed a bug where the H5TB API would forget the order of fields when added out of offset order. (NAF - 2009/10/27 - 1582) - H5DSis_attached failed to account for different platform types. Added a @@ -480,6 +521,16 @@ Bug Fixes since HDF5-1.8.0 release C++ APIs -------- + - The constructor PropList::PropList(id) was fixed to act properly + according to the nature of 'id'. When 'id' is a property class id, + a new property list will be created. When 'id' id a property list id, + a copy of the property list will be made. (BMR - 2010/5/9) + - The parameters 'size' and 'bufsize' in CommonFG::getLinkval and + CommonFG::getComment, respectively, now have default values for + user's convenience. (BMR - 2009/10/23) + - NULL pointer accessing was fixed, bugzilla 1061. (BMR - 2009/10/05) + - read/write methods of DataSet and Attribute classes were fixed + to handle string correctly. (BMR - 2009/07/26) - Fixed bug that caused segfaults in Attribute::read. (BMR - 2008/04/20) - Fixed bug in PropList::getClassName to use portable HDfree instead of free. (BMR - 2008/04/20) @@ -541,15 +592,15 @@ Platforms Tested Intel(R) C++ Version 8.1 Intel(R) Fortran Compiler Version 8.1 mpich-gm-1.2.5..10-intel-r2 - Windows XP - Visual Studio .NET - Visual Studio 2005 w/ Intel Fortran 9.1 - Cygwin(native gcc compiler and g95) - MinGW(native gcc compiler and g95) - Windows XP x64 - Visual Studio 2005 w/ Intel Fortran 9.1 - Windows Vista - Visual Studio 2005 + + Windows XP Visual Studio 2008 w/ Intel Fortran 10.1 + Cygwin(1.7.5 native gcc compiler and gfortran) + + Windows XP x64 Visual Studio 2008 w/ Intel Fortran 10.1 + + Windows Vista Visual Studio 2008 w/ Intel Fortran 10.1 + + Windows Vista x64 Visual Studio 2008 w/ Intel Fortran 10.1 MAC OS 10.5 (Intel) gcc i686-apple-darwin8-gcc-4.0.1 (GCC) 4.0.1 G95 (GCC 4.0.3 (g95 0.91!) Nov 21 2006) @@ -578,7 +629,8 @@ Cray XT3 (not tested for this release) n n n n n n Windows XP n y(3) n(3) y y y Windows XP x64 n y(3) n(3) y y y -Windows Vista n n n y y y +Windows Vista n y(3) n(3) y y y +Windows Vista x64 n y(3) n(3) y y y Mac OS X 10.5 Intel n y n y y y FreeBSD 6.2 32-bit n n n y y y FreeBSD 6.2 64-bit @@ -606,9 +658,10 @@ 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 -Windows XP y y(3) y y y -Windows XP x64 y y(3) y y y -Windows Vista y n n y 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 n +Windows Vista x64 y y(3) y y n Mac OS X 10.5 Intel y y y x n FreeBSD 6.2 32-bit y y y x n FreeBSD 6.2 64-bit y y y x n @@ -627,7 +680,7 @@ SuSe Linux 2.6.5 Notes: (1) Using mpich 1.2.6. (2) Using mpich2 1.0.6. - (3) Using Visual Studio 2005 or Cygwin + (3) Using Visual Studio 2008 (Cygwin shared libraries are not supported) (4) With PGI and Absoft compilers. (5) AMD Opteron x86_64 Compiler versions for each platform are listed in the preceding |