summaryrefslogtreecommitdiffstats
path: root/release_docs/INSTALL_CMake.txt
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2023-04-03 21:38:10 (GMT)
committerGitHub <noreply@github.com>2023-04-03 21:38:10 (GMT)
commit526f0769a3353b20d1265c09b3035fa4c2610933 (patch)
tree074a505f9981b618c32200451b14e9187bc9caa3 /release_docs/INSTALL_CMake.txt
parentfa388e6ba42eaf66d33c1662fe413cfeecd69a59 (diff)
downloadhdf5-526f0769a3353b20d1265c09b3035fa4c2610933.zip
hdf5-526f0769a3353b20d1265c09b3035fa4c2610933.tar.gz
hdf5-526f0769a3353b20d1265c09b3035fa4c2610933.tar.bz2
Minor fixes for CMake code and install docs (#2623)
Diffstat (limited to 'release_docs/INSTALL_CMake.txt')
-rw-r--r--release_docs/INSTALL_CMake.txt66
1 files changed, 33 insertions, 33 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index b5521f8..d9eb97d 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -27,11 +27,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.13."X" folder.
+ Uncompress the file. There should be a hdf5-1.15."X" folder.
CMake version
1. We suggest you obtain the latest CMake from the Kitware web site.
- The HDF5 1.13."X" product requires a minimum CMake version 3.12,
+ The HDF5 1.15."X" product requires a minimum CMake version 3.12,
where "X" is the current HDF5 release version. If you are using
VS2022, the minimum version is 3.21.
@@ -54,7 +54,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.13.X.zip or CMake-hdf5-1.13.X.tar.gz
+ CMake-hdf5-1.15.X.zip or CMake-hdf5-1.15.X.tar.gz
Individual files included in the above mentioned compressed files
-----------------------------------------------
@@ -83,10 +83,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.13.X.zip(.tar.gz) file to "myhdfstuff".
+ 2. Download the CMake-hdf5-1.15.X.zip(.tar.gz) file to "myhdfstuff".
Uncompress the file.
- 3. Change to the source directory "hdf5-1.13.x".
+ 3. Change to the source directory "hdf5-1.15.x".
CTestScript.cmake file should not be modified.
4. Edit the platform configuration file, HDF5options.cmake, if you want to change
@@ -96,6 +96,10 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
5. From the "myhdfstuff" directory execute the CTest Script with the
following options:
+ On 32-bit Windows with Visual Studio 2022, execute:
+ ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2022 -C Release -VV -O hdf5.log
+ On 64-bit Windows with Visual Studio 2022, execute:
+ ctest -S HDF5config.cmake,BUILD_GENERATOR=VS202264 -C Release -VV -O hdf5.log
On 32-bit Windows with Visual Studio 2019, execute:
ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2019 -C Release -VV -O hdf5.log
On 64-bit Windows with Visual Studio 2019, execute:
@@ -104,17 +108,13 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2017 -C Release -VV -O hdf5.log
On 64-bit Windows with Visual Studio 2017, execute:
ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201764 -C Release -VV -O hdf5.log
- On 32-bit Windows with Visual Studio 2015, execute:
- ctest -S HDF5config.cmake,BUILD_GENERATOR=VS2015 -C Release -VV -O hdf5.log
- On 64-bit Windows with Visual Studio 2015, execute:
- ctest -S HDF5config.cmake,BUILD_GENERATOR=VS201564 -C Release -VV -O hdf5.log
On Linux and Mac, execute:
ctest -S HDF5config.cmake,BUILD_GENERATOR=Unix -C Release -VV -O hdf5.log
The supplied build scripts are versions of the above.
The command above will configure, build, test, and create an install
package in the myhdfstuff folder. It will have the format:
- HDF5-1.13.NN-<platform>.<zip or tar.gz>
+ HDF5-1.15.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
@@ -135,13 +135,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.13."X"-win32.msi or HDF5-1.13."X"-win64.msi
+ HDF5-1.15."X"-win32.msi or HDF5-1.15."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.13."X"
+ ----1.15."X"
------bin
------include
------lib
@@ -149,40 +149,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.13."X"-Linux.sh
+ <path-to>/myhdfstuff/HDF5-1.15."X"-Linux.sh
After accepting the license, the script will prompt:
By default the HDF5 will be installed in:
- "<current directory>/HDF5-1.13."X"-Linux"
- Do you want to include the subdirectory HDF5-1.13."X"-Linux?
+ "<current directory>/HDF5-1.15."X"-Linux"
+ Do you want to include the subdirectory HDF5-1.15."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.13."X"
+ ----1.15."X"
------bin
------include
------lib
------share
- On Mac you will find HDF5-1.13."X"-Darwin.dmg in the myhdfstuff folder. Click
+ On Mac you will find HDF5-1.15."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.13."X"
+ ----1.15."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.13."X"
+ folders in the <install destination directory>/HDF_Group/HDF5/1.15."X"
The <install destination directory> depends on the build platform;
Windows will set the default to:
- C:/Program Files/HDF_Group/HDF5/1.13."X"
+ C:/Program Files/HDF_Group/HDF5/1.15."X"
Linux will set the default to:
- "myhdfstuff/HDF_Group/HDF5/1.13."X"
+ "myhdfstuff/HDF_Group/HDF5/1.15."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
@@ -209,13 +209,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.13."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.15."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.13."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.15."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.13."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.15."X"
where "X" is the current release version.
@@ -230,13 +230,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.13."X"-win32.msi or HDF5-1.13."X"-win64.msi
+ HDF5-1.15."X"-win32.msi or HDF5-1.15."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.13."X"
+ ----1.15."X"
------bin
------include
------lib
@@ -244,28 +244,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.13."X"-Linux.sh
+ <path-to>/myhdfstuff/build/HDF5-1.15."X"-Linux.sh
After accepting the license, the script will prompt:
By default the HDF5 will be installed in:
- "<current directory>/HDF5-1.13."X"-Linux"
- Do you want to include the subdirectory HDF5-1.13."X"-Linux?
+ "<current directory>/HDF5-1.15."X"-Linux"
+ Do you want to include the subdirectory HDF5-1.15."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.13."X"
+ ----1.15."X"
------bin
------include
------lib
------share
- On Mac you will find HDF5-1.13."X"-Darwin.dmg in the build folder. Click
+ On Mac you will find HDF5-1.15."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.13."X"
+ ----1.15."X"
------bin
------include
------lib
@@ -277,7 +277,7 @@ IV. Further considerations
========================================================================
1. We suggest you obtain the latest CMake for windows from the Kitware
- web site. The HDF5 1.13."X" product requires a minimum CMake version 3.18.
+ web site. The HDF5 1.15."X" product requires a minimum CMake version 3.18.
2. If you plan to use Zlib or Szip:
A. Download the binary packages and install them in a central location.