Skip to content

Commit e4113ff

Browse files
authored
Combined INSTALL_parallel and README_HPC content (#5952)
* Combined INSTALL_parallel and README_HPC into a single, README_HPC.md file. * Removed all autotools references * Updated All References
1 parent 0441a4b commit e4113ff

14 files changed

+618
-687
lines changed

CMakeInstallation.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ if (NOT HDF5_EXTERNALLY_CONFIGURED)
251251
if (HDF5_ENABLE_PARALLEL)
252252
set (release_files
253253
${release_files}
254-
${HDF5_SOURCE_DIR}/release_docs/INSTALL_parallel
254+
${HDF5_SOURCE_DIR}/release_docs/README_HPC.md
255255
)
256256
endif ()
257257
endif ()

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Several more files are located within the [release_docs/][u4] directory with spe
5151
details for several common platforms and configurations.
5252
- INSTALL - Start Here. General instructions for compiling and installing the library or using an installed library
5353
- INSTALL_CMAKE - instructions for building with CMake (Kitware.com)
54-
- INSTALL_parallel - instructions for building and configuring Parallel HDF5
54+
- README_HPC.md - instructions for building and configuring Parallel HDF5 on HPC systems
5555
- INSTALL_Windows and INSTALL_Cygwin - MS Windows installations.
5656
- USING_HDF5_CMake - Build and Install HDF5 Applications with CMake
5757
- USING_CMake_Examples - Build and Test HDF5 Examples with CMake

bin/batch/knl_ctestP.sl.in.cmake

Lines changed: 0 additions & 16 deletions
This file was deleted.

bin/batch/knl_ctestS.sl.in.cmake

Lines changed: 0 additions & 16 deletions
This file was deleted.

config/cmake/scripts/CTestScript.cmake

Lines changed: 7 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -264,15 +264,6 @@ set (ENV{CI_MODEL} ${MODEL})
264264
file (APPEND ${CTEST_SCRIPT_DIRECTORY}/FailedCTest.txt "Failed Configure: ${res}\n")
265265
endif ()
266266

267-
# On Cray XC40, configuring fails in the Fortran section when using the craype-mic-knl module.
268-
# When the configure phase is done with the craype-haswell module and the build phase is done
269-
# with the craype-mic-knl module, configure succeeds and tests pass on the knl compute nodes
270-
# for Intel, Cray, GCC and Clang compilers. If the variables aren't set or if not
271-
# cross compiling, the module switch will not occur.
272-
if (CMAKE_CROSSCOMPILING AND COMPILENODE_HWCOMPILE_MODULE AND COMPUTENODE_HWCOMPILE_MODULE)
273-
execute_process (COMMAND module switch ${COMPILENODE_HWCOMPILE_MODULE} ${COMPUTENODE_HWCOMPILE_MODULE})
274-
endif ()
275-
276267
ctest_build (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND RETURN_VALUE res NUMBER_ERRORS errval)
277268
if (LOCAL_SUBMIT)
278269
ctest_submit (PARTS Build)
@@ -287,15 +278,11 @@ set (ENV{CI_MODEL} ${MODEL})
287278
ctest_test (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND ${ctest_test_args} RETURN_VALUE res)
288279
else ()
289280
file(STRINGS ${CTEST_BINARY_DIRECTORY}/Testing/TAG TAG_CONTENTS REGEX "^2([0-9]+)[-]([0-9]+)$")
290-
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "raybsub")
291-
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME})
281+
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "qsub")
282+
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME} ctestS.out)
292283
else ()
293-
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "qsub")
294-
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME} ctestS.out)
295-
else ()
296-
execute_process (COMMAND ${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME})
297-
endif()
298-
endif ()
284+
execute_process (COMMAND ${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME})
285+
endif()
299286
message(STATUS "Check for existence of ${CTEST_BINARY_DIRECTORY}/ctestS.done")
300287
execute_process(COMMAND ls ${CTEST_BINARY_DIRECTORY}/ctestS.done RESULT_VARIABLE result OUTPUT_QUIET ERROR_QUIET)
301288
while(result)
@@ -308,14 +295,10 @@ set (ENV{CI_MODEL} ${MODEL})
308295
endif ()
309296
if (LOCAL_BATCH_SCRIPT_PARALLEL_NAME)
310297
unset(result CACHE)
311-
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "raybsub")
312-
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_PARALLEL_NAME})
298+
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "qsub")
299+
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME} ctestP.out)
313300
else ()
314-
if (LOCAL_BATCH_SCRIPT_COMMAND STREQUAL "qsub")
315-
execute_process (COMMAND ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_NAME} ctestP.out)
316-
else ()
317-
execute_process (COMMAND ${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_PARALLEL_NAME})
318-
endif ()
301+
execute_process (COMMAND ${LOCAL_BATCH_SCRIPT_COMMAND} ${LOCAL_BATCH_SCRIPT_ARGS} ${CTEST_BINARY_DIRECTORY}/${LOCAL_BATCH_SCRIPT_PARALLEL_NAME})
319302
endif ()
320303
message(STATUS "Check for existence of ${CTEST_BINARY_DIRECTORY}/ctestP.done")
321304
execute_process(COMMAND ls ${CTEST_BINARY_DIRECTORY}/ctestP.done RESULT_VARIABLE result OUTPUT_QUIET ERROR_QUIET)

