hpccm.building_blocks

amgx — The amgx building block downloads, configures, builds, and installs the AMGX component.

arm_allinea_studio — The arm_allinea_studio building block downloads and installs the Arm Allinea Studio.

boost — The boost building block downloads and installs the Boost component.

catalyst — The catalyst building block configures, builds, and installs the ParaView Catalyst component.

cgns — The cgns building block downloads and installs the CGNS component.

charm — The charm building block downloads and install the Charm++ component.

cmake — The cmake building block downloads and installs the CMake component.

conda — The conda building block installs Anaconda.

doca_ofed — The doca_ofed building block downloads and installs the NVIDIA DOCA Software Framework.

fftw — The fftw building block downloads, configures, builds, and installs the FFTW component. Depending on the parameters, the source will be downloaded from the web (default) or copied from a source directory in the local build context.

gdrcopy — The gdrcopy building block builds and installs the user space library from the gdrcopy component.

generic_autotools — The generic_autotools building block downloads, configures, builds, and installs a specified GNU Autotools enabled package.

generic_build — The generic_build building block downloads and builds a specified package.

generic_cmake — The generic_cmake building block downloads, configures, builds, and installs a specified CMake enabled package.

gnu — The gnu building block installs the GNU compilers from the upstream Linux distribution.

hdf5 — The hdf5 building block downloads, configures, builds, and installs the HDF5 component. Depending on the parameters, the source will be downloaded from the web (default) or copied from a source directory in the local build context.

hpcx — The hpcx building block downloads and installs the Mellanox HPC-X component.

intel_mpi — The intel_mpi building block downloads and installs the Intel MPI Library.

intel_psxe — The intel_psxe building block installs Intel Parallel Studio XE.

intel_psxe_runtime — The intel_mpi building block downloads and installs the Intel Parallel Studio XE runtime.

julia — The julia building block downloads and installs the Julia programming environment.

knem — The knem building block install the headers from the KNEM component.

kokkos — The kokkos building block downloads and installs the Kokkos component.

libsim — The libsim building block configures, builds, and installs the VisIt Libsim component.

llvm — The llvm building block installs the LLVM compilers (clang and clang++) from the upstream Linux distribution.

magma — The magma building block configures, builds, and installs the MAGMA component.

mkl — The mkl building block downloads and installs the Intel Math Kernel Library.

mlnx_ofed — The mlnx_ofed building block downloads and installs the Mellanox OpenFabrics Enterprise Distribution for Linux.

mpich — The mpich building block configures, builds, and installs the MPICH component.

multi_ofed — The multi_ofed building block downloads and installs multiple versions of the OpenFabrics Enterprise Distribution (OFED). Please refer to the mlnx_ofed and ofed building blocks for more information.

mvapich2_gdr — The mvapich2_gdr building blocks installs the MVAPICH2-GDR component. Depending on the parameters, the package will be downloaded from the web (default) or copied from the local build context.

mvapich2 — The mvapich2 building block configures, builds, and installs the MVAPICH2 component. Depending on the parameters, the source will be downloaded from the web (default) or copied from a source directory in the local build context.

nccl — The nccl building block installs the NCCL component.

netcdf — The netcdf building block downloads, configures, builds, and installs the NetCDF component.

nsight_compute — The nsight_compute building block downloads and installs the [NVIDIA Nsight Compute profiler]](https://developer.nvidia.com/nsight-compute).

nsight_systems — The nsight_systems building block downloads and installs the [NVIDIA Nsight Systems profiler]](https://developer.nvidia.com/nsight-systems).

nvhpc — The nvhpc building block downloads and installs the NVIDIA HPC SDK. By default, the NVIDIA HPC SDK is installed from a package repository. Alternatively the tar package can be downloaded by specifying the tarball parameter, or a local tar package may used instead by specifying the package parameter.

nvshmem — The nvshmem building block builds and installs the NVSHMEM component. CMake version 3.19 or later is required and must be installed separately.

ofed — The ofed building block installs the OpenFabrics Enterprise Distribution packages that are part of the Linux distribution.

openblas — The openblas building block builds and installs the OpenBLAS component.

openmpi — The openmpi building block configures, builds, and installs the OpenMPI component.

packages — The packages building block specifies the set of operating system packages to install. Based on the Linux distribution, the building block invokes either apt-get (Ubuntu) or yum (RHEL-based).

pgi — The pgi building block installs the PGI compiler from a manually downloaded package.

pip — The pip building block installs Python packages from PyPi.

pmix — The pmix building block configures, builds, and installs the PMIX component.

pnetcdf — The pnetcdf building block downloads, configures, builds, and installs the PnetCDF component.

python — The python building block installs Python from the upstream Linux distribution.

rdma_core — The rdma_core building block configures, builds, and installs the RDMA Core component.

scif — The scif building blocks installs components using the Scientific Filesystem (SCI-F).

sensei — The sensei building block configures, builds, and installs the SENSEI component.

slurm_pmi2 — The slurm_pmi2 building block configures, builds, and installs the PMI2 component from SLURM.

ucx — The ucx building block configures, builds, and installs the UCX component.

xpmem — The xpmem building block builds and installs the user space library from the XPMEM component.

yum — The yum building block specifies the set of operating system packages to install. This building block should only be used on images that use the Red Hat package manager (e.g., CentOS).

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

branch — The git branch to clone. AMGX releases are tagged, that is, specifying branch='v2.1.0' downloads a particular AMGX version. The default is master.

cmake_opts — List of options to pass to cmake. The default value is an empty list. See the "Building" section of the AMGX documentation of the specified library version for more details. Some options are CMAKE_NO_MPI:Boolean (default=False) - build without MPI support even if the FindMPI script finds an MPI library. AMGX_NO_RPATH:Boolean (default=False) - by default CMake adds -rpath flags to binaries, this option disables that. MKL_ROOT_DIR:String, MAGMA_ROOT_DIR:String - MAGMA/MKL are used to accelerate some of the Eigensolvers. These solvers will return "error 'not supported'" if AMGX was not build with MKL/MAGMA support.

commit — The git commit to clone. The default is empty and uses the latest commit on the selected branch of the repository.

directory — Build from an unpackaged source directory relative to the local build context instead of fetching AMGX sources from a git repository. This option is incompatible with repository/branch/ commit. The default is None.

ospackages — List of OS packages to install prior to downloading, configuring, and building. The default value is [git].

prefix — The top level install location. The default is /usr/local/amgx.

repository — The git repository to clone. The default is https://github.com/NVIDIA/AMGX.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

environment — Boolean flag to specify whether the environment (MODULEPATH) should be modified to include Arm Allinea Studio. The default is True.

eula — By setting this value to True, you agree to the Arm End User License Agreement. The default value is False.

microarchitectures — List of microarchitectures to install. From 22.0 version, only generic is available. Available values are generic, generic-sve for version 21.1, and neoverse-n1, thunderx2t99 are valid for versions <= 20.3. Irrespective of this setting, the generic implementation will always be installed.

ospackages — List of OS packages to install prior to installing Arm Allinea Studio. For Ubuntu, the default values are libc6-dev, lmod, python, tar, tcl, and wget. For RHEL-based Linux distributions, the default values are glibc-devel, Lmod, tar, and wget.

prefix — The top level install prefix. The default value is /opt/arm.

tarball — Path to the Arm Allinea Studio tarball relative to the local build context. The default value is empty. If this is defined, the tarball in the local build context will be used rather than downloading the tarball from the web.

version — The version of Arm Allinea Studio to install. The default value is 22.0. Due to differences in the packaging scheme, versions prior to 20.2 are not supported.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

b2_opts — List of options to pass to b2. The default is an empty list.

bootstrap_opts — List of options to pass to bootstrap.sh. The default is an empty list.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH) should be modified to include Boost. The default is True.

