summaryrefslogtreecommitdiffstats
path: root/release_docs/INSTALL_CMake.txt
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2020-02-26 19:54:34 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2020-02-26 19:54:34 (GMT)
commit13f5b3aee20d1d65f56dc08f088e0f218da5cf37 (patch)
tree640a17d88714ec872636592e31010c6d4ec49010 /release_docs/INSTALL_CMake.txt
parentf53220dc201ba9ace215d517d857998e1e205fc7 (diff)
downloadhdf5-13f5b3aee20d1d65f56dc08f088e0f218da5cf37.zip
hdf5-13f5b3aee20d1d65f56dc08f088e0f218da5cf37.tar.gz
hdf5-13f5b3aee20d1d65f56dc08f088e0f218da5cf37.tar.bz2
Update examples and fix old version references.
Diffstat (limited to 'release_docs/INSTALL_CMake.txt')
-rw-r--r--release_docs/INSTALL_CMake.txt62
1 files changed, 31 insertions, 31 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 652e1f4..e1a34c5 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -26,11 +26,11 @@ Obtaining HDF5 source code
2. Obtain compressed (*.tar or *.zip) HDF5 source from
https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake
and put it in "myhdfstuff".
- Uncompress the file. There should be a hdf5-1.10."X" folder.
+ Uncompress the file. There should be a hdf5-1.13."X" folder.
CMake version
1. We suggest you obtain the latest CMake from the Kitware web site.
- The HDF5 1.10."X" product requires a minimum CMake version 3.10,
+ The HDF5 1.13."X" product requires a minimum CMake version 3.12,
where "X" is the current HDF5 release version. If you are using
VS2019, the minimum version is 3.15.
@@ -53,7 +53,7 @@ The following files referenced below are available at the HDF web site:
https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake
Single compressed file with all the files needed, including source:
- CMake-hdf5-1.10.X.zip or CMake-hdf5-1.10.X.tar.gz
+ CMake-hdf5-1.13.X.zip or CMake-hdf5-1.13.X.tar.gz
Individual files included in the above mentioned compressed files
-----------------------------------------------
@@ -65,7 +65,7 @@ External compression szip and zlib libraries:
ZLib.tar.gz
Examples Source package:
- HDF5Examples-1.10.x-Source.tar.gz
+ HDF5Examples-1.14.x-Source.tar.gz
Configuration files:
HDF5config.cmake
@@ -78,10 +78,10 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
1. Change to the development directory "myhdfstuff".
- 2. Download the CMake-hdf5-1.10.X.zip(.tar.gz) file to "myhdfstuff".
+ 2. Download the CMake-hdf5-1.13.X.zip(.tar.gz) file to "myhdfstuff".
Uncompress the file.
- 3. Change to the source directory "hdf5-1.10.x".
+ 3. Change to the source directory "hdf5-1.13.x".
CTestScript.cmake file should not be modified.
4. Edit the platform configuration file, HDF5options.cmake, if you want to change
@@ -109,7 +109,7 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
The command above will configure, build, test, and create an install
package in the myhdfstuff folder. It will have the format:
- HDF5-1.10.NN-<platform>.<zip or tar.gz>
+ HDF5-1.13.NN-<platform>.<zip or tar.gz>
On Unix, <platform> will be "Linux". A similar .sh file will also be created.
On Windows, <platform> will be "win64" or "win32". If you have an
@@ -130,13 +130,13 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
6. To install, "X" is the current release version
On Windows (with WiX installed), execute:
- HDF5-1.10."X"-win32.msi or HDF5-1.10."X"-win64.msi
+ HDF5-1.13."X"-win32.msi or HDF5-1.13."X"-win64.msi
By default this program will install the hdf5 library into the
"C:\Program Files" directory and will create the following
directory structure:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
@@ -144,40 +144,40 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
On Linux, change to the install destination directory
(create it if doesn't exist) and execute:
- <path-to>/myhdfstuff/HDF5-1.10."X"-Linux.sh
+ <path-to>/myhdfstuff/HDF5-1.13."X"-Linux.sh
After accepting the license, the script will prompt:
By default the HDF5 will be installed in:
- "<current directory>/HDF5-1.10."X"-Linux"
- Do you want to include the subdirectory HDF5-1.10."X"-Linux?
+ "<current directory>/HDF5-1.13."X"-Linux"
+ Do you want to include the subdirectory HDF5-1.13."X"-Linux?
Saying no will install in: "<current directory>" [Yn]:
Note that the script will create the following directory structure
relative to the install point:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
------share
- On Mac you will find HDF5-1.10."X"-Darwin.dmg in the myhdfstuff folder. Click
+ On Mac you will find HDF5-1.13."X"-Darwin.dmg in the myhdfstuff folder. Click
on the dmg file to proceed with installation. After accepting the license,
there will be a folder with the following structure:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
------share
By default the installation will create the bin, include, lib and cmake
- folders in the <install destination directory>/HDF_Group/HDF5/1.10."X"
+ folders in the <install destination directory>/HDF_Group/HDF5/1.13."X"
The <install destination directory> depends on the build platform;
Windows will set the default to:
- C:/Program Files/HDF_Group/HDF5/1.10."X"
+ C:/Program Files/HDF_Group/HDF5/1.13."X"
Linux will set the default to:
- "myhdfstuff/HDF_Group/HDF5/1.10."X"
+ "myhdfstuff/HDF_Group/HDF5/1.13."X"
The default can be changed by adding ",INSTALLDIR=<my new dir>" to the
"ctest -S HDF5config.cmake..." command. For example on linux:
ctest -S HDF5config.cmake,INSTALLDIR=/usr/local/myhdf5,BUILD_GENERATOR=Unix -C Release -VV -O hdf5.log
@@ -204,13 +204,13 @@ Notes: This short set of instructions is written for users who want to
5. Configure the C library, tools and tests with one of the following commands:
On Windows 32 bit
- cmake -G "Visual Studio 12 2013" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.10."X"
+ cmake -G "Visual Studio 12 2013" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.13."X"
On Windows 64 bit
- cmake -G "Visual Studio 12 2013 Win64" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.10."X"
+ cmake -G "Visual Studio 12 2013 Win64" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.13."X"
On Linux and Mac
- cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ../hdf5-1.10."X"
+ cmake -G "Unix Makefiles" -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ../hdf5-1.13."X"
where "X" is the current release version.
@@ -225,13 +225,13 @@ Notes: This short set of instructions is written for users who want to
9. To install
On Windows (with WiX installed), execute:
- HDF5-1.10."X"-win32.msi or HDF5-1.10."X"-win64.msi
+ HDF5-1.13."X"-win32.msi or HDF5-1.13."X"-win64.msi
By default this program will install the hdf5 library into the
"C:\Program Files" directory and will create the following
directory structure:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
@@ -239,28 +239,28 @@ Notes: This short set of instructions is written for users who want to
On Linux, change to the install destination directory
(create if doesn't exist) and execute:
- <path-to>/myhdfstuff/build/HDF5-1.10."X"-Linux.sh
+ <path-to>/myhdfstuff/build/HDF5-1.13."X"-Linux.sh
After accepting the license, the script will prompt:
By default the HDF5 will be installed in:
- "<current directory>/HDF5-1.10."X"-Linux"
- Do you want to include the subdirectory HDF5-1.10."X"-Linux?
+ "<current directory>/HDF5-1.13."X"-Linux"
+ Do you want to include the subdirectory HDF5-1.13."X"-Linux?
Saying no will install in: "<current directory>" [Yn]:
Note that the script will create the following directory structure
relative to the install point:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
------share
- On Mac you will find HDF5-1.10."X"-Darwin.dmg in the build folder. Click
+ On Mac you will find HDF5-1.13."X"-Darwin.dmg in the build folder. Click
on the dmg file to proceed with installation. After accepting the license,
there will be a folder with the following structure:
HDF_Group
--HDF5
- ----1.10."X"
+ ----1.13."X"
------bin
------include
------lib
@@ -272,7 +272,7 @@ IV. Further considerations
========================================================================
1. We suggest you obtain the latest CMake for windows from the Kitware
- web site. The HDF5 1.10."X" product requires a minimum CMake version 3.10.
+ web site. The HDF5 1.13."X" product requires a minimum CMake version 3.12.
2. If you plan to use Zlib or Szip:
A. Download the binary packages and install them in a central location.
@@ -656,7 +656,7 @@ HDF5_STRICT_FORMAT_CHECKS "Whether to perform strict file format checks"
HDF_TEST_EXPRESS "Control testing framework (0-3)" "0"
HDF5_TEST_VFD "Execute tests with different VFDs" OFF
HDF5_TEST_PASSTHROUGH_VOL "Execute tests with different passthrough VOL connectors" OFF
-DEFAULT_API_VERSION "Enable default API (v16, v18, v110, v112)" "v112"
+DEFAULT_API_VERSION "Enable default API (v16, v18, v110, v112, v114)" "v114"
HDF5_USE_FOLDERS "Enable folder grouping of projects in IDEs." ON
HDF5_WANT_DATA_ACCURACY "IF data accuracy is guaranteed during data conversions" ON
HDF5_WANT_DCONV_EXCEPTION "exception handling functions is checked during data conversions" ON