config/cmake/scripts/HDF5config.cmake

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ set (CTEST_SOURCE_VERSEXT "-4")
4848
#CTEST_CONFIGURATION_TYPE - Release, Debug, RelWithDebInfo
4949
#CTEST_SOURCE_NAME - name of source folder; HDF5-2.0.x
5050
#MODEL - CDash group name
51-
#HPC - run alternate configurations for HPC machines; sbatch, bsub, raybsub, qsub
51+
#HPC - run alternate configurations for HPC machines; sbatch, bsub, qsub
5252
#MPI - enable MPI
5353
if (DEFINED CTEST_SCRIPT_ARG)
5454
# transform ctest script arguments of the form

config/cmake/scripts/HPC/qsub-HDF5options.cmake

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,6 @@ endif()
2121
### options to run test scripts in batch commands
2222
set (LOCAL_BATCH_SCRIPT_NAME "ctest.qsub")
2323
set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctest.qsub")
24-
if (DEFINED KNL)
25-
### some additions and alternatives to cross compile on haswell for knl
26-
set (COMPUTENODE_HWCOMPILE_MODULE "craype-mic-knl")
27-
set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCMAKE_TOOLCHAIN_FILE:STRING=config/toolchain/crayle.cmake")
28-
endif ()
2924
set (LOCAL_BATCH_SCRIPT_COMMAND "qsub")
3025
set (LOCAL_BATCH_TEST "TRUE")
3126
set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DLOCAL_BATCH_TEST:BOOL=ON")

config/cmake/scripts/HPC/raybsub-HDF5options.cmake

Lines changed: 0 additions & 32 deletions
This file was deleted.

config/cmake/scripts/HPC/sbatch-HDF5options.cmake

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,8 @@ if (DEFINED MPI)
1919
endif()
2020
#############################################################################################
2121
### options to run test scripts in batch commands
22-
if (DEFINED KNL)
23-
### some additions and alternatives to cross compile on haswell for knl
24-
set (COMPILENODE_HWCOMPILE_MODULE "craype-haswell")
25-
set (COMPUTENODE_HWCOMPILE_MODULE "craype-mic-knl")
26-
set (LOCAL_BATCH_SCRIPT_NAME "knl_ctestS.sl")
27-
set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "knl_ctestP.sl")
28-
set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCMAKE_TOOLCHAIN_FILE:STRING=config/toolchain/crayle.cmake")
29-
else ()
30-
set (LOCAL_BATCH_SCRIPT_NAME "ctestS.sl")
31-
set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctestP.sl")
32-
endif ()
22+
set (LOCAL_BATCH_SCRIPT_NAME "ctestS.sl")
23+
set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctestP.sl")
3324
set (LOCAL_BATCH_SCRIPT_COMMAND "sbatch")
3425
set (LOCAL_BATCH_TEST "TRUE")
3526
set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DLOCAL_BATCH_TEST:BOOL=ON")

release_docs/INSTALL_CMake.txt

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@ from the HDF5 source code package using the CMake tools. This procedure
6565
will use the default settings in the config/cmake/cacheinit.cmake file.
6666
The HDF Group recommends using the presets process to build HDF5.
6767

68-
NOTE: if you are using CMake 3.25 or later, you can use the presets process.
69-
The CMakePresets.json file in the source directory will configure, build, test,
70-
and package HDF5 with the same options that are set in the cacheinit.cmake file.
68+
NOTE: When using the presets process, the CMakePresets.json file in the source
69+
directory will configure, build, test, and package HDF5 with the same options
70+
that are set in the cacheinit.cmake file.
7171
In addition, it will get the optional files listed below that are needed, from
7272
the appropriate repositories.
7373
See Section X: Using CMakePresets.json for compiling
@@ -299,9 +299,7 @@ IV. Further Considerations
299299
========================================================================
300300

301301
1. We suggest you obtain the latest CMake from the Kitware
302-
web site. The HDF5 2."X"."Y" product requires a minimum CMake version 3.18.
303-
If you are using VS2022, the CMake minimum version is 3.21. CMakePresets
304-
requires CMake 3.25.
302+
web site. The HDF5 2."X"."Y" product requires a minimum CMake version 3.26.
305303

306304
2. If you plan to use Zlib or Szip (aka libaec):
307305
A. Download the binary packages and install them in a central location.
@@ -766,7 +764,7 @@ These five steps are described in detail below.
766764
12. Parallel versus serial library
767765
The HDF5 library can be configured to use MPI and MPI-IO for
768766
parallelism on a distributed multi-processor system. Read the
769-
file INSTALL_parallel for detailed information.
767+
file README_HPC.md for detailed information.
770768
HDF5_ENABLE_PARALLEL:BOOL=ON
771769

772770
The threadsafe, C++ and Java interfaces are not compatible

0 commit comments

Comments
 (0)