ldconfig — Boolean flag to specify whether the Boost library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the Boost library directory. The default value is False.

ospackages — List of OS packages to install prior to building. For Ubuntu, the default values are bzip2, libbz2-dev, tar, wget, and zlib1g-dev. For RHEL-based Linux distributions the default values are bzip2, bzip2-devel, tar, wget, which, and zlib-devel.

prefix — The top level installation location. The default value is /usr/local/boost.

python — Boolean flag to specify whether Boost should be built with Python support. If enabled, the Python C headers need to be installed (typically this can be done by adding python-dev or python-devel to the list of OS packages). This flag is ignored if bootstrap_opts is set. The default is False.

sourceforge — Boolean flag to specify whether Boost should be downloaded from SourceForge rather than the current Boost repository. For versions of Boost older than 1.63.0, the SourceForge repository should be used. The default is False.

version — The version of Boost source to download. The default value is 1.87.0.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

cmake_opts — List of options to pass to cmake. The default is an empty list.

edition — The Catalyst edition to use. Valid choices are Base, Base-Essentials, Base-Essentials-Extras, Base-Essentials-Extras-Rendering-Base, Base-Enable-Python, Base-Enable-Python-Essentials, Base-Enable-Python-Essentials-Extras, and Base-Enable-Python-Essentials-Extras-Rendering-Base. If a Python edition is selected, then the Python building block should be installed with development libraries prior to this building block. The default value is Base-Enable-Python-Essentials-Extras-Rendering-Base.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include ParaView Catalyst. The default is True.

ldconfig — Boolean flag to specify whether the Catalyst library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the Catalyst library directory. The default value is False.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are git, gzip, make, tar, and wget. If a rendering edition is selected then libxau-dev, libxext-dev, libxt-dev, libice-dev, libsm-dev, libx11-dev, libgl1-mesa-dev are also included. For RHEL-based Linux distributions, the default values are git, gzip, make, tar, wget, and which. If a rendering edition is selected then libX11-devel, libXau-devel, libXext-devel, libXt-devel, libICE-devel, libSM-devel, libglvnd-devel, mesa-libGL-devel are also included.

prefix — The top level install location. The default value is /usr/local/catalyst.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of Catalyst source to download. The default value is 5.6.1.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the test cases should be run. The default is False.

configure_opts — List of options to pass to configure. The default value is --with-hdf5=/usr/local/hdf5 and --with-zlib.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

prefix — The top level install location. The default value is /usr/local/cgns.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are file, make, wget, and zlib1g-dev. For RHEL-based Linux distributions the default values are bzip2, file, make, wget and zlib-devel.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of CGNS source to download. The default value is 4.1.2.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

basedir — List of additional include and library paths for building Charm++. The default is an empty list.

check — Boolean flag to specify whether the test cases should be run. The default is False.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH, PATH, and other variables) should be modified to include Charm++. The default is True.

ldconfig — Boolean flag to specify whether the Charm++ library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the Charm++ library directory. The default value is False.

options — List of additional options to use when building Charm++. The default values are --build-shared, and --with-production.

ospackages — List of OS packages to install prior to configuring and building. The default values are autoconf, automake, git, libtool, make, and wget.

prefix — The top level install prefix. The default value is /usr/local.

target — The target Charm++ framework to build. The default value is charm++.

target_architecture — The target machine architecture to build. For x86_64 processors, the default value is multicore-linux-x86_64. For aarch64 processors, the default value is multicore-arm8.

version — The version of Charm++ to download. The default value is 6.10.2.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

bootstrap_opts — List of options to pass to bootstrap when building from source. The default is an empty list.

eula — By setting this value to True, you agree to the CMake End-User License Agreement. The default value is False.

ospackages — List of OS packages to install prior to installing. The default values are make and wget.

prefix — The top level install location. The default value is /usr/local.

source — Boolean flag to specify whether to build CMake from source. If True, includes the libssl-dev package in the list of OS packages for Ubuntu, and openssl-devel for RHEL-based distributions. For x86_64 and aarch64 processors, the default is False, i.e., use the available pre-compiled package. For all other processors, the default is True.

version — The version of CMake to download. The default value is 3.25.1.

channels — List of additional Conda channels to enable. The default is an empty list.

environment — Path to the Conda environment file to clone. The default value is empty.

eula — By setting this value to True, you agree to the Anaconda End User License Agreement. The default value is False.

ospackages — List of OS packages to install prior to installing Conda. The default values are ca-certificates and wget.

packages — List of Conda packages to install. The default is an empty list.

prefix — The top level install location. The default value is /usr/local/anaconda.

python2 — Boolean flag to specify that the Python 2 version of Anaconda should be installed. The default is False.

python_subversion — The Python version to install. This value is ignored if the Conda version is less than 4.8. The default is py312 if using Python 3, and py27 if using Python 2.

version — The version of Anaconda to download. The default value is 25.1.1-2 if using Python 3, and 4.8.3 if using Python 2.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

archlabel — The CPU architecture label assigned by Mellanox to the package repository. The default value is x86_64 for x86_64 processors and arm64-sbsa for aarch64 processors.

oslabel — The Linux distribution label assigned by Mellanox to the package repository. For Ubuntu, the default value is ubuntuXX.04 where XX is derived from the base image. For RHEL-base Linux distributions, the default value is rhelX.

ospackages — List of OS packages to install prior to installing DOCA OFED. The default values are ca-certificates, gnupg, and wget.

packages — List of packages to install from DOCA. For Ubuntu, the default values are ibverbs-providers, ibverbs-utils libibmad-dev, libibmad5, libibumad3, libibumad-dev, libibverbs-dev libibverbs1, librdmacm-dev, and librdmacm1. For RHEL-based Linux distributions, the default values are libibumad, libibverbs, libibverbs-utils, librdmacm, rdma-core, and rdma-core-devel.

