removed references and content to knights landing and cray xc40

Author: brtnfld

bin/batch/knl_ctestP.sl.in.cmake

@@ -264,15 +264,6 @@ set (ENV{CI_MODEL} ${MODEL})
     file (APPEND ${CTEST_SCRIPT_DIRECTORY}/FailedCTest.txt "Failed Configure: ${res}\n")
   endif ()
 
-  # On Cray XC40, configuring fails in the Fortran section when using the craype-mic-knl module.
-  # When the configure phase is done with the craype-haswell module and the build phase is done
-  # with the craype-mic-knl module, configure succeeds and tests pass on the knl compute nodes
-  # for Intel, Cray, GCC and Clang compilers.  If the variables aren't set or if not
-  # cross compiling, the module switch will not occur.
-  if (CMAKE_CROSSCOMPILING AND COMPILENODE_HWCOMPILE_MODULE AND COMPUTENODE_HWCOMPILE_MODULE)
-      execute_process (COMMAND module switch ${COMPILENODE_HWCOMPILE_MODULE} ${COMPUTENODE_HWCOMPILE_MODULE})
-  endif ()
-
   ctest_build (BUILD "${CTEST_BINARY_DIRECTORY}" APPEND RETURN_VALUE res NUMBER_ERRORS errval)
   if (LOCAL_SUBMIT)
     ctest_submit (PARTS Build)

bin/batch/knl_ctestS.sl.in.cmake

@@ -21,11 +21,6 @@ endif()
 ### options to run test scripts in batch commands
 set (LOCAL_BATCH_SCRIPT_NAME "ctest.qsub")
 set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctest.qsub")
-if (DEFINED KNL)
-  ### some additions and alternatives to cross compile on haswell for knl
-  set (COMPUTENODE_HWCOMPILE_MODULE "craype-mic-knl")
-  set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCMAKE_TOOLCHAIN_FILE:STRING=config/toolchain/crayle.cmake")
-endif ()
 set (LOCAL_BATCH_SCRIPT_COMMAND "qsub")
 set (LOCAL_BATCH_TEST "TRUE")
 set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DLOCAL_BATCH_TEST:BOOL=ON")

config/cmake/scripts/CTestScript.cmake

@@ -19,17 +19,8 @@ if (DEFINED MPI)
 endif()
 #############################################################################################
 ### options to run test scripts in batch commands
-if (DEFINED KNL)
-  ### some additions and alternatives to cross compile on haswell for knl
-  set (COMPILENODE_HWCOMPILE_MODULE "craype-haswell")
-  set (COMPUTENODE_HWCOMPILE_MODULE "craype-mic-knl")
-  set (LOCAL_BATCH_SCRIPT_NAME "knl_ctestS.sl")
-  set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "knl_ctestP.sl")
-  set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DCMAKE_TOOLCHAIN_FILE:STRING=config/toolchain/crayle.cmake")
-else ()
-  set (LOCAL_BATCH_SCRIPT_NAME "ctestS.sl")
-  set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctestP.sl")
-endif ()
+set (LOCAL_BATCH_SCRIPT_NAME "ctestS.sl")
+set (LOCAL_BATCH_SCRIPT_PARALLEL_NAME "ctestP.sl")
 set (LOCAL_BATCH_SCRIPT_COMMAND "sbatch")
 set (LOCAL_BATCH_TEST "TRUE")
 set (ADD_BUILD_OPTIONS "${ADD_BUILD_OPTIONS} -DLOCAL_BATCH_TEST:BOOL=ON")

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

@@ -44,9 +44,7 @@ When building on HPC systems:
    - CMake version 3.26 or greater
    - MPI implementation module
 
-3. **Unload problematic modules** (e.g., `craype-hugepages2M` on Cray systems)
-
-4. **For Cray systems,** set compiler environment variables AFTER loading modules:
+3. **For Cray and other systems with recommend compiler wrappers,** set compiler environment variables AFTER loading modules:
 
    ```bash
    export CC=cc
@@ -202,7 +200,6 @@ Add after `HDF5config.cmake,` separated by commas:
 | `HPC=bsub` | Use LSF batch system |
 | `HPC=raybsub` | Use Ray LSF variant |
 | `MPI=true` | Enable parallel (disables C++, Java, threadsafe) |
-| `KNL=true` | Cross-compile for KNL compute nodes (Cray XC40) |
 | `LOCAL_BATCH_SCRIPT_ARGS="--account=<acct>"` | Supply batch job account information |
 
 #### Examples
@@ -214,13 +211,6 @@ ctest -S HDF5config.cmake,HPC=sbatch,MPI=true \
       -C Release -V -O hdf5.log
 ```
 
-**Knight's Landing nodes on Cray XC40:**
-
-```bash
-ctest -S HDF5config.cmake,HPC=sbatch,MPI=true,KNL=true \
-      -C Release -V -O hdf5.log
-```
-
 Use `-VV` instead of `-V` for more detailed logging.
 
 ---
@@ -287,66 +277,26 @@ cmake --install . --prefix /install/path
 
 ### 6.1. Overview
 
