mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-02-05 15:42:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update INSTALL files (#4052)

Browse Source
This commit is contained in:
Allen Byrne 2024-03-05 16:42:08 -06:00 committed by GitHub
parent e4d9b639d5
commit 129d80d208
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
6 changed files with 223 additions and 205 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
.github/workflows/cmake-ctest.yml vendored
View File

@ -78,7 +78,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/README.md -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/README.md -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-MSVC/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_cl.zip hdf5 7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_cl.zip hdf5
@ -146,7 +146,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/README.md ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.tar.gz ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.tar.gz ${{ runner.workspace }}/build/hdf5
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.tar.gz hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.tar.gz hdf5
@ -159,7 +159,7 @@ jobs:
mkdir "${{ runner.workspace }}/builddeb/hdf5" mkdir "${{ runner.workspace }}/builddeb/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/builddeb/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/builddeb/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/builddeb/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/builddeb/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/builddeb/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/README.md ${{ runner.workspace }}/builddeb/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.deb ${{ runner.workspace }}/builddeb/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.deb ${{ runner.workspace }}/builddeb/hdf5
cd "${{ runner.workspace }}/builddeb" cd "${{ runner.workspace }}/builddeb"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.deb hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.deb hdf5
@ -172,7 +172,7 @@ jobs:
mkdir "${{ runner.workspace }}/buildrpm/hdf5" mkdir "${{ runner.workspace }}/buildrpm/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/buildrpm/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/buildrpm/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/buildrpm/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/buildrpm/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/buildrpm/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/README.md ${{ runner.workspace }}/buildrpm/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.rpm ${{ runner.workspace }}/buildrpm/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC/*.rpm ${{ runner.workspace }}/buildrpm/hdf5
cd "${{ runner.workspace }}/buildrpm" cd "${{ runner.workspace }}/buildrpm"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.rpm hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc.rpm hdf5
@ -272,7 +272,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Clang/README.md ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Clang/*.tar.gz ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Clang/*.tar.gz ${{ runner.workspace }}/build/hdf5
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-osx12.tar.gz hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-osx12.tar.gz hdf5
@ -336,7 +336,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/README.md ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC-S3/*.tar.gz ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-GNUC-S3/*.tar.gz ${{ runner.workspace }}/build/hdf5
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc_s3.tar.gz hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_gcc_s3.tar.gz hdf5
@ -421,7 +421,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/hdfsrc/README.md -Destination ${{ runner.workspace }}/build/hdf5/ Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/README.md -Destination ${{ runner.workspace }}/build/hdf5/
Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip Copy-Item -Path ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/* -Destination ${{ runner.workspace }}/build/hdf5/ -Include *.zip
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_intel.zip hdf5 7z a -tzip ${{ steps.set-file-base.outputs.FILE_BASE }}-win-vs2022_intel.zip hdf5
@ -495,7 +495,7 @@ jobs:
mkdir "${{ runner.workspace }}/build/hdf5" mkdir "${{ runner.workspace }}/build/hdf5"
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/hdfsrc/COPYING_LBNL_HDF5 ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/hdfsrc/README.md ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/README.md ${{ runner.workspace }}/build/hdf5
cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/*.tar.gz ${{ runner.workspace }}/build/hdf5 cp ${{ runner.workspace }}/hdf5/build/${{ inputs.preset_name }}-Intel/*.tar.gz ${{ runner.workspace }}/build/hdf5
cd "${{ runner.workspace }}/build" cd "${{ runner.workspace }}/build"
tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_intel.tar.gz hdf5 tar -zcvf ${{ steps.set-file-base.outputs.FILE_BASE }}-ubuntu-2204_intel.tar.gz hdf5

5
config/cmake/HDFMacros.cmake
View File

@ -279,6 +279,7 @@ macro (HDF_README_PROPERTIES target_fortran)
if (WIN32) if (WIN32)
set (BINARY_EXAMPLE_ENDING "zip") set (BINARY_EXAMPLE_ENDING "zip")
set (BINARY_INSTALL_ENDING "msi") set (BINARY_INSTALL_ENDING "msi")
set (BINARY_COMPRESS_ENDING "zip")
if (CMAKE_CL_64) if (CMAKE_CL_64)
set (BINARY_SYSTEM_NAME "win64") set (BINARY_SYSTEM_NAME "win64")
else () else ()
@ -330,12 +331,14 @@ macro (HDF_README_PROPERTIES target_fortran)
endif () endif ()
elseif (APPLE) elseif (APPLE)
set (BINARY_EXAMPLE_ENDING "tar.gz") set (BINARY_EXAMPLE_ENDING "tar.gz")
set (BINARY_COMPRESS_ENDING "tar.gz")
set (BINARY_INSTALL_ENDING "sh") # if packaging changes - use dmg set (BINARY_INSTALL_ENDING "sh") # if packaging changes - use dmg
set (BINARY_PLATFORM "${BINARY_PLATFORM} ${CMAKE_SYSTEM_VERSION} ${CMAKE_SYSTEM_PROCESSOR}") set (BINARY_PLATFORM "${BINARY_PLATFORM} ${CMAKE_SYSTEM_VERSION} ${CMAKE_SYSTEM_PROCESSOR}")
set (BINARY_PLATFORM "${BINARY_PLATFORM}, using ${CMAKE_C_COMPILER_ID} C ${CMAKE_C_COMPILER_VERSION}") set (BINARY_PLATFORM "${BINARY_PLATFORM}, using ${CMAKE_C_COMPILER_ID} C ${CMAKE_C_COMPILER_VERSION}")
else () else ()
set (BINARY_EXAMPLE_ENDING "tar.gz") set (BINARY_EXAMPLE_ENDING "tar.gz")
set (BINARY_INSTALL_ENDING "sh") set (BINARY_COMPRESS_ENDING "tar.gz")
set (BINARY_INSTALL_ENDING "sh/deb/rpm")
set (BINARY_PLATFORM "${BINARY_PLATFORM} ${CMAKE_SYSTEM_VERSION} ${CMAKE_SYSTEM_PROCESSOR}") set (BINARY_PLATFORM "${BINARY_PLATFORM} ${CMAKE_SYSTEM_VERSION} ${CMAKE_SYSTEM_PROCESSOR}")
set (BINARY_PLATFORM "${BINARY_PLATFORM}, using ${CMAKE_C_COMPILER_ID} C ${CMAKE_C_COMPILER_VERSION}") set (BINARY_PLATFORM "${BINARY_PLATFORM}, using ${CMAKE_C_COMPILER_ID} C ${CMAKE_C_COMPILER_VERSION}")
endif () endif ()

22
config/cmake/README.md.cmake.in
View File

@ -2,13 +2,13 @@
------------------------------------------------------------------------------ ------------------------------------------------------------------------------
This directory contains the binary (release) distribution of This directory contains the binary (release) distribution of
@HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@ that was compiled on; @HDF5_PACKAGE_NAME@ @HDF5_PACKAGE_VERSION_MAJOR@.@HDF5_PACKAGE_VERSION_MINOR@ that was compiled on;
@BINARY_PLATFORM@. @BINARY_PLATFORM@.
It was built with the following options: It was built with the following options:
-- @LIB_TYPE@ C/C++/Fortran libraries -- @LIB_TYPE@ C/C++/Fortran libraries
-- SZIP (encoder enabled) and ZLIB -- SZIP (encoder enabled) and ZLIB
-- @LIB_TYPE@ HDF5 tools -- HDF5 tools
-- Java @Java_VERSION@ -- Java @Java_VERSION@
The contents of this directory are: The contents of this directory are:
@ -16,17 +16,12 @@ The contents of this directory are:
COPYING - Copyright notice COPYING - Copyright notice
README.md - This file README.md - This file
@HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@ - HDF5 Install Package @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_INSTALL_ENDING@ - HDF5 Install Package
OR
@HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_COMPRESS_ENDING@ - HDF5 Compressed Package
This binary was built with the ZLIB and SZIP/Libaec external libraries and are This binary was built with the ZLIB and SZIP/Libaec external libraries and are
included for convenience. Libaec is an unrestricted open-source replacement for SZIP included for convenience. Libaec is an unrestricted open-source replacement for SZIP
(version 1.0.4, Encoder ENABLED). (Encoder ENABLED).
The official ZLIB and SZIP/Libaec pages are at:
ZLIB: https://git.savannah.gnu.org/cgit/gzip.git/
https://git.savannah.gnu.org/cgit/gzip.git/tree/COPYING
SZIP/Libaec: https://github.com/MathisRosenhauer/libaec
https://github.com/MathisRosenhauer/libaec/blob/master/LICENSE.txt
Installation Installation
@ -35,6 +30,11 @@ Installation
2. Follow prompts 2. Follow prompts
=========================================================================== ===========================================================================
Uncompress
===========================================================================
1. Extract @HDF5_PACKAGE_NAME@-@HDF5_PACKAGE_VERSION@-@BINARY_SYSTEM_NAME@.@BINARY_COMPRESS_ENDING@
===========================================================================
After Installation After Installation
=========================================================================== ===========================================================================
The examples folder, HDF5Examples, located in the The examples folder, HDF5Examples, located in the
@ -75,6 +75,6 @@ For more information see USING_CMake_Examples.txt in the install folder.
=========================================================================== ===========================================================================
Documentation for this release can be found at the following URL: Documentation for this release can be found at the following URL:
https://portal.hdfgroup.org/display/HDF5/HDF5 https://portal.hdfgroup.org/documentation/index.html#hdf5
Bugs should be reported to help@hdfgroup.org. Bugs should be reported to help@hdfgroup.org.

351
release_docs/INSTALL_CMake.txt
View File

@ -15,6 +15,7 @@ Section VII: User Defined Options for HDF5 Libraries with CMake
Section VIII: User Defined Compile Flags for HDF5 Libraries with CMake Section VIII: User Defined Compile Flags for HDF5 Libraries with CMake
Section IX: Considerations for cross-compiling Section IX: Considerations for cross-compiling
Section X: Using CMakePresets.json for compiling Section X: Using CMakePresets.json for compiling
Section XI: Autotools Configuration and Build
************************************************************************ ************************************************************************
@ -25,14 +26,17 @@ I. Preconditions
Obtaining HDF5 source code Obtaining HDF5 source code
1. Create a directory for your development; for example, "myhdfstuff". 1. Create a directory for your development; for example, "myhdfstuff".
2. Obtain compressed (*.tar or *.zip) HDF5 source from 2. Obtain HDF5 source from Github
https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake development branch: https://github.com/HDFGroup/hdf5
last release: https://github.com/HDFGroup/hdf5/releases/latest
hdf5-1_15_"X".tar.gz or hdf5-1_15_"X".zip
and put it in "myhdfstuff". and put it in "myhdfstuff".
Uncompress the file. There should be a hdf5-1.15."X" folder. Uncompress the file. There should be a hdf5-1.15."X" folder.
CMake version CMake version
1. We suggest you obtain the latest CMake from the Kitware web site. 1. We suggest you obtain the latest CMake from the Kitware web site.
The HDF5 1.15."X" product requires a minimum CMake version 3.12, The HDF5 1.15."X" product requires a minimum CMake version 3.18,
where "X" is the current HDF5 release version. If you are using where "X" is the current HDF5 release version. If you are using
VS2022, the minimum version is 3.21. VS2022, the minimum version is 3.21.
@ -46,37 +50,31 @@ Note:
II. Quick Step Building HDF5 Libraries with CMake Script Mode II. Quick Step Building HDF5 Libraries with CMake Script Mode
======================================================================== ========================================================================
This short set of instructions is written for users who want to quickly This short set of instructions is written for users who want to quickly
build the HDF5 C and C++ static libraries and tools with SZIP and ZLIB build the HDF5 C, C++ and Fortran shared libraries and tools
compression included. This procedure will use the default settings in from the HDF5 source code package using the CMake tools. This procedure
the config/cmake/cacheinit.cmake file. will use the default settings in the config/cmake/cacheinit.cmake file.
HDF Group recommends using the ctest script mode to build HDF5. HDF Group recommends using the ctest script mode to build HDF5.
The following files referenced below are available at the HDF web site: -------------------------------------------------------------------------
https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake -------------------------------------------------------------------------
Individual files needed as mentioned in this document
Single compressed file with all the files needed, including source: -------------------------------------------------------------------------
CMake-hdf5-1.15.X.zip or CMake-hdf5-1.15.X.tar.gz CMake build script from https://github.com/HDFGroup/hdf5/tree/master/config/cmake/scripts:
Individual files included in the above mentioned compressed files
-----------------------------------------------
CMake build script:
CTestScript.cmake CTestScript.cmake
External compression szip and zlib libraries: Configuration files from https://github.com/HDFGroup/hdf5/tree/master/config/cmake/scripts:
LIBAEC.tar.gz
SZip.tar.gz
ZLib.tar.gz
External compression plugin libraries:
hdf5_plugins.tar.gz
Examples Source package:
HDF5Examples-2.0.x-Source.tar.gz
Configuration files:
HDF5config.cmake HDF5config.cmake
HDF5options.cmake HDF5options.cmake
External compression plugin libraries from https://github.com/HDFGroup/hdf5_plugins:
hdf5_plugins.tar.gz
External compression szip and zlib libraries:
ZLIB "https://github.com/madler/zlib/releases/download/v1.2.13/zlib-1.3.tar.gz"
LIBAEC "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6/libaec-1.0.6.tar.gz"
-------------------------------------------------------------------------
-------------------------------------------------------------------------
Build scripts for windows or linux Build scripts for windows or linux
----------------------------------------------- -----------------------------------------------
@ -84,15 +82,15 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
1. Change to the development directory "myhdfstuff". 1. Change to the development directory "myhdfstuff".
2. Download the CMake-hdf5-1.15.X.zip(.tar.gz) file to "myhdfstuff". 2. Download/copy the individual files mentioned above to "myhdfstuff".
Uncompress the file. Do not uncompress the tar.gz files.
3. Change to the source directory "hdf5-1.15.x". 3. Change to the source directory "hdf5-1.15.x".
CTestScript.cmake file should not be modified. CTestScript.cmake file should not be modified.
4. Edit the platform configuration file, HDF5options.cmake, if you want to change 4. Edit the platform configuration file, HDF5options.cmake, if you want to change
the default build environment. the default build environment. The file is a compilation of the most used
(See https://portal.hdfgroup.org/display/support/How+to+Change+HDF5+CMake+Build+Options) options and by commenting/uncommenting lines the options can easily be changed.
5. From the "myhdfstuff" directory execute the CTest Script with the 5. From the "myhdfstuff" directory execute the CTest Script with the
following options: following options:
@ -279,6 +277,7 @@ IV. Further considerations
1. We suggest you obtain the latest CMake for windows from the Kitware 1. We suggest you obtain the latest CMake for windows from the Kitware
web site. The HDF5 1.15."X" product requires a minimum CMake version 3.18. web site. The HDF5 1.15."X" product requires a minimum CMake version 3.18.
If you are using VS2022, the CMake minimum version is 3.21.
2. If you plan to use Zlib or Szip: 2. If you plan to use Zlib or Szip:
A. Download the binary packages and install them in a central location. A. Download the binary packages and install them in a central location.
@ -310,7 +309,7 @@ IV. Further considerations
CMake options: CMake options:
HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ" HDF5_ALLOW_EXTERNAL_SUPPORT:STRING="TGZ"
ZLIB_TGZ_NAME:STRING="zlib_src.ext" ZLIB_TGZ_NAME:STRING="zlib_src.ext"
LIBAEC_TGZ_NAME:STRING="szaec_src.ext" LIBAEC_TGZ_NAME:STRING="libaec_src.ext"
TGZPATH:STRING="some_location" TGZPATH:STRING="some_location"
where "some_location" is the URL or full path to the compressed where "some_location" is the URL or full path to the compressed
file and ext is the type of compression file. Also set CMAKE_BUILD_TYPE file and ext is the type of compression file. Also set CMAKE_BUILD_TYPE
@ -335,6 +334,9 @@ IV. Further considerations
The files can also be retrieved from a local path if necessary The files can also be retrieved from a local path if necessary
TGZPATH:STRING="some_location" TGZPATH:STRING="some_location"
by setting
ZLIB_USE_LOCALCONTENT:BOOL=ON
LIBAEC_USE_LOCALCONTENT:BOOL=ON
3. If you plan to use compression plugins: 3. If you plan to use compression plugins:
A. Use source packages from an GIT server by adding the following CMake A. Use source packages from an GIT server by adding the following CMake
@ -421,11 +423,7 @@ Notes: CMake and HDF5
3. Build and test results can be submitted to our CDash server: 3. Build and test results can be submitted to our CDash server:
The CDash server for community submissions of hdf5 is at The CDash server for community submissions of hdf5 is at
https://cdash.hdfgroup.org. https://my.cdash.org.
Submitters are requested to register their name and contact info and
maintain their test sites. After your first submission, login and go
to your "My CDash" link and claim your site.
We ask that all submissions include the configuration information and We ask that all submissions include the configuration information and
contact information in the CTest Notes Files upload step. See the contact information in the CTest Notes Files upload step. See the
@ -508,132 +506,144 @@ These five steps are described in detail below.
* <HDF5OPTION>:BOOL=[ON | OFF] * <HDF5OPTION>:BOOL=[ON | OFF]
<cacheinit.cmake> is: <cacheinit.cmake> is:
# This is the CMakeCache file used by HDF Group for daily tests. # This is the CMakeCache file used by HDF Group for daily tests.
######################## set (CMAKE_INSTALL_FRAMEWORK_PREFIX "Library/Frameworks" CACHE STRING "Frameworks installation directory" FORCE)
# EXTERNAL cache entries set (HDF_PACKAGE_EXT "" CACHE STRING "Name of HDF package extension" FORCE)
######################## set (HDF_PACKAGE_NAMESPACE "hdf5::" CACHE STRING "Name for HDF package namespace (can be empty)" FORCE)
set (CMAKE_INSTALL_FRAMEWORK_PREFIX "Library/Frameworks" CACHE STRING "Frameworks installation directory" FORCE) set (HDF5_BUILD_CPP_LIB ON CACHE BOOL "Build C++ support" FORCE)
set (HDF_PACKAGE_EXT "" CACHE STRING "Name of HDF package extension" FORCE) set (HDF5_BUILD_FORTRAN ON CACHE BOOL "Build FORTRAN support" FORCE)
set (HDF_PACKAGE_NAMESPACE "hdf5::" CACHE STRING "Name for HDF package namespace (can be empty)" FORCE) set (HDF5_BUILD_JAVA ON CACHE BOOL "Build JAVA support" FORCE)
set (HDF5_BUILD_CPP_LIB ON CACHE BOOL "Build C++ support" FORCE) set (HDF5_INSTALL_MOD_FORTRAN "NO" CACHE STRING "Copy FORTRAN mod files to include directory (NO SHARED STATIC)" FORCE)
set (HDF5_BUILD_FORTRAN ON CACHE BOOL "Build FORTRAN support" FORCE) set_property (CACHE HDF5_INSTALL_MOD_FORTRAN PROPERTY STRINGS NO SHARED STATIC)
set (HDF5_BUILD_JAVA ON CACHE BOOL "Build JAVA support" FORCE) set (HDF5_BUILD_GENERATORS ON CACHE BOOL "Build Test Generators" FORCE)
set (HDF5_INSTALL_MOD_FORTRAN "NO" CACHE STRING "Copy FORTRAN mod files to include directory (NO SHARED STATIC)" FORCE) set (MPIEXEC_MAX_NUMPROCS "4" CACHE STRING "Minimum number of processes for HDF parallel tests" FORCE)
set_property (CACHE HDF5_INSTALL_MOD_FORTRAN PROPERTY STRINGS NO SHARED STATIC) set (HDF5_ENABLE_ALL_WARNINGS ON CACHE BOOL "Enable all warnings" FORCE)
set (HDF5_BUILD_GENERATORS ON CACHE BOOL "Build Test Generators" FORCE) set (HDF_TEST_EXPRESS "2" CACHE STRING "Control testing framework (0-3)" FORCE)
set (MPIEXEC_MAX_NUMPROCS "4" CACHE STRING "Minimum number of processes for HDF parallel tests" FORCE) set (HDF5_MINGW_STATIC_GCC_LIBS ON CACHE BOOL "Statically link libgcc/libstdc++" FORCE)
set (HDF5_ENABLE_ALL_WARNINGS ON CACHE BOOL "Enable all warnings" FORCE) set (HDF5_ALLOW_EXTERNAL_SUPPORT "TGZ" CACHE STRING "Allow External Library Building (NO GIT TGZ)" FORCE)
set (HDF_TEST_EXPRESS "2" CACHE STRING "Control testing framework (0-3)" FORCE) set_property (CACHE HDF5_ALLOW_EXTERNAL_SUPPORT PROPERTY STRINGS NO GIT TGZ)
set (HDF5_MINGW_STATIC_GCC_LIBS ON CACHE BOOL "Statically link libgcc/libstdc++" FORCE) ########################
set (HDF5_ALLOW_EXTERNAL_SUPPORT "TGZ" CACHE STRING "Allow External Library Building (NO GIT TGZ)" FORCE) # compression options
set_property (CACHE HDF5_ALLOW_EXTERNAL_SUPPORT PROPERTY STRINGS NO GIT TGZ) ########################
set (ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of ZLIB package" FORCE) set (ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of ZLIB package" FORCE)
set (ZLIB_TGZ_NAME "zlib-1.3.tar.gz" CACHE STRING "Use HDF5_ZLib from compressed file" FORCE) set (ZLIB_TGZ_NAME "zlib-1.3.tar.gz" CACHE STRING "Use HDF5_ZLib from compressed file" FORCE)
set (ZLIB_TGZ_ORIGPATH "https://github.com/madler/zlib/releases/download/v1.3" CACHE STRING "Use ZLIB from original location" FORCE) set (ZLIB_TGZ_ORIGPATH "https://github.com/madler/zlib/releases/download/v1.3" CACHE STRING "Use ZLIB from original location" FORCE)
set (ZLIB_TGZ_NAME "zlib-1.3.tar.gz" CACHE STRING "Use ZLIB from original compressed file" FORCE) set (ZLIB_USE_LOCALCONTENT ON CACHE BOOL "Use local file for ZLIB FetchContent" FORCE)
set (ZLIB_USE_LOCALCONTENT ON CACHE BOOL "Use local file for ZLIB FetchContent" FORCE) set (ZLIB_GIT_URL "https://github.com/madler/zlib.git" CACHE STRING "Use ZLIB from GitHub repository" FORCE)
set (LIBAEC_PACKAGE_NAME "libaec" CACHE STRING "Name of AEC SZIP package" FORCE) set (ZLIB_GIT_BRANCH "develop" CACHE STRING "" FORCE)
set (LIBAEC_TGZ_ORIGPATH "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6" CACHE STRING "Use LIBAEC from original location" FORCE) set (LIBAEC_PACKAGE_NAME "libaec" CACHE STRING "Name of AEC SZIP package" FORCE)
set (LIBAEC_TGZ_NAME "libaec-1.0.6.tar.gz" CACHE STRING "Use LIBAEC from original compressed file" FORCE) set (LIBAEC_TGZ_NAME "libaec-1.0.6.tar.gz" CACHE STRING "Use SZip AEC from compressed file" FORCE)
set (LIBAEC_USE_LOCALCONTENT ON CACHE BOOL "Use local file for LIBAEC FetchContent" FORCE) set (LIBAEC_TGZ_ORIGPATH "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6" CACHE STRING "Use LIBAEC from original location" FORCE)
####################### set (LIBAEC_USE_LOCALCONTENT ON CACHE BOOL "Use local file for LIBAEC FetchContent" FORCE)
# filter plugin options set (LIBAEC_GIT_URL "https://github.com/MathisRosenhauer/libaec.git" CACHE STRING "Use LIBAEC from GitHub repository" FORCE)
####################### set (LIBAEC_GIT_BRANCH "v1.0.6" CACHE STRING "" FORCE)
set (PLUGIN_TGZ_ORIGPATH "https://github.com/HDFGroup/hdf5_plugins/releases/download/snapshots" CACHE STRING "Use PLUGINS from original location" FORCE) ########################
set (PLUGIN_TGZ_NAME "hdf5_plugins-master.tar.gz" CACHE STRING "Use PLUGINS from compressed file" FORCE) # API test options
set (PLUGIN_USE_LOCALCONTENT ON CACHE BOOL "Use local file for PLUGIN FetchContent" FORCE) ########################
set (PLUGIN_PACKAGE_NAME "pl" CACHE STRING "Name of PLUGIN package" FORCE) set (KWSYS_TGZ_ORIGPATH "https://gitlab.kitware.com/utils/kwsys/-/archive/master" CACHE STRING "Use KWSYS from original location" FORCE)
############ set (KWSYS_TGZ_NAME "kwsys-master.tar.gz" CACHE STRING "Use KWSYS from original compressed file" FORCE)
# bitshuffle set (KWSYS_USE_LOCALCONTENT OFF CACHE BOOL "Use local file for KWSYS FetchContent" FORCE)
########### ########################
set (BSHUF_GIT_URL "https://github.com/kiyo-masui/bitshuffle.git" CACHE STRING "Use BSHUF from HDF repository" FORCE) # filter plugin options
set (BSHUF_GIT_BRANCH "master" CACHE STRING "" FORCE) ########################
set (BSHUF_TGZ_ORIGPATH "https://github.com/kiyo-masui/bitshuffle/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE) set (PLUGIN_TGZ_ORIGPATH "https://github.com/HDFGroup/hdf5_plugins/releases/download/snapshots" CACHE STRING "Use PLUGINS from original location" FORCE)
set (BSHUF_TGZ_NAME "bitshuffle-0.5.1.tar.gz" CACHE STRING "Use BSHUF from compressed file" FORCE) set (PLUGIN_TGZ_NAME "hdf5_plugins-master.tar.gz" CACHE STRING "Use PLUGINS from compressed file" FORCE)
set (BSHUF_PACKAGE_NAME "bshuf" CACHE STRING "Name of BSHUF package" FORCE) set (PLUGIN_USE_LOCALCONTENT ON CACHE BOOL "Use local file for PLUGIN FetchContent" FORCE)
####### set (PLUGIN_PACKAGE_NAME "pl" CACHE STRING "Name of PLUGIN package" FORCE)
# blosc set (PLUGIN_GIT_URL "https://github.com/HDFGroup/hdf5_plugins.git" CACHE STRING "Use plugins from HDF Group repository" FORCE)
####### set (PLUGIN_GIT_BRANCH "master" CACHE STRING "" FORCE)
set (BLOSC_GIT_URL "https://github.com/Blosc/c-blosc.git" CACHE STRING "Use BLOSC from Github repository" FORCE) #############
set (BLOSC_GIT_BRANCH "main" CACHE STRING "" FORCE) # bitshuffle
set (BLOSC_TGZ_ORIGPATH "https://github.com/Blosc/c-blosc/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE) #############
set (BLOSC_TGZ_NAME "c-blosc-1.21.5.tar.gz" CACHE STRING "Use BLOSC from compressed file" FORCE) set (BSHUF_GIT_URL "https://github.com/kiyo-masui/bitshuffle.git" CACHE STRING "Use BSHUF from HDF repository" FORCE)
set (BLOSC_PACKAGE_NAME "blosc" CACHE STRING "Name of BLOSC package" FORCE) set (BSHUF_GIT_BRANCH "master" CACHE STRING "" FORCE)
set (BLOSC_ZLIB_GIT_URL "https://github.com/madler/zlib.git" CACHE STRING "Use ZLIB from GitHub repository" FORCE) set (BSHUF_TGZ_ORIGPATH "https://github.com/kiyo-masui/bitshuffle/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE)
set (BLOSC_ZLIB_GIT_BRANCH "develop" CACHE STRING "" FORCE) set (BSHUF_TGZ_NAME "bitshuffle-0.5.1.tar.gz" CACHE STRING "Use BSHUF from compressed file" FORCE)
set (BLOSC_ZLIB_TGZ_ORIGPATH "https://github.com/madler/zlib/releases/download/v1.3" CACHE STRING "Use PLUGINS from original location" FORCE) set (BSHUF_PACKAGE_NAME "bshuf" CACHE STRING "Name of BSHUF package" FORCE)
set (BLOSC_ZLIB_TGZ_NAME "zlib-1.3.tar.gz" CACHE STRING "Use ZLib from compressed file" FORCE) ########
set (BLOSC_ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of BLOSC_ZLIB package" FORCE) # blosc
####### ########
# bzip2 set (BLOSC_GIT_URL "https://github.com/Blosc/c-blosc.git" CACHE STRING "Use BLOSC from Github repository" FORCE)
###### set (BLOSC_GIT_BRANCH "main" CACHE STRING "" FORCE)
# set (BLOSC_TGZ_ORIGPATH "https://github.com/Blosc/c-blosc/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE)
set (BZ2_GIT_URL "https://github.com/libarchive/bzip2.git" CACHE STRING "Use BZ2 from GitHub repository" FORCE) set (BLOSC_TGZ_NAME "c-blosc-1.21.5.tar.gz" CACHE STRING "Use BLOSC from compressed file" FORCE)
set (BZ2_GIT_BRANCH "master" CACHE STRING "" FORCE) set (BLOSC_PACKAGE_NAME "blosc" CACHE STRING "Name of BLOSC package" FORCE)
set (BZ2_TGZ_ORIGPATH "https://github.com/libarchive/bzip2/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE) set (BLOSC_ZLIB_GIT_URL "https://github.com/madler/zlib.git" CACHE STRING "Use ZLIB from GitHub repository" FORCE)
set (BZ2_TGZ_NAME "bzip2-bzip2-1.0.8.tar.gz" CACHE STRING "Use BZ2 from compressed file" FORCE) set (BLOSC_ZLIB_GIT_BRANCH "develop" CACHE STRING "" FORCE)
set (BZ2_PACKAGE_NAME "bz2" CACHE STRING "Name of BZ2 package" FORCE) set (BLOSC_ZLIB_TGZ_ORIGPATH "https://github.com/madler/zlib/releases/download/v1.3" CACHE STRING "Use PLUGINS from original location" FORCE)
####### set (BLOSC_ZLIB_TGZ_NAME "zlib-1.3.tar.gz" CACHE STRING "Use ZLib from compressed file" FORCE)
# fpzip set (BLOSC_ZLIB_PACKAGE_NAME "zlib" CACHE STRING "Name of BLOSC_ZLIB package" FORCE)
####### ########
set (FPZIP_GIT_URL "https://github.com/LLNL/fpzip.git" CACHE STRING "Use FPZIP from GitHub repository" FORCE) # bzip2
set (FPZIP_GIT_BRANCH "develop" CACHE STRING "" FORCE) ########
set (FPZIP_TGZ_ORIGPATH "https://github.com/LLNL/fpzip/releases/download/1.3.0" CACHE STRING "Use PLUGINS from original location" FORCE) set (BZ2_GIT_URL "https://github.com/libarchive/bzip2.git" CACHE STRING "Use BZ2 from GitHub repository" FORCE)
set (FPZIP_TGZ_NAME "fpzip-1.3.0.tar.gz" CACHE STRING "Use FPZIP from compressed file" FORCE) set (BZ2_GIT_BRANCH "bzip2-1.0.8" CACHE STRING "" FORCE)
set (FPZIP_PACKAGE_NAME "fpzip" CACHE STRING "Name of FPZIP package" FORCE) set (BZ2_TGZ_ORIGPATH "https://github.com/libarchive/bzip2/archive/refs/tags" CACHE STRING "Use PLUGINS from original location" FORCE)
###### set (BZ2_TGZ_NAME "bzip2-bzip2-1.0.8.tar.gz" CACHE STRING "Use BZ2 from compressed file" FORCE)
# jpeg set (BZ2_PACKAGE_NAME "bz2" CACHE STRING "Name of BZ2 package" FORCE)
###### ########
set (JPEG_GIT_URL "No repo www.ijg.org/files" CACHE STRING "Use JPEG from ILG" FORCE) # fpzip
set (JPEG_GIT_BRANCH "v9e" CACHE STRING "" FORCE) ########
set (JPEG_TGZ_ORIGPATH "https://www.ijg.org/files" CACHE STRING "Use PLUGINS from original location" FORCE) set (FPZIP_GIT_URL "https://github.com/LLNL/fpzip.git" CACHE STRING "Use FPZIP from GitHub repository" FORCE)
set (JPEG_TGZ_NAME "jpegsrc.v9e.tar.gz" CACHE STRING "Use JPEG from compressed file" FORCE) set (FPZIP_GIT_BRANCH "develop" CACHE STRING "" FORCE)
set (JPEG_PACKAGE_NAME "jpeg" CACHE STRING "Name of JPEG package" FORCE) set (FPZIP_TGZ_ORIGPATH "https://github.com/LLNL/fpzip/releases/download/1.3.0" CACHE STRING "Use PLUGINS from original location" FORCE)
###### set (FPZIP_TGZ_NAME "fpzip-1.3.0.tar.gz" CACHE STRING "Use FPZIP from compressed file" FORCE)
# lz4 set (FPZIP_PACKAGE_NAME "fpzip" CACHE STRING "Name of FPZIP package" FORCE)
###### #######
set (BUILD_LZ4_LIBRARY_SOURCE ON CACHE BOOL "build the lz4 library within the plugin" FORCE) # jpeg
set (LZ4_GIT_URL "https://github.com/lz4/lz4.git" CACHE STRING "Use LZ4 from GitHub repository" FORCE) #######
set (LZ4_GIT_BRANCH "dev" CACHE STRING "" FORCE) set (JPEG_GIT_URL "https://github.com/libjpeg-turbo/libjpeg-turbo.git" CACHE STRING "Use JPEG from TurboJPEG" FORCE)
set (LZ4_TGZ_ORIGPATH "https://github.com/lz4/lz4/releases/download/v1.9.4" CACHE STRING "Use PLUGINS from original location" FORCE) set (JPEG_GIT_BRANCH "jpeg-9e" CACHE STRING "" FORCE)
set (LZ4_TGZ_NAME "lz4-1.9.4.tar.gz" CACHE STRING "Use LZ4 from compressed file" FORCE) set (JPEG_TGZ_ORIGPATH "https://www.ijg.org/files" CACHE STRING "Use PLUGINS from original location" FORCE)
set (LZ4_PACKAGE_NAME "lz4" CACHE STRING "Name of LZ4 package" FORCE) set (JPEG_TGZ_NAME "jpegsrc.v9e.tar.gz" CACHE STRING "Use JPEG from compressed file" FORCE)
###### set (JPEG_PACKAGE_NAME "jpeg" CACHE STRING "Name of JPEG package" FORCE)
# lzf ######
###### # lz4
set (LZF_URL "http://software.schmorp.de/pkg/liblzf.html" CACHE STRING "LZF home" FORCE) ######
set (LZF_TGZ_ORIGPATH "http://dist.schmorp.de/liblzf" CACHE STRING "Use LZF from original location" FORCE) set (BUILD_LZ4_LIBRARY_SOURCE ON CACHE BOOL "build the lz4 library within the plugin" FORCE)
set (LZF_TGZ_NAME "liblzf-3.6.tar.gz" CACHE STRING "Use LZF from compressed file" FORCE) set (LZ4_GIT_URL "https://github.com/lz4/lz4.git" CACHE STRING "Use LZ4 from GitHub repository" FORCE)
set (LZF_PACKAGE_NAME "lzf" CACHE STRING "Name of LZF package" FORCE) set (LZ4_GIT_BRANCH "dev" CACHE STRING "" FORCE)
######## set (LZ4_TGZ_ORIGPATH "https://github.com/lz4/lz4/releases/download/v1.9.4" CACHE STRING "Use PLUGINS from original location" FORCE)
# mafisc set (LZ4_TGZ_NAME "lz4-1.9.4.tar.gz" CACHE STRING "Use LZ4 from compressed file" FORCE)
######## set (LZ4_PACKAGE_NAME "lz4" CACHE STRING "Name of LZ4 package" FORCE)
#set (BUILD_MAFISC_LIBRARY_SOURCE OFF CACHE BOOL "build the mafisc library within the plugin" FORCE) ######
#set (MAFISC_PACKAGE_NAME "mafisc" CACHE STRING "Name of MAFISC package" FORCE) # lzf
###### ######
# szf set (LZF_URL "http://software.schmorp.de/pkg/liblzf.html" CACHE STRING "LZF home" FORCE)
###### set (LZF_TGZ_ORIGPATH "http://dist.schmorp.de/liblzf" CACHE STRING "Use LZF from original location" FORCE)
set (SZ_GIT_URL "https://github.com/szcompressor/SZ.git" CACHE STRING "Use SZ filter from GitHub repository" FORCE) set (LZF_TGZ_NAME "liblzf-3.6.tar.gz" CACHE STRING "Use LZF from compressed file" FORCE)
set (SZ_GIT_BRANCH "master" CACHE STRING "" FORCE) set (LZF_PACKAGE_NAME "lzf" CACHE STRING "Name of LZF package" FORCE)
set (SZ_TGZ_ORIGPATH "https://github.com/szcompressor/SZ/releases/download/v2.1.12.5" CACHE STRING "Use PLUGINS from original location" FORCE) #########
set (SZ_TGZ_NAME "SZ-2.1.12.5.tar.gz" CACHE STRING "Use SZ filter from compressed file" FORCE) # mafisc
set (SZF_PACKAGE_NAME "szf" CACHE STRING "Name of SZ package" FORCE) #########
###### #set (BUILD_MAFISC_LIBRARY_SOURCE OFF CACHE BOOL "build the mafisc library within the plugin" FORCE)
# zfp #set (MAFISC_TGZ_ORIGPATH "" CACHE STRING "Use PLUGINS from original location" FORCE)
###### #set (MAFISC_TGZ_NAME ".tar.gz" CACHE STRING "Use MAFISC from compressed file" FORCE)
set (ZFP_GIT_URL "https://github.com/LLNL/zfp.git" CACHE STRING "Use ZFP from GitHub repository" FORCE) #set (MAFISC_PACKAGE_NAME "mafisc" CACHE STRING "Name of MAFISC package" FORCE)
set (ZFP_GIT_BRANCH "develop" CACHE STRING "" FORCE) #####
set (ZFP_TGZ_ORIGPATH "https://github.com/LLNL/zfp/releases/download/1.0.0" CACHE STRING "Use PLUGINS from original location" FORCE) # sz
set (ZFP_TGZ_NAME "zfp-1.0.0.tar.gz" CACHE STRING "Use ZFP from compressed file" FORCE) #####
set (ZFP_PACKAGE_NAME "zfp" CACHE STRING "Name of ZFP package" FORCE) set (SZ_GIT_URL "https://github.com/szcompressor/SZ.git" CACHE STRING "Use SZ filter from GitHub repository" FORCE)
###### set (SZ_GIT_BRANCH "master" CACHE STRING "" FORCE)
# zstd set (SZ_TGZ_ORIGPATH "https://github.com/szcompressor/SZ/releases/download/v2.1.12.5" CACHE STRING "Use PLUGINS from original location" FORCE)
###### set (SZ_TGZ_NAME "SZ-2.1.12.5.tar.gz" CACHE STRING "Use SZ filter from compressed file" FORCE)
set (ZSTD_GIT_URL "https://github.com/facebook/zstd.git" CACHE STRING "Use ZSTD from GitHub repository" FORCE) set (SZ_PACKAGE_NAME "SZ" CACHE STRING "Name of SZ filter package" FORCE)
set (ZSTD_GIT_BRANCH "dev" CACHE STRING "" FORCE) ######
set (ZSTD_TGZ_ORIGPATH "https://github.com/facebook/zstd/releases/download/v1.5.5" CACHE STRING "Use PLUGINS from original location" FORCE) # zfp
set (ZSTD_TGZ_NAME "zstd-1.5.5.tar.gz" CACHE STRING "Use ZSTD from compressed file" FORCE) ######
set (ZSTD_PACKAGE_NAME "zstd" CACHE STRING "Name of ZSTD package" FORCE) set (ZFP_GIT_URL "https://github.com/LLNL/zfp.git" CACHE STRING "Use ZFP from GitHub repository" FORCE)
set (ZFP_GIT_BRANCH "develop" CACHE STRING "" FORCE)
set (ZFP_TGZ_ORIGPATH "https://github.com/LLNL/zfp/releases/download/1.0.0" CACHE STRING "Use PLUGINS from original location" FORCE)
set (ZFP_TGZ_NAME "zfp-1.0.0.tar.gz" CACHE STRING "Use ZFP from compressed file" FORCE)
set (ZFP_PACKAGE_NAME "zfp" CACHE STRING "Name of ZFP package" FORCE)
######
# zstd
######
set (ZSTD_GIT_URL "https://github.com/facebook/zstd.git" CACHE STRING "Use ZSTD from GitHub repository" FORCE)
set (ZSTD_GIT_BRANCH "dev" CACHE STRING "" FORCE)
set (ZSTD_TGZ_ORIGPATH "https://github.com/facebook/zstd/releases/download/v1.5.5" CACHE STRING "Use PLUGINS from original location" FORCE)
set (ZSTD_TGZ_NAME "zstd-1.5.5.tar.gz" CACHE STRING "Use ZSTD from compressed file" FORCE)
set (ZSTD_PACKAGE_NAME "zstd" CACHE STRING "Name of ZSTD package" FORCE)
2. Configure the cache settings 2. Configure the cache settings
@ -719,8 +729,7 @@ These five steps are described in detail below.
file such as .bz2, .tar, .tar.gz, .tgz, or .zip. Also define file such as .bz2, .tar, .tar.gz, .tgz, or .zip. Also define
CMAKE_BUILD_TYPE to be the configuration type. CMAKE_BUILD_TYPE to be the configuration type.
NOTE: HDF5 uses the file named by LIBAEC_TGZ_NAME to build SZIP. This NOTE: the file named by LIBAEC_TGZ_NAME is used to build SZIP.
is used to account for the different headers and library names.
4. Test HDF5 4. Test HDF5
@ -918,8 +927,8 @@ ZLIB_USE_LOCALCONTENT "Use local file for ZLIB FetchContent" ON
SZIP_USE_EXTERNAL "Use External Library Building for SZIP" OFF SZIP_USE_EXTERNAL "Use External Library Building for SZIP" OFF
if (HDF5_ENABLE_SZIP_SUPPORT) if (HDF5_ENABLE_SZIP_SUPPORT)
HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" ON HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" ON
LIBAEC_TGZ_ORIGPATH "Use LIBAEC from original location" "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6/libaec-1.0.6.tar.gz" LIBAEC_TGZ_ORIGPATH "Use LIBAEC from original location" "https://github.com/MathisRosenhauer/libaec/releases/download/v1.0.6"
LIBAEC_TGZ_NAME "Use LIBAEC from original compressed file" "libaec-v1.0.6.tar.gz" LIBAEC_TGZ_NAME "Use LIBAEC from original compressed file" "libaec-1.0.6.tar.gz"
LIBAEC_USE_LOCALCONTENT "Use local file for LIBAEC FetchContent" ON LIBAEC_USE_LOCALCONTENT "Use local file for LIBAEC FetchContent" ON
PLUGIN_USE_EXTERNAL "Use External Library Building for PLUGINS" OFF PLUGIN_USE_EXTERNAL "Use External Library Building for PLUGINS" OFF
@ -1153,6 +1162,14 @@ For instance, to change the support files to use a local directory, edit CMakeUs
Then you can change or add options for your specific case. Then you can change or add options for your specific case.
========================================================================
XI. Autotools Configuration and Build
========================================================================
See RELEASE.txt in the release_notes/ directory for the list of platforms
tested for this release.
Instructions for building and testing HDF5 using autotools can be found in the
INSTALL_Auto.txt file found in this folder.
======================================================================== ========================================================================

20
release_docs/USING_HDF5_CMake.txt
View File

@ -39,7 +39,7 @@ I. Preconditions
1. We suggest you obtain the latest CMake for your platform from the Kitware 1. We suggest you obtain the latest CMake for your platform from the Kitware
web site. The HDF5 1.15.x product requires a minimum CMake version web site. The HDF5 1.15.x product requires a minimum CMake version
of 3.18. If you are using VS2022, the minimum version is 3.21. of 3.18. If you are using VS2022, the minimum CMake version is 3.21.
2. You have installed the HDF5 library built with CMake, by executing 2. You have installed the HDF5 library built with CMake, by executing
the HDF Install Utility (the *.msi file in the binary package for the HDF Install Utility (the *.msi file in the binary package for
@ -93,9 +93,6 @@ Go through these steps to build HDF5 applications with CMake.
4. Test HDF5 Applications 4. Test HDF5 Applications
These steps are described in more detail below. These steps are described in more detail below.
1. Run CMake 1. Run CMake
The visual CMake executable is named "cmake-gui.exe" on Windows and should be The visual CMake executable is named "cmake-gui.exe" on Windows and should be
@ -119,8 +116,6 @@ These steps are described in more detail below.
* MinGW Makefiles * MinGW Makefiles
* NMake Makefiles * NMake Makefiles
* Unix Makefiles * Unix Makefiles
* Visual Studio 14 2015
* Visual Studio 14 2015 Win64
* Visual Studio 15 2017 * Visual Studio 15 2017
* Visual Studio 15 2017 Win64 * Visual Studio 15 2017 Win64
* Visual Studio 16 2019 * Visual Studio 16 2019
@ -138,7 +133,7 @@ These steps are described in more detail below.
2.1 Visual CMake users, click the Configure button. If this is the first time you are 2.1 Visual CMake users, click the Configure button. If this is the first time you are
running cmake-gui in this directory, you will be prompted for the running cmake-gui in this directory, you will be prompted for the
generator you wish to use (for example on Windows, Visual Studio 14 2015 Win64). generator you wish to use (for example on Windows, Visual Studio 16 2019).
CMake will read in the CMakeLists.txt files from the source directory and CMake will read in the CMakeLists.txt files from the source directory and
display options for the HDF5 project. After the first configure you display options for the HDF5 project. After the first configure you
can adjust the cache settings and/or specify locations of other programs. can adjust the cache settings and/or specify locations of other programs.
@ -156,7 +151,7 @@ These steps are described in more detail below.
2.2 Alternative command line example on Windows in c:\MyHDFstuff\hdf5\build directory: 2.2 Alternative command line example on Windows in c:\MyHDFstuff\hdf5\build directory:
cmake -G "Visual Studio 14 2015 Win64" -DBUILD_TESTING:BOOL=ON .. cmake -G "Visual Studio 16 2019" -A "x64" -DBUILD_TESTING:BOOL=ON ..
3. Build HDF5 Applications 3. Build HDF5 Applications
@ -205,7 +200,7 @@ source root. Include the following text in the file:
########################################################## ##########################################################
cmake_minimum_required (VERSION 3.18) cmake_minimum_required (VERSION 3.18)
project (HDF5MyApp C CXX) project (HDF5MyApp C)
set (LIB_TYPE STATIC) # or SHARED set (LIB_TYPE STATIC) # or SHARED
string(TOLOWER ${LIB_TYPE} SEARCH_TYPE) string(TOLOWER ${LIB_TYPE} SEARCH_TYPE)
@ -239,11 +234,10 @@ command line and the build folder is created as a sub-folder. Windows should
adjust the forward slash to double backslashes, except for the HDF_DIR adjust the forward slash to double backslashes, except for the HDF_DIR
environment variable. environment variable.
NOTE: this file is available at the HDF web site: NOTE: this file is available in the HDF5 repository, for more information see:
https://portal.hdfgroup.org/display/support/Building+HDF5+with+CMake https://github.com/HDFGroup/hdf5/blob/develop/release_docs/USING_CMake_Examples.txt
HDF5_Examples.cmake ctest -S HDF5_Examples.cmake -C Release -V -O test.log
HDF5_Examples_options.cmake
Also available at the HDF web site is a CMake application framework template. Also available at the HDF web site is a CMake application framework template.
You can quickly add files to the framework and execute the script to compile You can quickly add files to the framework and execute the script to compile

14
release_docs/USING_HDF5_VS.txt
View File

@ -12,7 +12,7 @@ be found in the USING_HDF5_CMake.txt file found in this folder.
NOTE: Building applications with the dynamic/shared hdf5 libraries requires NOTE: Building applications with the dynamic/shared hdf5 libraries requires
that the "H5_BUILT_AS_DYNAMIC_LIB" compile definition be used. that the "H5_BUILT_AS_DYNAMIC_LIB" compile definition be used.
Go to "Project" and select "Properties", find "Configuration Properties", Go to "Project" and select "Properties", find "Configuration Properties",
and then "C/C+±"and then "Preprocessor". and then "C/C++"and then "Preprocessor".
Add H5_BUILT_AS_DYNAMIC_LIB to Preprocessor definitions. Add H5_BUILT_AS_DYNAMIC_LIB to Preprocessor definitions.
The following two sections are helpful if you do not use CMake to build The following two sections are helpful if you do not use CMake to build
@ -78,7 +78,12 @@ Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
library, and then optionally the HDF5 High Level, Fortran or C++ library, and then optionally the HDF5 High Level, Fortran or C++
libraries. For example, to compile a C++ application, enter: libraries. For example, to compile a C++ application, enter:
szip.lib zlib.lib hdf5.lib hdf5_cpp.lib hdf5.lib hdf5_cpp.lib
For static linking:
HDF5 libraries: libhdf5.lib libhdf5_cpp.lib
Compression libraries: libszaec.lib libaec.lib libzlib.lib
System libraries: shlwapi.lib
======================================================================== ========================================================================
3. Helpful Pointers 3. Helpful Pointers
@ -86,10 +91,9 @@ Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
3.1 FAQ 3.1 FAQ
Many other common questions and hints are located online and being updated Community support forum available, please see:
in the HDF Knowledge Base, please see:
https://portal.hdfgroup.org/display/knowledge/HDF+Knowledge+Base https://forum.hdfgroup.org/c/hdf5/8
************************************************************************ ************************************************************************
Please send email to help@hdfgroup.org for further assistance. Please send email to help@hdfgroup.org for further assistance.