version — The version of DOCA OFED to download. The default value is 3.3.0.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

configure_opts — List of options to pass to configure. For x86_64 processors, the default values are --enable-shared, --enable-openmp, --enable-threads, and --enable-sse2. For other processors, the default values are --enable-shared, --enable-openmp, and --enable-threads.

directory — Path to the unpackaged source directory relative to the local build context. The default value is empty. If this is defined, the source in the local build context will be used rather than downloading the source from the web.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH) should be modified to include FFTW. The default is True.

ldconfig — Boolean flag to specify whether the FFTW library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the FFTW library directory. The default value is False.

mpi — Boolean flag to specify whether to build with MPI support enabled. The default is False.

ospackages — List of OS packages to install prior to configuring and building. The default values are file, make, and wget.

prefix — The top level install location. The default value is /usr/local/fftw.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of FFTW source to download. This value is ignored if directory is set. The default value is 3.3.10.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

environment — Boolean flag to specify whether the environment (CPATH, LIBRARY_PATH, and LD_LIBRARY_PATH) should be modified to include the gdrcopy. The default is True.

ldconfig — Boolean flag to specify whether the gdrcopy library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the gdrcopy library directory. The default value is False.

ospackages — List of OS packages to install prior to building. The default values are make and wget.

prefix — The top level install location. The default value is /usr/local/gdrcopy.

targets — List of make targets to build. The default values are lib and lib_install.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of gdrcopy source to download. The default value is 2.4.4.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

annotations — Dictionary of additional annotations to include. The default is an empty dictionary.

branch — The git branch to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the default branch for the repository.

build_directory — The location to build the package. The default value is the source code location.

build_environment — Dictionary of environment variables and values to set when building the package. The default is an empty dictionary.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

commit — The git commit to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the latest commit on the default branch for the repository.

configure_opts — List of options to pass to configure. The default value is an empty list.

devel_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the development stage after the package is built and installed. The default is an empty dictionary.

directory — The source code location. The default value is the basename of the downloaded package. If the value is not an absolute path, then the temporary working directory is prepended.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment should be modified (see devel_environment and runtime_environment). The default is True.

export_build_environment — Boolean flag to specify whether the build environment should be exported, or merely set on the configure command line. The default is False.

install — Boolean flag to specify whether the make install step should be performed. The default is True.

ldconfig — Boolean flag to specify whether the library directory should be added dynamic linker cache. The default value is False.

libdir — The path relative to the install prefix to use when configuring the dynamic linker cache. The default value is lib.

make — Boolean flag to specify whether the make step should be performed. The default is True.

package — Path to the local source package relative to the local build context. One of this parameter or the repository or url parameters must be specified.

postinstall — List of shell commands to run after running 'make install'. The working directory is the install prefix. The default is an empty list.

preconfigure — List of shell commands to run prior to running configure. The working directory is the source code location. The default is an empty list.

prefix — The top level install location. The default value is /usr/local. It is highly recommended not use use this default and instead set the prefix to a package specific directory.

recursive — Initialize and checkout git submodules. repository parameter must be specified. The default is False.

repository — The git repository of the package to build. One of this parameter or the package or url parameters must be specified.

_run_arguments — Specify additional Dockerfile RUN arguments (Docker specific).

runtime — The list of files / directories to copy into the runtime stage. The default is an empty list, i.e., copy the entire prefix.

runtime_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the runtime stage. The default is an empty dictionary.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

url — The URL of the package to build. One of this parameter or the package or repository parameters must be specified.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

annotations — Dictionary of additional annotations to include. The default is an empty dictionary.

build — List of shell commands to run in order to build the package. The working directory is the source directory. The default is an empty list.

branch — The git branch to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the default branch for the repository.

commit — The git commit to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the latest commit on the default branch for the repository.

devel_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the development stage after the package is built and installed. The default is an empty dictionary.

directory — The source code location. The default value is the basename of the downloaded package. If the value is not an absolute path, then the temporary working directory is prepended.

environment — Boolean flag to specify whether the environment should be modified (see devel_environment and runtime_environment). The default is True.

install — List of shell commands to run in order to install the package. The working directory is the source directory. If prefix is defined, it will be automatically created if the list is non-empty. The default is an empty list.

ldconfig — Boolean flag to specify whether the library directory should be added dynamic linker cache. The default value is False.

libdir — The path relative to the install prefix to use when configuring the dynamic linker cache. The default value is lib.

package — Path to the local source package relative to the local build context. One of this parameter or the repository or url parameters must be specified.

prefix — The top level install location. The default value is empty. If defined then the location is copied as part of the runtime method.

recursive — Initialize and checkout git submodules. repository parameter must be specified. The default is False.

repository — The git repository of the package to build. One of this parameter or the package or url parameters must be specified.

_run_arguments — Specify additional Dockerfile RUN arguments (Docker specific).

runtime — The list of files / directories to copy into the runtime stage. The default is an empty list, i.e., copy the entire prefix.

runtime_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the runtime stage. The default is an empty dictionary.

unpack — Unpack the sources after downloading. Default is True.

url — The URL of the package to build. One of this parameter or the package or repository or parameters must be specified.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

annotations — Dictionary of additional annotations to include. The default is an empty dictionary.

branch — The git branch to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the default branch for the repository.

build_directory — The location to build the package. The default value is a build subdirectory in the source code location.

build_environment — Dictionary of environment variables and values to set when building the package. The default is an empty dictionary.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

cmake_opts — List of options to pass to cmake. The default value is an empty list.

commit — The git commit to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the latest commit on the default branch for the repository.

devel_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the development stage after the package is built and installed. The default is an empty dictionary.

directory — The source code location. The default value is the basename of the downloaded package. If the value is not an absolute path, then the temporary working directory is prepended.

environment — Boolean flag to specify whether the environment should be modified (see devel_environment and runtime_environment). The default is True.

install — Boolean flag to specify whether the make install step should be performed. The default is True.

ldconfig — Boolean flag to specify whether the library directory should be added dynamic linker cache. The default value is False.

libdir — The path relative to the install prefix to use when configuring the dynamic linker cache. The default value is lib.

make — Boolean flag to specify whether the make step should be performed. The default is True.

package — Path to the local source package relative to the local build context. One of this parameter or the repository or url parameters must be specified.

postinstall — List of shell commands to run after running 'make install'. The working directory is the install prefix. The default is an empty list.

preconfigure — List of shell commands to run prior to running cmake. The working directory is the source code location. The default is an empty list.

prefix — The top level install location. The default value is /usr/local. It is highly recommended not to use this default and instead set the prefix to a package specific directory.

recursive — Initialize and checkout git submodules. repository parameter must be specified. The default is False.

repository — The git repository of the package to build. One of this parameter or the package or url parameters must be specified.

