Building Smith's Third-party Libraries

It is now time to build Smith's Third-party Libraries (TPLs) and optionally our Developer Tools.

Building Developer Tools

Note

This section can be skipped if you are not developing Smith and contributing back to our repository. It can also be skipped if you are a part of the smithdev LC Linux group, as it will be automatically added by our Spack Environment.

Smith developers utilize some industry standard development tools in their everyday work. These tools can take a very long time to build and it is recommended to build them separately from the TPLs then include them in the followup TPL build. Unlike Smith's library dependencies, our developer tools can be built with any compiler because they are not linked into the smith executable. We recommend Clang 19 because we have tested that they all build with that compiler. If you wish to build them yourself (which takes a long time), use one of the following commands:

For LC machines:

# These commands are equivalent, pick one
$ scripts/llnl/build_devtools.py --directory=<devtool/build/path>
$ scripts/uberenv/uberenv.py --project-json=scripts/spack/devtools.json --spack-env-file=scripts/spack/devtools_configs/$SYS_TYPE/spack.yaml --prefix=../path/to/install

For other machines utilize the Spack Environment created in the previous Basic System Setup step:

$ scripts/uberenv/uberenv.py --project-json=scripts/spack/devtools.json --spack-env-file=<created/spack.yaml> --prefix=../path/to/install

For example on Ubuntu 24.04:

$ scripts/uberenv/uberenv.py --project-json=scripts/spack/devtools.json --spack-env-file=scripts/spack/configs/linux_ubuntu_24/spack.yaml --prefix=../path/to/install

After the Developer Tools have been successfully installed, you have two options to use them in the following step to build your TPLs.

1. Alter your Spack Environment by adding the following lines with the correct paths and versions:

   cppcheck:
     version: [2.9]
     buildable: false
     externals:
     - spec: cppcheck@2.9
       prefix: /path/to/devtools_install/cppcheck-2.9
   

2. Add a Spack upstream to the uberenv commands below with this command line option --upstream=../path/to/devtools_install.

Building TPLs

Run the command with the compiler that you want to develop with:

scripts/uberenv/uberenv.py --prefix=<path/outside/repository> --spack-env-file=<path/to/spack.yaml> --spec="%clang_19"

Some helpful uberenv options include:

• --spec="+caliper+adiak build_type=Debug %clang_19" (Spack spec, smith@develop automatically prepended)

• --spack-env-file=<Path to Spack environment file> (use specific Spack environment configuration file)

• --prefix=<Path> (required, build and install the dependencies in a particular location) - this must be outside of your local Smith repository

The rest of Uberenv's command line options can be seen here.

Basic Spack variants:

Variant	Default	Description
build_type	Release	CMake build type (Debug, Release, RelWithDebInfo, MinSizeRel)
shared	False	Enable build of shared libraries
asan	False	Enable Address Sanitizer flags
openmp	True	Enable OpenMP support
devtools	False	Build development tools (such as Sphinx, CppCheck, ClangFormat, etc...)
cuda	False	Enable CUDA support (requires cuda_arch=<number>)
cuda_arch	N/A	Set CUDA architecture (for example, 70), can be single or comma delimited
rocm	False	Enable ROCM support (requires amdgpu_target=<number>)
amdgpu_target	N/A	Set ROCM target (for example, gfx942), can be single or comma delimited

Note

Spack variants come in two flavors: Boolean, which is indicated in the spec by + for true and ~ for false, and Multi-value variants, which must start with a space and require a value after the = sign (for example, +cuda cuda_arch=80).

Note

If you are building on LC, using our provided Spack Environments, and do not have access to the smithdev linux group, you cannot use our prebuilt Developer Tools referenced in the Spack Environment files. You will need to turn off the devtool variant by adding ~devtools to your Spack spec via the Spack or uberenv command line.

Note

If you are building on macOS, the invocation of uberenv.py may need to be slightly modified from the standard instructions below in order to force the use of the Homebrew-installed MPI and compilers. The spec command line option should be --spec="^openmpi@5 %clang_19" and to build with devtools and profiling enabled, change the spec to "+devtools+caliper+adiak ^openmpi@5 %clang_19".

TPL Spack variants:

Variant	Default	Description
adiak	False	Build with adiak
caliper	False	Build with caliper
enzyme	False	Enable Enzyme Automatic Differentiation Framework
petsc	True	Enable PETSc support
raja	True	Build with portable kernel execution support
slepc	True	Enable SLEPc integration
strumpack	True	Build MFEM TPL with Strumpack, a direct linear solver library
sundials	True	Build MFEM TPL with SUNDIALS nonlinear/ODE solver support
tribol	True	Build Tribol, an interface physics library
umpire	True	Build with portable memory access support

If successful, you will see two things. The first is what we call a host-config. It is all the CMake inputs you need to build Smith. This file will be a new CMake file in the current directory with your machine name, system type, and compiler, for example mycomputerlinux-ubuntu24.04-skylake-clang@19.1.1.cmake. The second will be output from Spack that ends in this:

==> smith: Executing phase: 'initconfig'

Building Smith

Finally, with the TPL's built and the host-config file, you can build Smith for more detail instructions on how to build Smith, see Building Smith with CMake.