Skip to content

Commit

Permalink
Remove version specific examples from README_HPC. (#2613) (#2975)
Browse files Browse the repository at this point in the history
  • Loading branch information
lrknox authored May 17, 2023
1 parent c961ef9 commit 6e5c4a5
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions release_docs/README_HPC
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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.
Expand Down Expand Up @@ -145,19 +142,20 @@ 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
========================================================================
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
Expand All @@ -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.

Expand Down

0 comments on commit 6e5c4a5

Please sign in to comment.