_run_arguments — Specify additional Dockerfile RUN arguments (Docker specific).

runtime — The list of files / directories to copy into the runtime stage. The default is an empty list, i.e., copy the entire prefix.

runtime_environment — Dictionary of environment variables and values, e.g., LD_LIBRARY_PATH and PATH, to set in the runtime stage. The default is an empty dictionary.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

url — The URL of the package to build. One of this parameter or the repository or package parameters must be specified.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

cc — Boolean flag to specify whether to install gcc. The default is True.

configure_opts — List of options to pass to configure. The default value is --disable-multilib. This option is only recognized if a source build is enabled.

cxx — Boolean flag to specify whether to install g++. The default is True.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include the GNU compiler. The default is True.

extra_repository — Boolean flag to specify whether to enable an extra package repository containing addition GNU compiler packages. For Ubuntu, setting this flag to True enables the ppa:ubuntu-toolchain-r/test repository. For RHEL-based Linux distributions, setting this flag to True enables the Software Collections (SCL) repository. The default is False.

fortran — Boolean flag to specify whether to install gfortran. The default is True.

ldconfig — Boolean flag to specify whether the GNU library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the GNU library directory. The default value is False. This option is only recognized if a source build is enabled.

openacc — Boolean flag to control whether a OpenACC enabled compiler is built. If True, adds --with-cuda-driver and --enable-offload-targets=nvptx-none to the list of host compiler configure options and also builds the accelerator compiler and dependencies (nvptx-tools and nvptx-newlib). The default value is False. This option is only recognized if a source build is enabled.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are bzip2, file, gcc, g++, git, make, perl, tar, wget, and xz-utils. For RHEL-based Linux distributions, the default values are bzip2, file, gcc, gcc-c++, git, make, perl, tar, wget, and xz. This option is only recognized if a source build is enabled.

prefix — The top level install location. The default value is /usr/local/gnu. This option is only recognized if a source build is enabled.

source — Boolean flag to control whether to build the GNU compilers from source. The default value is False.

version — The version of the GNU compilers to install. Note that the version refers to the Linux distribution packaging, not the actual compiler version. For Ubuntu, the version is appended to the default package name, e.g., gcc-7. For RHEL-based Linux distributions, the version is inserted into the SCL Developer Toolset package name, e.g., devtoolset-7-gcc. For RHEL-based Linux distributions, specifying the version automatically sets extra_repository to True. If a source build is enabled, the version is the compiler tarball version on the GNU FTP site and the version must be specified. The default is an empty value.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

configure_opts — List of options to pass to configure. The default values are --enable-cxx and --enable-fortran.

directory — Path to the unpackaged source directory relative to the local build context. The default value is empty. If this is defined, the source in the local build context will be used rather than downloading the source from the web.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment (CPATH, LD_LIBRARY_PATH, LIBRARY_PATH, PATH, and others) should be modified to include HDF5. The default is True.

ldconfig — Boolean flag to specify whether the HDF5 library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the HDF5 library directory. The default value is False.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are bzip2, file, make, wget, and zlib1g-dev. For RHEL-based Linux distributions the default values are bzip2, file, make, wget and zlib-devel.

prefix — The top level install location. The default value is /usr/local/hdf5.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of HDF5 source to download. This value is ignored if directory is set. The default value is 1.14.5.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

buildlabel — The build label assigned by Mellanox to the tarball. For version 2.24 and later, the default value is the value of cuda parameter. For versions 2.17 through 2.23, the default value is cuda12. For version 2.16 the default value is cuda12-gdrcopy2-nccl2.18. For version 2.15 the default value is cuda12-gdrcopy2-nccl2.17. For version 2.14 the default value is cuda11-gdrcopy2-nccl2.16. For versions 2.12 and 2.13 the default value is cuda11-gdrcopy2-nccl2.12. For versions 2.10 and 2.11 the default value is cuda11-gdrcopy2-nccl2.11. This value is ignored for HPC-X version version 2.9 and earlier.

cuda — The CUDA label assigned by Mellanox to the tarball. This parameter is only recognized for version 2.24 and later. The default value is cuda13.

environment — Boolean flag to specify whether the environment should be modified to include HPC-X. This option is only recognized if hpcxinit is False. The default is True.

hpcxinit — Mellanox HPC-X provides an environment script (hpcx-init.sh) to setup the HPC-X environment. If this value is True, the bashrc is modified to automatically source this environment script. However, HPC-X is not automatically available to subsequent container image build steps; the environment is available when the container image is run. To set the HPC-X environment in subsequent build steps you can explicitly call source /usr/local/hpcx/hpcx-init.sh && hpcx_load in each build step. If this value is set to False, then the environment is set such that the environment is visible to both subsequent container image build steps and when the container image is run. However, the environment may differ slightly from that set by hpcx-init.sh. The default value is True.

inbox — Boolean flag to specify whether to use Mellanox HPC-X built for Inbox OFED. If the value is True, use Inbox OFED. If the value is False, use Mellanox OFED. The default is False.

ldconfig — Boolean flag to specify whether the Mellanox HPC-X library directories should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the HPC-X library directories. This value is ignored if hpcxinit is True. The default value is False.

mlnx_ofed — The version of Mellanox OFED that should be matched. This value is ignored if Inbox OFED is selected, or for HPC-X 2.21 and later. The default value is 5 for HPC-X version 2.10 and later, and 5.2-2.2.0.0 for earlier HPC-X versions.

multi_thread — Boolean flag to specify whether the multi-threaded version of Mellanox HPC-X should be used. The default is False.

ofedlabel — The Mellanox OFED label assigned by Mellanox to the tarball. For version 2.21 and later, the default value is gcc-doca_ofed. For version 2.16 through 2.18, the default value is gcc-mlnx_ofed. For earlier versions, the default value is gcc-MLNX_OFED_LINUX-5. This value is ignored if inbox is True.

oslabel — The Linux distribution label assigned by Mellanox to the tarball. For Ubuntu, the default value is ubuntu16.04 for Ubuntu 16.04, ubuntu18.04 for Ubuntu 18.04, ubuntu20.04 for Ubuntu 20.04, ubuntu22.04 for Ubuntu 22.04, and ubuntu24.04 for Ubuntu 24.04. For HPC-X version 2.10 and later and RHEL-based Linux distributions, the default value is redhat7 for version 7, redhat8 for version 8, and redhat9 for version 9. For HPC-X version 2.9 and earlier and RHEL-based Linux distributions, the default value is redhat7.6 for version 7 and redhat8.0 for version 8.

ospackages — List of OS packages to install prior to installing Mellanox HPC-X. For Ubuntu, the default values are bzip2, libnuma1, openssh-client, tar, and wget. For RHEL-based distributions the default values are bzip2, numactl-libs, openssh-clients, tar, and wget.

