Cleanout the old installation script for the CUDA toolkit, as it is replaced (and would install in an outdated prefix)

Author: Caspar van Leeuwen

scripts/gpu_support/nvidia/install_cuda_host_injections.sh

@@ -1,211 +1,4 @@
 #!/usr/bin/env bash
 
-# This script can be used to install CUDA under the `.../host_injections` directory.
-# This provides the parts of the CUDA installation that cannot be redistributed as
-# part of EESSI due to license limitations. While GPU-based software from EESSI will
-# _run_ without these, installation of additional CUDA software requires the CUDA
-# installation(s) under `host_injections` to be present.
-#
-# The `host_injections` directory is a variant symlink that by default points to
-# `/opt/eessi`, unless otherwise defined in the local CVMFS configuration (see
-# https://cvmfs.readthedocs.io/en/stable/cpt-repo.html#variant-symlinks). For the
-# installation to be successful, this directory needs to be writeable by the user
-# executing this script.
-
-# Initialise our bash functions
 TOPDIR=$(dirname $(realpath $BASH_SOURCE))
-source "$TOPDIR"/../../utils.sh
-
-# Function to display help message
-show_help() {
-    echo "Usage: $0 [OPTIONS]"
-    echo "Options:"
-    echo "  --help                           Display this help message"
-    echo "  --accept-cuda-eula               You _must_ accept the CUDA EULA to install"
-    echo "                                   CUDA, see the EULA at"
-    echo "                                   https://docs.nvidia.com/cuda/eula/index.html"
-    echo "  -c, --cuda-version CUDA_VERSION  Specify a version o CUDA to install (must"
-    echo "                                   have a corresponding easyconfig in the"
-    echo "                                   EasyBuild release)"
-    echo "  -t, --temp-dir /path/to/tmpdir   Specify a location to use for temporary"
-    echo "                                   storage during the CUDA install"
-    echo "                                   (must have >10GB available)"
-}
-
-# Initialize variables
-install_cuda_version=""
-eula_accepted=0
-
-# Parse command-line options
-while [[ $# -gt 0 ]]; do
-    case "$1" in
-        --help)
-            show_help
-            exit 0
-            ;;
-        -c|--cuda-version)
-            if [ -n "$2" ]; then
-                install_cuda_version="$2"
-                shift 2
-            else
-                echo "Error: Argument required for $1"
-                show_help
-                exit 1
-            fi
-            ;;
-        --accept-cuda-eula)
-            eula_accepted=1
-            shift 1
-            ;;
-        -t|--temp-dir)
-            if [ -n "$2" ]; then
-                CUDA_TEMP_DIR="$2"
-                shift 2
-            else
-                echo "Error: Argument required for $1"
-                show_help
-                exit 1
-            fi
-            ;;
-        *)
-            show_help
-            fatal_error "Error: Unknown option: $1"
-            ;;
-    esac
-done
-
-# Make sure EESSI is initialised
-check_eessi_initialised
-
-# Make sure the CUDA version supplied is a semantic version
-is_semantic_version() {
-    local version=$1
-    local regex='^[0-9]+\.[0-9]+\.[0-9]+$'
-
-    if [[ $version =~ $regex ]]; then
-        return 0  # Return success (0) if it's a semantic version
-    else
-        return 1  # Return failure (1) if it's not a semantic version
-    fi
-}
-if ! is_semantic_version "$install_cuda_version"; then
-  show_help
-  error="\nYou must provide a semantic version for CUDA (e.g., 12.1.1) via the appropriate\n"
-  error="${error}command line option. This script is intended for use with EESSI so the 'correct'\n"
-  error="${error}version to provide is probably one of those available under\n"
-  error="${error}$EESSI_SOFTWARE_PATH/software/CUDA\n"
-  fatal_error "${error}"
-fi
-
-# Make sure they have accepted the CUDA EULA
-if [ "$eula_accepted" -ne 1 ]; then
-  show_help
-  error="\nYou _must_ accept the CUDA EULA via the appropriate command line option.\n"
-  fatal_error "${error}"
-fi
-
-# As an installation location just use $EESSI_SOFTWARE_PATH but replacing `versions` with `host_injections`
-# (CUDA is a binary installation so no need to worry too much about the EasyBuild setup)
-cuda_install_parent=${EESSI_SOFTWARE_PATH/versions/host_injections}
-
-# Only install CUDA if specified version is not found.
-# (existence of easybuild subdir implies a successful install)
-if [ -d "${cuda_install_parent}"/software/CUDA/"${install_cuda_version}"/easybuild ]; then
-  echo_green "CUDA software found! No need to install CUDA again."
-else
-  # We need to be able write to the installation space so let's make sure we can
-  if ! create_directory_structure "${cuda_install_parent}"/software/CUDA ; then
-    fatal_error "No write permissions to directory ${cuda_install_parent}/software/CUDA"
-  fi
-
-  # we need a directory we can use for temporary storage
-  if [[ -z "${CUDA_TEMP_DIR}" ]]; then
-    tmpdir=$(mktemp -d)
-  else
-    tmpdir="${CUDA_TEMP_DIR}"/temp
-    if ! mkdir -p "$tmpdir" ; then
-      fatal_error "Could not create directory ${tmpdir}"
-    fi
-  fi
-
-  required_space_in_tmpdir=50000
-  # Let's see if we have sources and build locations defined if not, we use the temporary space
-  if [[ -z "${EASYBUILD_BUILDPATH}" ]]; then
-    export EASYBUILD_BUILDPATH=${tmpdir}/build
-    required_space_in_tmpdir=$((required_space_in_tmpdir + 5000000))
-  fi
-  if [[ -z "${EASYBUILD_SOURCEPATH}" ]]; then
-    export EASYBUILD_SOURCEPATH=${tmpdir}/sources
-    required_space_in_tmpdir=$((required_space_in_tmpdir + 5000000))
-  fi
-
-  # The install is pretty fat, you need lots of space for download/unpack/install (~3*5GB),
-  # need to do a space check before we proceed
-  avail_space=$(df --output=avail "${cuda_install_parent}"/ | tail -n 1 | awk '{print $1}')
-  if (( avail_space < 5000000 )); then
-    fatal_error "Need at least 5GB disk space to install CUDA under ${cuda_install_parent}, exiting now..."
-  fi
-  avail_space=$(df --output=avail "${tmpdir}"/ | tail -n 1 | awk '{print $1}')
-  if (( avail_space < required_space_in_tmpdir )); then
-    error="Need at least ${required_space_in_tmpdir}GB disk space under ${tmpdir}.\n"
-    error="${error}Set the environment variable CUDA_TEMP_DIR to a location with adequate space to pass this check.\n"
-    error="${error}You can alternatively set EASYBUILD_BUILDPATH and/or EASYBUILD_SOURCEPATH\n"
-    error="${error}to reduce this requirement. Exiting now..."
-    fatal_error "${error}"
-  fi
-
-  if ! command -v "eb" &>/dev/null; then
-    echo_yellow "Attempting to load an EasyBuild module to do actual install"
-    module load EasyBuild
-    # There are some scenarios where this may fail
-    if [ $? -ne 0 ]; then
-      error="'eb' command not found in your environment and\n"
-      error="${error}  module load EasyBuild\n"
-      error="${error}failed for some reason.\n"
-      error="${error}Please re-run this script with the 'eb' command available."
-      fatal_error "${error}"
-    fi
-  fi
-
-  cuda_easyconfig="CUDA-${install_cuda_version}.eb"
-
-  # Check the easyconfig file is available in the release
-  # (eb search always returns 0, so we need a grep to ensure a usable exit code)
-  eb --search ^${cuda_easyconfig}|grep CUDA > /dev/null 2>&1
-  # Check the exit code
-  if [ $? -ne 0 ]; then
-    eb_version=$(eb --version)
-    available_cuda_easyconfigs=$(eb --search "^CUDA-.*.eb"|grep CUDA)
-
-    error="The easyconfig ${cuda_easyconfig} was not found in EasyBuild version:\n"
-    error="${error}  ${eb_version}\n"
-    error="${error}You either need to give a different version of CUDA to install _or_ \n"
-    error="${error}use a different version of EasyBuild for the installation.\n"
-    error="${error}\nThe versions of CUDA available with the current eb command are:\n"
-    error="${error}${available_cuda_easyconfigs}"
-    fatal_error "${error}"
-  fi
-
-  # We need the --rebuild option, as the CUDA module may or may not be on the
-  # `MODULEPATH` yet. Even if it is, we still want to redo this installation
-  # since it will provide the symlinked targets for the parts of the CUDA
-  # installation in the `.../versions/...` prefix
-  # We install the module in our `tmpdir` since we do not need the modulefile,
-  # we only care about providing the targets for the symlinks.
-  extra_args="--rebuild --installpath-modules=${tmpdir}"
-
-  # We don't want hooks used in this install, we need a vanilla CUDA installation
-  touch "$tmpdir"/none.py
-  # shellcheck disable=SC2086  # Intended splitting of extra_args
-  eb --prefix="$tmpdir" ${extra_args} --accept-eula-for=CUDA --hooks="$tmpdir"/none.py --installpath="${cuda_install_parent}"/ "${cuda_easyconfig}"
-  ret=$?
-  if [ $ret -ne 0 ]; then
-    eb_last_log=$(unset EB_VERBOSE; eb --last-log)
-    cp -a ${eb_last_log} .
-    fatal_error "CUDA installation failed, please check EasyBuild logs $(basename ${eb_last_log})..."
-  else
-    echo_green "CUDA installation at ${cuda_install_parent}/software/CUDA/${install_cuda_version} succeeded!"
-  fi
-  # clean up tmpdir
-  rm -rf "${tmpdir}"
-fi
+echo "This script was replaced by the $TOPDIR/install_cuda_and_libraries.sh script. See https://www.eessi.io/docs/site_specific_config/gpu/ for more information"