Update version usage

HDFGroup · Oct 3, 2024 · 647cd7e · 647cd7e
1 parent 626f639
commit 647cd7e
Show file tree

Hide file tree

Showing 12 changed files with 58 additions and 55 deletions.
diff --git a/.github/workflows/daily-build.yml b/.github/workflows/daily-build.yml
@@ -30,6 +30,7 @@ jobs:
       with:
         version: 'tags/snapshot'
         file: 'last-file.txt'
+      continue-on-error: true
 
     - name: Read base-name file
       id: gethdf5base
@@ -84,7 +85,7 @@ jobs:
     needs: [get-old-names, call-workflow-tarball, call-workflow-ctest]
     uses: ./.github/workflows/abi-report.yml
     with:
-      file_ref: '1.14.4.3'
+      file_ref: '1.14.5'
       file_base: ${{ needs.call-workflow-tarball.outputs.file_base }}
       use_tag: snapshot
       use_environ: snapshots

diff --git a/.github/workflows/h5py.yml b/.github/workflows/h5py.yml
@@ -24,8 +24,8 @@ jobs:
         sed -i 's/[email protected]:1.14/[email protected]:/g' \
         ./spack/var/spack/repos/builtin/packages/py-h5py/package.py
         . ./spack/share/spack/setup-env.sh
-        ./spack/bin/spack spec py-h5py@master+mpi ^hdf5@develop-1.15
-        ./spack/bin/spack install py-h5py@master+mpi ^hdf5@develop-1.15
+        ./spack/bin/spack spec py-h5py@master+mpi ^hdf5@develop-1.17
+        ./spack/bin/spack install py-h5py@master+mpi ^hdf5@develop-1.17
         ./spack/bin/spack install py-pytest
         ./spack/bin/spack install py-ipython
         spack load py-h5py

diff --git a/.github/workflows/intel-auto.yml b/.github/workflows/intel-auto.yml
@@ -1,4 +1,4 @@
-name: hdf5 dev autotools icx
+name: hdf5 dev autotools icx CI
 
 # Triggers the workflow on a call from another workflow
 on:

diff --git a/.github/workflows/intel-cmake.yml b/.github/workflows/intel-cmake.yml
@@ -1,4 +1,4 @@
-name: hdf5 dev CMake icx
+name: hdf5 dev CMake icx CI
 
 # Triggers the workflow on a call from another workflow
 on:

diff --git a/config/cmake/scripts/HDF5config.cmake b/config/cmake/scripts/HDF5config.cmake
@@ -43,9 +43,9 @@ set (CTEST_SOURCE_VERSEXT "")
 ##############################################################################
 # handle input parameters to script.
 #BUILD_GENERATOR - which CMake generator to use, required
-#INSTALLDIR - HDF5-1.15.x root folder
+#INSTALLDIR - HDF5-1.17.x root folder
 #CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
-#CTEST_SOURCE_NAME - name of source folder; HDF5-1.15.x
+#CTEST_SOURCE_NAME - name of source folder; HDF5-1.17.x
 #MODEL - CDash group name
 #HPC - run alternate configurations for HPC machines; sbatch, bsub, raybsub, qsub
 #MPI - enable MPI

diff --git a/release_docs/INSTALL_Autotools.txt b/release_docs/INSTALL_Autotools.txt
@@ -27,10 +27,10 @@ Obtaining HDF5 source code
    2. Obtain HDF5 source from Github
          development branch:  https://github.com/HDFGroup/hdf5
          last release:        https://github.com/HDFGroup/hdf5/releases/latest
-             hdf5-1_14_"X".tar.gz or hdf5-1_14_"X".zip
+             hdf5-1_17_"X".tar.gz or hdf5-1_17_"X".zip
 
       and put it in "myhdfstuff".
-      Uncompress the file. There should be a hdf5-1.14."X" folder.
+      Uncompress the file. There should be a hdf5-1.17."X" folder.
 
 
 ========================================================================
@@ -345,10 +345,12 @@ III. Full installation instructions for source distributions
 
 
    3.11. Backward compatibility
-        The 1.15 version of the HDF5 library can be configured to operate
-        identically to the v1.14 library with the
+        The 1.17 version of the HDF5 library can be configured to operate
+        identically to the v1.16 library with the
+            --with-default-api-version=v116
+        configure flag, or identically to the v1.14 library with the
             --with-default-api-version=v114
-        identically to the v1.12 library with the
+        configure flag, or identically to the v1.12 library with the
             --with-default-api-version=v112
         configure flag, or identically to the v1.10 library with the
             --with-default-api-version=v110
@@ -357,7 +359,7 @@ III. Full installation instructions for source distributions
         configure flag, or identically to the v1.6 library with the
             --with-default-api-version=v16
         configure flag. This allows existing code to be compiled with the