prefix — The top level installation location. The default value is /usr/local/hpcx.

version — The version of Mellanox HPC-X to install. The default value is 2.24.1.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH, PATH, and others) should be modified to include Intel MPI. mpivars has precedence. The default is True.

eula — By setting this value to True, you agree to the Intel End User License Agreement. The default value is False.

mpivars — Intel MPI provides an environment script (mpivars.sh) to setup the Intel MPI environment. If this value is True, the bashrc is modified to automatically source this environment script. However, the Intel MPI environment is not automatically available to subsequent container image build steps; the environment is available when the container image is run. To set the Intel MPI environment in subsequent build steps you can explicitly call source /opt/intel/compilers_and_libraries/linux/mpi/intel64/bin/mpivars.sh intel64 in each build step. If this value is to set False, then the environment is set such that the environment is visible to both subsequent container image build steps and when the container image is run. However, the environment may differ slightly from that set by mpivars.sh. The default value is True.

ospackages — List of OS packages to install prior to installing Intel MPI. For Ubuntu, the default values are apt-transport-https, ca-certificates, gnupg, man-db, openssh-client, and wget. For RHEL-based Linux distributions, the default values are man-db and openssh-clients.

version — The version of Intel MPI to install. The default value is 2019.6-088.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

components — List of Intel Parallel Studio XE components to install. The default values is DEFAULTS. If only the Intel C++ and Fortran compilers are desired, then use intel-icc__x86_64 and intel-ifort__x86_64. Please note that the values are not consistent between versions; for a list of components, extract pset/mediaconfig.xml from the tarball and grep for Abbr.

daal — Boolean flag to specify whether the Intel Data Analytics Acceleration Library environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH, PATH, and others) should be modified to include Intel Parallel Studio XE. psxevars has precedence. The default is True.

eula — By setting this value to True, you agree to the Intel End User License Agreement. The default value is False.

icc — Boolean flag to specify whether the Intel C++ Compiler environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

ifort — Boolean flag to specify whether the Intel Fortran Compiler environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

ipp — Boolean flag to specify whether the Intel Integrated Performance Primitives environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

license — The license to use to activate Intel Parallel Studio XE. If the string contains a @ the license is interpreted as a network license, e.g., 12345@lic-server. Otherwise, the string is interpreted as the path to the license file relative to the local build context. The default value is empty. While this value is not required, the installation is unlikely to be successful without a valid license.

mkl — Boolean flag to specify whether the Intel Math Kernel Library environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

mpi — Boolean flag to specify whether the Intel MPI Library environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

ospackages — List of OS packages to install prior to installing Intel MPI. For Ubuntu, the default values are build-essential and cpio. For RHEL-based Linux distributions, the default values are gcc, gcc-c++, make, and which.

prefix — The top level install location. The default value is /opt/intel.

psxevars — Intel Parallel Studio XE provides an environment script (compilervars.sh) to setup the environment. If this value is True, the bashrc is modified to automatically source this environment script. However, the Intel runtime environment is not automatically available to subsequent container image build steps; the environment is available when the container image is run. To set the Intel Parallel Studio XE environment in subsequent build steps you can explicitly call source /opt/intel/compilers_and_libraries/linux/bin/compilervars.sh intel64 in each build step. If this value is to set False, then the environment is set such that the environment is visible to both subsequent container image build steps and when the container image is run. However, the environment may differ slightly from that set by compilervars.sh. This option will be used with the runtime method. The default value is True.

runtime_version — The version of Intel Parallel Studio XE runtime to install via the runtime method. The runtime is installed using the intel_psxe_runtime building block. This value is passed as its version parameter. In general, the major version of the runtime should correspond to the tarball version. The default value is 2020.2-14.

tarball — Path to the Intel Parallel Studio XE tarball relative to the local build context. The default value is empty. This parameter is required.

tbb — Boolean flag to specify whether the Intel Threading Building Blocks environment should be configured when psxevars is False. This flag also controls whether to install the corresponding runtime in the runtime method. Note: this flag does not control whether the developer environment is installed; see components. The default is True.

runtime — Install the runtime from a full build in a previous stage

daal — Boolean flag to specify whether the Intel Data Analytics Acceleration Library runtime should be installed. The default is True.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH, PATH, and others) should be modified to include Intel Parallel Studio XE runtime. psxevars has precedence. The default is True.

eula — By setting this value to True, you agree to the Intel End User License Agreement. The default value is False.

icc — Boolean flag to specify whether the Intel C++ Compiler runtime should be installed. The default is True.

ifort — Boolean flag to specify whether the Intel Fortran Compiler runtime should be installed. The default is True.

ipp — Boolean flag to specify whether the Intel Integrated Performance Primitives runtime should be installed. The default is True.

mkl — Boolean flag to specify whether the Intel Math Kernel Library runtime should be installed. The default is True.

mpi — Boolean flag to specify whether the Intel MPI Library runtime should be installed. The default is True.

psxevars — Intel Parallel Studio XE provides an environment script (psxevars.sh) to setup the environment. If this value is True, the bashrc is modified to automatically source this environment script. However, the Intel runtime environment is not automatically available to subsequent container image build steps; the environment is available when the container image is run. To set the Intel Parallel Studio XE runtime environment in subsequent build steps you can explicitly call source /opt/intel/psxe_runtime/linux/bin/psxevars.sh intel64 in each build step. If this value is to set False, then the environment is set such that the environment is visible to both subsequent container image build steps and when the container image is run. However, the environment may differ slightly from that set by psxevars.sh. The default value is True.

ospackages — List of OS packages to install prior to installing Intel MPI. For Ubuntu, the default values are apt-transport-https, ca-certificates, gcc, gnupg, man-db, openssh-client, and wget. For RHEL-based Linux distributions, the default values are man-db, openssh-clients, and which.

tbb — Boolean flag to specify whether the Intel Threading Building Blocks runtime should be installed. The default is True.

version — The version of the Intel Parallel Studio XE runtime to install. The default value is 2020.2-14.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

cuda — Boolean flag to specify whether the JuliaGPU packages should be installed. If True, the CUDAapi, CUDAdrv, CUDAnative, and CuArrays packages are installed. Note that the CUDAdrv package must be rebuilt when the container is running to align with the host CUDA driver. The default is False.

depot — Path to the location of "user" Julia package depot. The default is an empty string, i.e., ~/.julia. The depot location needs to be writable by the user running the container.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include Julia. The default is True.

history — Path to the Julia history file. The default value is an empty string, i.e., ~/.julia/logs/repl_history.jl. The history location needs to be writable by the user running the container.

ldconfig — Boolean flag to specify whether the Julia library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the Julia library directory. The default value is False.

ospackages — List of OS packages to install prior to building. The default values are tar and wget.