-Cross-compiling is necessary when the login node architecture differs from
-compute node architecture (e.g., compiling on Haswell nodes for KNL nodes).
-
-### 6.2. Cross-Compiling for KNL on Cray XC40
-
-To cross-compile for Knight's Landing nodes, add `KNL=true` to ctest command:
-
-```bash
-ctest -S HDF5config.cmake,HPC=sbatch,MPI=true,KNL=true \
-      -C Release -V -O hdf5.log
-```
-
-This sets the following from `config/cmake/scripts/HPC/sbatch-HDF5options.cmake`:
-
-| Variable | Value |
-|----------|-------|
-| `COMPILENODE_HWCOMPILE_MODULE` | `craype-haswell` |
-| `COMPUTENODE_HWCOMPILE_MODULE` | `craype-mic-knl` |
-| `LOCAL_BATCH_SCRIPT_NAME` | `knl_ctestS.sl` |
-| `LOCAL_BATCH_SCRIPT_PARALLEL_NAME` | `knl_ctestP.sl` |
-| `CMAKE_TOOLCHAIN_FILE` | `config/toolchain/crayle.cmake` |
+Cross-compiling is the process of building software on one system architecture (like a login node) to be run on a different architecture (like a compute node). This section provides a historical overview of how this was done on systems that are no longer in service.
 
-CMake loads `craype-haswell` for configuration, then swaps to `craype-mic-knl`
-before compilation.
+### 6.2. Historical Example: Knights Landing (KNL) on Cray XC40
 
-### 6.3. Manual Cross-Compile
+A common historical use case was compiling for Intel Knights Landing (KNL) nodes on Cray XC40 systems, such as the retired Mutrino and Cori machines. These supercomputers had login nodes with a standard CPU architecture (e.g., Haswell) but used the different KNL architecture for their compute nodes.
 
-For manual cross-compiling on Cray XC40:
+To build software for KNL, a "module swapping" technique was required. The build process involved:
+1. Loading the compiler module for the login node architecture (e.g., `craype-haswell`) to configure the project.
 
-1. Load `craype-haswell` module
-
-2. Run cmake configure command (see section 5.2), adding:
-   ```bash
-   -DCMAKE_TOOLCHAIN_FILE:STRING=config/toolchain/crayle.cmake \
-   -DLOCAL_BATCH_SCRIPT_NAME:STRING=knl_ctestS.sl \
-   -DLOCAL_BATCH_SCRIPT_PARALLEL_NAME:STRING=knl_ctestP.sl
-   ```
+2. Switching to the compiler module for the compute node architecture (e.g., `craype-mic-knl`) before starting the actual compilation.
 
-3. Switch to `craype-mic-knl` module:
-   ```bash
-   module swap craype-haswell craype-mic-knl
-   ```
-
-4. Build:
-   ```bash
-   cmake --build . --config Release
-   ```
+This process was managed by special CMake toolchain files and custom batch scripts, which were often automated within the `ctest` framework.
 
-### 6.4. Machine-Specific Batch Scripts
+### 6.3. Cross-Compilation on Current Systems
 
-Batch script arguments for KNL may differ between systems:
+The specific hardware (Cray XC40, KNL) and the build procedures described above are historical and no longer in use.
 
-| System | SBATCH Arguments |
-|--------|------------------|
-| Mutrino | `#SBATCH -p knl -C quad,cache` |
-| Cori | `#SBATCH -C knl,quad,cache` |
+While cross-compilation is less common on many modern, homogeneous HPC clusters, it is still a necessary technique for advanced architectures, such as systems with different processor types or accelerators (e.g., GPUs).
 
-Edit batch scripts in `hdf5-<version>/bin/batch/` or modify
-`LOCAL_BATCH_SCRIPT_NAME` and `LOCAL_BATCH_SCRIPT_PARALLEL_NAME` in
-`config/cmake/scripts/HPC/sbatch-HDF5options.cmake` accordingly.
+**If you need assistance with cross-compiling for a current HPC system, please contact the facility administrators or The HDF Group (Section 1.3).**
 
 ---
 
@@ -405,8 +355,8 @@ Default is 1200 seconds (20 minutes). Modify in CMake with:
 **For SLURM systems:**
 
 ```bash
-sbatch -p knl -C quad,cache build/bin/batch/ctestS.sl    # Serial tests
-sbatch -p knl -C quad,cache build/bin/batch/ctestP.sl    # Parallel tests
+sbatch -C quad,cache build/bin/batch/ctestS.sl    # Serial tests
+sbatch -C quad,cache build/bin/batch/ctestP.sl    # Parallel tests
 ```
 
 **For LSF systems:**
@@ -447,7 +397,7 @@ This is available on Linux kernels 2.4 and greater.
 ### 8.2. Cray Systems
 
 - Use `CC=cc`, `FC=ftn`, `CXX=CC` after loading compiler modules
-- Unload `craype-hugepages2M` if loaded
+- Unload `craype-hugepages2M` if loaded (**Note**: This is situational advice and is not a universal rule, but it may be a valid troubleshooting step if you encounter memory-related performance issues or allocation errors.)
 - Disable shared libraries if encountering linking issues:
   ```bash
   -DBUILD_SHARED_LIBS=OFF