summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLarry Knox <lrknox@hdfgroup.org>2023-05-17 22:38:59 (GMT)
committerGitHub <noreply@github.com>2023-05-17 22:38:59 (GMT)
commit6e5c4a5c586b43206f77378cd1774edb168d62bb (patch)
tree2170a86b15c2a97d8dc8892a1a13881153f3a006
parentc961ef98ffb21728cb86ae30c3e3d9a3f1053672 (diff)
downloadhdf5-6e5c4a5c586b43206f77378cd1774edb168d62bb.zip
hdf5-6e5c4a5c586b43206f77378cd1774edb168d62bb.tar.gz
hdf5-6e5c4a5c586b43206f77378cd1774edb168d62bb.tar.bz2
Remove version specific examples from README_HPC. (#2613) (#2975)
-rw-r--r--release_docs/README_HPC26
1 files changed, 12 insertions, 14 deletions
diff --git a/release_docs/README_HPC b/release_docs/README_HPC
index bea5902..27dc32c 100644
--- a/release_docs/README_HPC
+++ b/release_docs/README_HPC
@@ -39,9 +39,6 @@ If no branch is specified, then the 'develop' version will be checked out.
If no source directory is specified, then the source will be located in the
'hdf5' directory. The CMake scripts expect the source to be in a directory
named hdf5-<version string>, where 'version string' uses the format '1.xx.xx'.
-For example, for the current 'develop' version, the "hdf5" directory should
-be renamed "hdf5-1.13.0", or for the first hdf5_1_12_0 pre-release version,
-it should be renamed "hdf5-1.12.0-5".
If the version number is not known a priori, the version string
can be obtained by running bin/h5vers in the top level directory of the source clone, and
@@ -65,15 +62,15 @@ scripts on compute nodes and to cross-compile for compute node hardware using
a cross-compiling emulator. The setup steps will make default settings for
parallel or serial only builds available to the CMake command.
- 1. For the current 'develop' version the "hdf5" directory should be renamed
- "hdf5-1.13.0".
+ 1. The "hdf5" directory should be renamed hdf5-<version string>. For
+ further explanation see section II.
2. Three cmake script files need to be copied to the working directory, or
have symbolic links to them, created in the working directory:
- hdf5-1.13.0/config/cmake/scripts/HDF5config.cmake
- hdf5-1.13.0/config/cmake/scripts/CTestScript.cmake
- hdf5-1.13.0/config/cmake/scripts/HDF5options.cmake
+ hdf5-<version string>/config/cmake/scripts/HDF5config.cmake
+ hdf5-<version string>/config/cmake/scripts/CTestScript.cmake
+ hdf5-<version string>/config/cmake/scripts/HDF5options.cmake
should be copied to the working directory.
@@ -82,7 +79,7 @@ parallel or serial only builds available to the CMake command.
CTestScript.cmake
HDF5config.cmake
HDF5options.cmake
- hdf5-1.13.0
+ hdf5-<version string>
Additionally, when the ctest command runs [1], it will add a build directory
in the working directory.
@@ -145,7 +142,8 @@ cori, another CrayXC40, that line is replaced by "#SBATCH -C knl,quad,cache".
For cori (and other machines), the values in LOCAL_BATCH_SCRIPT_NAME and
LOCAL_BATCH_SCRIPT_PARALLEL_NAME in the config/cmake/scripts/HPC/sbatch-HDF5options.cmake
file can be replaced by cori_knl_ctestS.sl and cori_knl_ctestS.sl, or the lines
-can be edited in the batch files in hdf5-1.13.0/bin/batch.
+can be edited in the batch files in hdf5-<version string>/bin/batch (see section II
+for version string explanation).
========================================================================
V. Manual alternatives
@@ -153,11 +151,11 @@ V. Manual alternatives
If using ctest is undesirable, one can create a build directory and run the cmake
configure command, for example
-"/projects/Mutrino/hpcsoft/cle6.0/common/cmake/3.18/bin/cmake"
--C "<working directory>/hdf5-1.15.x/config/cmake/cacheinit.cmake"
+"/projects/Mutrino/hpcsoft/cle6.0/common/cmake/<CMake version>/bin/cmake"
+-C "<working directory>/hdf5-<version string>/config/cmake/cacheinit.cmake"
-DCMAKE_BUILD_TYPE:STRING=Release -DHDF5_BUILD_FORTRAN:BOOL=ON
-DHDF5_BUILD_JAVA:BOOL=OFF
--DCMAKE_INSTALL_PREFIX:PATH=<working directory>/HDF_Group/HDF5/1.15.x
+-DCMAKE_INSTALL_PREFIX:PATH=<working directory>/HDF_Group/HDF5/<version string>
-DHDF5_ENABLE_Z_LIB_SUPPORT:BOOL=OFF -DHDF5_ENABLE_SZIP_SUPPORT:BOOL=OFF
-DHDF5_ENABLE_PARALLEL:BOOL=ON -DHDF5_BUILD_CPP_LIB:BOOL=OFF
-DHDF5_BUILD_JAVA:BOOL=OFF -DHDF5_ENABLE_THREADSAFE:BOOL=OFF
@@ -168,7 +166,7 @@ configure command, for example
-DLOCAL_BATCH_SCRIPT_NAME:STRING=knl_ctestS.sl
-DLOCAL_BATCH_SCRIPT_PARALLEL_NAME:STRING=knl_ctestP.sl -DSITE:STRING=mutrino
-DBUILDNAME:STRING=par-knl_GCC493-SHARED-Linux-4.4.156-94.61.1.16335.0.PTF.1107299-default-x86_64
-"-GUnix Makefiles" "" "<working directory>/hdf5-1.15.x"
+"-GUnix Makefiles" "" "<working directory>/hdf5-<version string>"
followed by make and batch jobs to run tests.