packages — List of Julia packages to install. The default is an empty list.

prefix — The top level installation location. The default value is /usr/local/julia.

version — The version of Julia to install. The default value is 1.5.1.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

environment — Boolean flag to specify whether the environment (CPATH) should be modified to include knem. The default is True.

ospackages — List of OS packages to install prior to installing. The default values are ca-certificates and git.

prefix — The top level install location. The default value is /usr/local/knem.

version — The version of KNEM source to download. The default value is 1.1.4.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

arch — List of target architectures to build. If set adds -DKokkos_ARCH_<value>=ON to the list of CMake options. The default value is VOLTA70, i.e., sm_70. If a CUDA aware build is not selected, then a non-default value should be used.

branch — The git branch to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the default branch for the repository.

check — Boolean flag to specify whether the build should be checked. If True, adds -DKokkos_ENABLE_TESTS=ON to the list of CMake options. The default is False.

cmake_opts — List of options to pass to cmake. The default is -DCMAKE_BUILD_TYPE=RELEASE.

commit — The git commit to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the latest commit on the default branch for the repository.

cuda — Flag to control whether a CUDA aware build is performed. If True, adds -DKokkos_ENABLE_CUDA=ON and -DCMAKE_CXX_COMPILER=$(pwd)/../bin/nvcc_wrapper to the list of CMake options. The default value is True.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include Kokkos. The default is True.

hwloc — Flag to control whether a hwloc aware build is performed. If True, adds -DKokkos_ENABLE_HWLOC=ON to the list of CMake options. The default value is True.

ospackages — List of OS packages to install prior to building. For Ubuntu, the default values are gzip, libhwloc-dev, make, tar, and wget. For RHEL-based Linux distributions the default values are gzip, hwloc-devel, make, tar, and wget.

prefix — The top level installation location. The default value is /usr/local/kokkos.

repository — The location of the git repository that should be used to build OpenMPI. If True, then use the default https://github.com/kokkos/kokkos.git repository. The default is empty, i.e., use the release package specified by version.

url — The location of the tarball that should be used to build Kokkos. The default is empty, i.e., use the release package specified by version.

version — The version of Kokkos source to download. The default value is 3.2.00.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

build_opts — List of VisIt build script options. The default values are --xdb and --server-components-only.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include Libsim. The default is True.

ldconfig — Boolean flag to specify whether the Libsim library directories should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the Libsim library directories. The default value is False.

mpi — Boolean flag to specify whether Libsim should be built with MPI support. VisIt uses MPI-1 routines that have been removed from the MPI standard; the MPI library may need to be built with special compatibility options, e.g., --enable-mpi1-compatibility for OpenMPI. If True, then the build script options --parallel and --no-icet are added and the environment variable PAR_COMPILER is set to mpicc. If True, a MPI library building block should be installed prior this building block. The default value is True.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are gzip, make, patch, tar, wget, zlib1g-dev, libxt-dev, libgl1-mesa-dev, and libglu1-mesa-dev. For RHEL-based Linux distributions, the default values are gzip, make, patch, tar, wget, which, zlib-devel, libXt-devel, libglvnd-devel, mesa-libGL-devel, and mesa-libGLU-devel.

prefix — The top level install location. The default value is /usr/local/visit.

system_cmake — Boolean flag to specify whether the system provided cmake should be used. If False, then the build script downloads a private copy of cmake. If True, then the build script option --system-cmake is added. If True, then the cmake building block should be installed prior to this building block. The default is True.

system_python — Boolean flag to specify whether the system provided python should be used. If False, then the build script downloads a private copy of python. If True, then the build script option --system-python is added. If True, then the Python building block should be installed with development libraries prior to this building block. The default is True.

thirdparty — Boolean flag to specify whether third-party components included by the build script should be retained. If True, then the build script option --thirdparty-path is added and set to <prefix>/third-party. The default is True.

version — The version of Libsim source to download. The default value is 2.13.3.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

environment — Boolean flag to specify whether the environment (CPATH, LD_LIBRARY_PATH and PATH) should be modified to include the LLVM compilers when necessary. The default is True.

extra_tools — Boolean flag to specify whether to also install clang-format and clang-tidy. The default is False.

openmp — Boolean flag to specify whether to also install OpenMP support. The default is True.

toolset — Boolean flag to specify whether to also install the full LLVM toolset. The default is False.

upstream — Boolean flag to specify whether to use the upstream LLVM packages. This option is ignored if the base image is not Ubuntu-based.

version — The version of the LLVM compilers to install. Note that the version refers to the Linux distribution packaging, not the actual compiler version. For RHEL-based 8.x Linux distributions, the version is ignored. The default is an empty value.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

cmake_opts — List of options to pass to cmake. The default value is an empty list.

gpu_target — List of GPU architectures to compile. The default values are Pascal, Volta, and Turing.

ospackages — List of OS packages to install prior to configuring and building. The default values are tar and wget.

prefix — The top level install location. The default value is /usr/local/magma.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of MAGMA source to download. The default value is 2.5.3.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH, PATH, and other variables) should be modified to include MKL. The default is True.

eula — By setting this value to True, you agree to the Intel End User License Agreement. The default value is False.

mklvars — MKL provides an environment script (mklvars.sh) to setup the MKL environment. If this value is True, the bashrc is modified to automatically source this environment script. However, the MKL environment is not automatically available to subsequent container image build steps; the environment is available when the container image is run. To set the MKL environment in subsequent build steps you can explicitly call source /opt/intel/mkl/bin/mklvars.sh intel64 in each build step. If this value is to set False, then the environment is set such that the environment is visible to both subsequent container image build steps and when the container image is run. However, the environment may differ slightly from that set by mklvars.sh. The default value is True.

ospackages — List of OS packages to install prior to installing MKL. For Ubuntu, the default values are apt-transport-https, ca-certificates, gnupg, and wget. For RHEL-based Linux distributions, the default is an empty list.

version — The version of MKL to install. The default value is 2020.0-088.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

oslabel — The Linux distribution label assigned by Mellanox to the tarball. For Ubuntu, the default value is ubuntu16.04. For RHEL-based Linux distributions, the default value is rhel7.2 for x86_64 processors and rhel7.6alternate for aarch64 processors.

ospackages — List of OS packages to install prior to installing OFED. For Ubuntu, the default values are findutils, libnl-3-200, libnl-route-3-200, libnuma1, and wget. For RHEL-based 7.x distributions, the default values are findutils, libnl, libnl3, numactl-libs, and wget. For RHEL-based 8.x distributions, the default values are findutils, libnl3, numactl-libs, and wget.