-        v1.15 library without requiring immediate changes to the application
+        v1.17 library without requiring immediate changes to the application
         source code.  For additional configuration options and other details,
         see "API Compatibility Macros":
 

diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
@@ -32,11 +32,11 @@ Obtaining HDF5 source code
              hdf5-1_15_"X".tar.gz or hdf5-1_15_"X".zip
 
       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.17."X" folder.
 
 CMake version
    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.18,
+      The HDF5 1.17."X" product requires a minimum CMake version 3.18,
       where "X" is the current HDF5 release version. If you are using
       VS2022, the minimum version is 3.21.
 
@@ -85,7 +85,7 @@ To build HDF5 with the SZIP and ZLIB external libraries you will need to:
    2. Download/copy the individual files mentioned above to "myhdfstuff".
       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.17.x".
       CTestScript.cmake file should not be modified.
 
    4. Edit the platform configuration file, HDF5options.cmake, if you want to change
@@ -113,7 +113,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.15.NN-<platform>.<zip or tar.gz>
+          HDF5-1.17.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
@@ -134,13 +134,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.15."X"-win32.msi or HDF5-1.15."X"-win64.msi
+                HDF5-1.17."X"-win32.msi or HDF5-1.17."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.15."X"
+         ----1.17."X"
          ------bin
          ------include
          ------lib
@@ -149,42 +149,42 @@ 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.15."X"-Linux.sh
+                <path-to>/myhdfstuff/HDF5-1.17."X"-Linux.sh
       After accepting the license, the script will prompt:
         By default the HDF5 will be installed in:
-        "<current directory>/HDF5-1.15."X"-Linux"
-        Do you want to include the subdirectory HDF5-1.15."X"-Linux?
+        "<current directory>/HDF5-1.17."X"-Linux"
+        Do you want to include the subdirectory HDF5-1.17."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.15."X"
+         ----1.17."X"
          ------bin
          ------include
          ------lib
          --------plugins
          ------share
 
-      On Mac you will find HDF5-1.15."X"-Darwin.dmg in the myhdfstuff folder. Click
+      On Mac you will find HDF5-1.17."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.15."X"
+         ----1.17."X"
          ------bin
          ------include
          ------lib
          --------plugins
          ------share
 
       By default the installation will create the bin, include, lib and cmake
-      folders in the <install destination directory>/HDF_Group/HDF5/1.15."X"
+      folders in the <install destination directory>/HDF_Group/HDF5/1.17."X"
       The <install destination directory> depends on the build platform;
         Windows will set the default to:
-          C:/Program Files/HDF_Group/HDF5/1.15."X"
+          C:/Program Files/HDF_Group/HDF5/1.17."X"
         Linux will set the default to:
-          "myhdfstuff/HDF_Group/HDF5/1.15."X"
+          "myhdfstuff/HDF_Group/HDF5/1.17."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
@@ -211,13 +211,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 16 2019" -A Win32 -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.15."X"
+           cmake -G "Visual Studio 16 2019" -A Win32 -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.17."X"
 
          On Windows 64 bit
-           cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.15."X"
+           cmake -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE:STRING=Release -DBUILD_SHARED_LIBS:BOOL=OFF -DBUILD_TESTING:BOOL=ON -DHDF5_BUILD_TOOLS:BOOL=ON ..\hdf5-1.17."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.15."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.17."X"
 
          where "X" is the current release version.
 
@@ -232,13 +232,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.15."X"-win32.msi or HDF5-1.15."X"-win64.msi
+                HDF5-1.17."X"-win32.msi or HDF5-1.17."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.15."X"
+            ----1.17."X"
             ------bin
             ------include
             ------lib
@@ -247,29 +247,29 @@ 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.15."X"-Linux.sh
+                <path-to>/myhdfstuff/build/HDF5-1.17."X"-Linux.sh
          After accepting the license, the script will prompt:
            By default the HDF5 will be installed in:
-           "<current directory>/HDF5-1.15."X"-Linux"
-           Do you want to include the subdirectory HDF5-1.15."X"-Linux?
+           "<current directory>/HDF5-1.17."X"-Linux"
+           Do you want to include the subdirectory HDF5-1.17."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.15."X"
+            ----1.17."X"
             ------bin
             ------include
             ------lib
             --------plugins
             ------share
 
-         On Mac you will find HDF5-1.15."X"-Darwin.dmg in the build folder. Click
+         On Mac you will find HDF5-1.17."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.15."X"
+            ----1.17."X"
             ------bin
             ------include
             ------lib
@@ -282,7 +282,7 @@ IV. Further considerations
 ========================================================================
 
    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.17."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:

diff --git a/release_docs/INSTALL_Cygwin.txt b/release_docs/INSTALL_Cygwin.txt
@@ -94,19 +94,19 @@ Build, Test and 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.15.x' directory.
+   an `hdf5-1.17.x' directory.
 
    2.1 Non-compressed tar archive (*.tar)
 
-          $ tar xf hdf5-1.15.x.tar
+          $ tar xf hdf5-1.17.x.tar
 
    2.2 Gzip'd tar archive (*.tar.gz)
 
-          $ gunzip < hdf5-1.15.x.tar.gz | tar xf -
+          $ gunzip < hdf5-1.17.x.tar.gz | tar xf -
 
    2.3 Bzip'd tar archive (*.tar.bz2)
 
-          $ bunzip2 < hdf5-1.15.x.tar.bz2 | tar xf -
+          $ bunzip2 < hdf5-1.17.x.tar.bz2 | tar xf -
 
 2. Setup Environment
 

diff --git a/release_docs/RELEASE_PROCESS.md b/release_docs/RELEASE_PROCESS.md
@@ -207,5 +207,5 @@ For more information on the HDF5 versioning and backward and forward compatibili
 [u11]: https://github.com/HDFGroup/hdf5/blob/develop/src/CMakeLists.txt
 [u12]: https://github.com/HDFGroup/hdf5/blob/develop/configure.ac
 [u13]: https://hdfgroup.github.io/hdf5/develop/api-compat-macros.html
-[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.14
+[u14]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot-1.16
 [u15]: https://github.com/HDFGroup/hdf5/releases/tag/snapshot
diff --git a/release_docs/USING_CMake_Examples.txt b/release_docs/USING_CMake_Examples.txt
@@ -21,7 +21,7 @@ I. Preconditions
 ========================================================================
 
    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.17.x product requires a minimum CMake version
       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

diff --git a/release_docs/USING_HDF5_CMake.txt b/release_docs/USING_HDF5_CMake.txt
@@ -38,7 +38,7 @@ I. Preconditions
 ========================================================================
 
    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.17.x product requires a minimum CMake version
       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
@@ -50,24 +50,24 @@ I. Preconditions
       or environment variable, set(ENV{HDF5_ROOT} "<install_path>")
       to the installed location of HDF5.
          On Windows:
-            HDF5_ROOT=C:/Program Files/HDF_Group/HDF5/1.15.x/
+            HDF5_ROOT=C:/Program Files/HDF_Group/HDF5/1.17.x/
          On unix:
-            HDF5_ROOT=<install root folder>/HDF_Group/HDF5/1.15.x/
+            HDF5_ROOT=<install root folder>/HDF_Group/HDF5/1.17.x/
 
       If you are using shared libraries, you may need to add to the path
       environment variable. Set the path environment variable to the
       installed location of the library files for HDF5.
          On Windows (*.dll):
-            PATH=%PATH%;C:/Program Files/HDF_Group/HDF5/1.15.x/bin
+            PATH=%PATH%;C:/Program Files/HDF_Group/HDF5/1.17.x/bin
          On unix (*.so):
-            LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<install root folder>/HDF_Group/HDF5/1.15.x/lib
+            LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<install root folder>/HDF_Group/HDF5/1.17.x/lib
 
       If you are using filter plugin libraries, you will need to set the
       HDF5_PLUGIN_PATH environment variable.
          On Windows:
-            HDF5_PLUGIN_PATH=C:/Program Files/HDF_Group/HDF5/1.15.x/lib/plugin
+            HDF5_PLUGIN_PATH=C:/Program Files/HDF_Group/HDF5/1.17.x/lib/plugin
          On unix:
-            HDF5_PLUGIN_PATH=<install root folder>/HDF_Group/HDF5/1.15.x/lib/plugin
+            HDF5_PLUGIN_PATH=<install root folder>/HDF_Group/HDF5/1.17.x/lib/plugin
 
       (Note there are no quote characters used on Windows and all platforms
       use forward slashes)

diff --git a/release_docs/USING_HDF5_VS.txt b/release_docs/USING_HDF5_VS.txt
@@ -62,11 +62,11 @@ Using Visual Studio 2008 with HDF5 Libraries built with Visual Studio 2008
           and select "x64".
 
       2.2 Find the box "Show directories for", choose "Include files", add the
-          header path (i.e. c:\Program Files\HDF_Group\HDF5\1.15.x\include)
+          header path (i.e. c:\Program Files\HDF_Group\HDF5\1.17.x\include)
           to the included directories.
 
       2.3 Find the box "Show directories for", choose "Library files", add the
-          library path (i.e. c:\Program Files\HDF_Group\HDF5\1.15.x\lib)
+          library path (i.e. c:\Program Files\HDF_Group\HDF5\1.17.x\lib)
           to the library directories.
 
       2.4 If using Fortran libraries, you will also need to setup the path