packages — List of packages to install from Mellanox OFED. For version 5.0 and later on Ubuntu, ibverbs-providers, ibverbs-utils libibmad-dev, libibmad5, libibumad3, libibumad-dev, libibverbs-dev libibverbs1, librdmacm-dev, and librdmacm1. For earlier versions on Ubuntu, the default values are libibverbs1, libibverbs-dev, libibmad, libibmad-devel, libibumad, libibumad-devel, libmlx4-1, libmlx4-dev, libmlx5-1, libmlx5-dev, librdmacm1, librdmacm-dev, and ibverbs-utils. For version 5.0 and later on RHEL-based Linux distributions, the default values are libibumad, libibverbs, libibverbs-utils, librdmacm, rdma-core, and rdma-core-devel. For earlier versions on RHEL-based Linux distributions, the default values are libibverbs, libibverbs-devel, libibverbs-utils, libibmad, libibmad-devel, libibumad, libibumad-devel, libmlx4, libmlx4-devel, libmlx5, libmlx5-devel, librdmacm, and librdmacm-devel.

prefix — The top level install location. Instead of installing the packages via the package manager, they will be extracted to this location. This option is useful if multiple versions of Mellanox OFED need to be installed. The environment must be manually configured to recognize the Mellanox OFED location, e.g., in the container entry point. The default value is empty, i.e., install via the package manager to the standard system locations.

version — The version of Mellanox OFED to download. The default value is 5.6-2.0.9.0.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the make check and make testing steps should be performed. The default is False.

configure_opts — List of options to pass to configure. The default is an empty list.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include MPICH. The default is True.

ldconfig — Boolean flag to specify whether the MPICH library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the MPICH library directory. The default value is False.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are file, gzip, make, openssh-client, perl, tar, and wget. For RHEL-based Linux distributions, the default values are file, gzip, make, openssh-clients, perl, tar, and wget.

prefix — The top level install location. The default value is /usr/local/mpich.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of MPICH source to download. The default value is 3.3.2.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

inbox — Boolean flag to specify whether to install the 'inbox' OFED distributed by the Linux distribution. The default is True.

mlnx_oslabel — The Linux distribution label assigned by Mellanox to the tarball. Please see the corresponding mlnx_ofed parameter for more information.

mlnx_packages — List of packages to install from Mellanox OFED. Please see the corresponding mlnx_ofed parameter for more information.

mlnx_versions — A list of Mellanox OpenFabrics Enterprise Distribution for Linux versions to install. The default values are 3.4-2.0.0.0, 4.0-2.0.0.1, 4.1-1.0.2.0, 4.2-1.2.0.0, 4.3-1.0.1.0, 4.4-1.0.0.0, 4.5-1.0.1.0, 4.6-1.0.1.1, 4.7-3.2.9.0, 5.0-2.1.8.0, and 5.1-2.3.7.1.

ospackages — List of OS packages to install prior to installing OFED. For Ubuntu, the default values are libnl-3-200, libnl-route-3-200, and libnuma1. For RHEL-based Linux distributions, the default values are libnl, libnl3, and numactl-libs.

prefix — The top level install location. The OFED packages will be extracted to this location as subdirectories named for the respective Mellanox OFED version, or inbox for the 'inbox' OFED. The environment must be manually configured to recognize the desired OFED location, e.g., in the container entry point. The default value is /usr/local/ofed.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

arch — The processor architecture of the MVAPICH2-GDR package. The default value is set automatically based on the processor architecture of the base image.

cuda_version — The version of CUDA the MVAPICH2-GDR package was built against. The version string format is X.Y. The version should match the version of CUDA provided by the base image. This value is ignored if package is set. The default value is 10.2.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include MVAPICH2-GDR. The default is True.

gnu — Boolean flag to specify whether a GNU build should be used. The default value is True.

ldconfig — Boolean flag to specify whether the MVAPICH2-GDR library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the MVAPICH2-GDR library directory. The default value is False.

mlnx_ofed_version — The version of Mellanox OFED the MVAPICH2-GDR package was built against. The version string format is X.Y. The version should match the version of Mellanox OFED installed by the mlnx_ofed building block. This value is ignored if package is set. The default value is 4.7.

ospackages — List of OS packages to install prior to installation. For Ubuntu, the default values are cpio, libnuma1, openssh-client, rpm2cpio and wget, plus libgfortran3 if a GNU compiled package is selected. For RHEL-based Linux distributions, the default values are libpciaccess, numactl-libs, openssh-clients, and wget, plus libgfortran if a GNU compiled package is selected.

package — Specify the package name to download. The package should correspond to the other recipe components (e.g., compiler version, CUDA version, Mellanox OFED version). If specified, this option overrides all other building block options (e.g., compiler family, compiler version, CUDA version, Mellanox OFED version, MVAPICH2-GDR version).

pgi — Boolean flag to specify whether a PGI build should be used. The default value is False.

release — The release of MVAPICH2-GDR to download. The value is ignored is package is set. The default value is 1.

version — The version of MVAPICH2-GDR to download. The value is ignored if package is set. The default value is 2.3.4. Due to differences in the packaging scheme, versions prior to 2.3 are not supported.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

configure_opts — List of options to pass to configure. The default values are --disable-mcast.

cuda — Boolean flag to control whether a CUDA aware build is performed. If True, adds --enable-cuda --with-cuda to the list of configure options, otherwise adds --disable-cuda. If the toolchain specifies CUDA_HOME, then that path is used, otherwise /usr/local/cuda is used for the path. The default value is True.

directory — Path to the unpackaged source directory relative to the local build context. The default value is empty. If this is defined, the source in the local build context will be used rather than downloading the source from the web.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment (LD_LIBRARY_PATH and PATH) should be modified to include MVAPICH2. The default is True.

gpu_arch — The GPU architecture to use. Older versions of MVAPICH2 (2.3b and previous) were hard-coded to use "sm_20". This option has no effect on more recent MVAPICH2 versions. The default value is to use the MVAPICH2 default.

ldconfig — Boolean flag to specify whether the MVAPICH2 library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the MVAPICH2 library directory. The default value is False.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are byacc, file, flex, make, openssh-client, and wget. For RHEL-based Linux distributions, the default values are byacc, file, flex, make, openssh-clients, and wget.

prefix — The top level install location. The default value is /usr/local/mvapich2.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of MVAPICH2 source to download. This value is ignored if directory is set. The default value is 2.3.4.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

branch — The git branch to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the default branch for the repository.

build — Boolean flag to specify whether NCCL should be built from source. The default value is False.

commit — The git commit to clone. Only recognized if the repository parameter is specified. The default is empty, i.e., use the latest commit on the default branch for the repository.

cuda — Flag to specify the CUDA version of the package to download. The default is 13.2. This option is ignored if build is True.

environment — Boolean flag to specify whether the environment (CPATH, LD_LIBRARY_PATH, LIBRARY_PATH, and PATH) should be modified to include NCCL. The default is True. This option is ignored if build is False.

make_variables — Dictionary of environment variables and values to set when building NCCL. The default is an empty dictionary. This option is ignored if build is False.

ospackages — List of OS packages to install prior to building. The default values are make and wget.

prefix — The top level install location. The default value is /usr/local/nccl. This option is ignored if build is False.

repository — The location of the git repository that should be used to build NCCL. If True, then use the default https://github.com/NVIDIA/nccl.git repository. The default is empty, i.e., use the release package specified by version.

version — The version of NCCL to install. The default value is 2.30.4-1.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

annotate — Boolean flag to specify whether to include annotations (labels). The default is False.

check — Boolean flag to specify whether the make check step should be performed. The default is False.

configure_opts — List of options to pass to configure. The default value is an empty list.

cxx — Boolean flag to specify whether the NetCDF C++ library should be installed. The default is True.

disable_FEATURE — Flags to control disabling features when configuring. For instance, disable_foo=True maps to --disable-foo. Underscores in the parameter name are converted to dashes.

enable_FEATURE[=ARG] — Flags to control enabling features when configuring. For instance, enable_foo=True maps to --enable-foo and enable_foo='yes' maps to --enable-foo=yes. Underscores in the parameter name are converted to dashes.

environment — Boolean flag to specify whether the environment (CPATH, LD_LIBRARY_PATH, LIBRARY_PATH and PATH) should be modified to include NetCDF. The default is True.

fortran — Boolean flag to specify whether the NetCDF Fortran library should be installed. The default is True.

ldconfig — Boolean flag to specify whether the NetCDF library directory should be added dynamic linker cache. If False, then LD_LIBRARY_PATH is modified to include the NetCDF library directory. The default value is False.

ospackages — List of OS packages to install prior to configuring and building. For Ubuntu, the default values are ca-certificates, file, libcurl4-openssl-dev, libxml2-dev, m4, make, wget, and zlib1g-dev. For RHEL-based Linux distributions the default values are ca-certificates, file, libcurl-devel, libxml2-devel, m4, make, wget, and zlib-devel.

prefix — The top level install location. The default location is /usr/local/netcdf.

toolchain — The toolchain object. This should be used if non-default compilers or other toolchain options are needed. The default is empty.

version — The version of NetCDF to download. The default value is 4.7.4.

version_cxx — The version of NetCDF C++ to download. The default value is 4.3.1.

version_fortran — The version of NetCDF Fortran to download. The default value is 4.5.3.

with_PACKAGE[=ARG] — Flags to control optional packages when configuring. For instance, with_foo=True maps to --with-foo and with_foo='/usr/local/foo' maps to --with-foo=/usr/local/foo. Underscores in the parameter name are converted to dashes.

without_PACKAGE — Flags to control optional packages when configuring. For instance without_foo=True maps to --without-foo. Underscores in the parameter name are converted to dashes.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

eula — Required, by setting this value to True, you agree to the Nsight Compute End User License Agreement that is displayed when running the installer interactively. The default value is False.

ospackages — List of OS packages to install prior to building. When using a runfile, the default values are perl for Ubuntu and perl and perl-Env for RHEL-based Linux distributions. Otherwise, the default values are apt-transport-https, ca-certificates, gnupg, and wget for Ubuntu and an empty list for RHEL-based Linux distributions.

prefix — The top level install prefix. The default value is /usr/local/NVIDIA-Nsight-Compute. This parameter is ignored unless runfile is set.

runfile — Path or URL to NSight Compute's .run file relative to the local build context. The default value is empty.

version — the version of Nsight Compute to install. Note when runfile is set this parameter is ignored. The default value is 2026.2.1.

cli — Boolean flag to specify whether the command line only (CLI) package should be installed. The default is True.

version — The version of Nsight Systems to install. The default value is 2026.4.1.

cuda — The default CUDA version to configure. The default is an empty value, i.e., use the latest version supported by the NVIDIA HPC SDK. This value is ignored if installing from the package repository.

cuda_multi — Boolean flag to specify whether the NVIDIA HPC SDK support for multiple CUDA versions should be installed. The default value is True.

environment — Boolean flag to specify whether the environment (CPATH, LD_LIBRARY_PATH, MANPATH, and PATH) should be modified to include the NVIDIA HPC SDK. The default is True.

eula — By setting this value to True, you agree to the NVIDIA HPC SDK End-User License Agreement. The default value is False.

extended_environment — Boolean flag to specify whether an extended set of environment variables should be defined. If True, the following environment variables CC, CPP, CXX, F77, F90, and FC. If False, then only CPATH, LD_LIBRARY_PATH, MANPATH, and PATH will be extended to include the NVIDIA HPC SDK. The default value is False.

mpi — Boolean flag to specify whether MPI should be included in the environment. The default value is True.

ospackages — List of OS packages to install prior to installing the NVIDIA HPC SDK. The default value is ca-certificates, gnupg, and wget for Ubuntu, and ca-certificates for RHEL-based Linux distributions. If not installing from the package repository, then for Ubuntu, the default values are bc, debianutils, gcc, g++, gfortran, libatomic1, libnuma1, openssh-client, and wget, and for RHEL-based Linux distributions, the default values are bc, gcc, gcc-c++, gcc-gfortran, libatomic, numactl-libs, openssh-clients, wget, and which.

package — Path to the NVIDIA HPC SDK tar package file relative to the local build context. The default value is empty.

prefix — The top level install prefix. The default value is /opt/nvidia/hpc_sdk. This value is ignored when installing from the package repository.

redist — The list of redistributable files to copy into the runtime stage. The paths are relative to the REDIST directory and wildcards are supported. The default is an empty list.

tarball — Boolean flag to specify whether the NVIDIA HPC SDK should be installed by downloading the tar package file. If False, install from the package repository. The default is False.

toolchain — The toolchain object to be used to configure the HPC SDK with a specific GNU toolchain. The default is empty, i.e., use the default GNU toolchain.

url — The location of the package that should be installed. The default value is https://developer.download.nvidia.com/hpc-sdk/nvhpc_X_Y_Z_cuda_multi.tar.gz, where X,Y, andZ` are the year, version, and architecture whose values are automatically determined.

version — The version of the HPC SDK to use. Note when package is set the version is determined automatically from the package file name. The default value is 25.11.

runtime — Generate the set of instructions to install the runtime specific components from a build in a previous stage.

build_examples — Boolean flag to specify whether the NVSHMEM examples should be built. The default is False.

build_packages — Boolean flag to specify whether the RPM and deb packages should be built. The default is False.

cmake_opts — List of additional options to pass to cmake. The default value is an empty list.

cuda — Flag to specify the path to the CUDA installation. The default is /usr/local/cuda.

environment — Boolean flag to specify whether the environment (CPATH, LIBRARY_PATH, and PATH) should be modified to include NVSHMEM. The default is True.