Installing and Using Morpheus

You can either use Morpheus as an installed package (encouraged) or use Morpheus in-tree in your project. Once Morpheus is installed In your CMakeLists.txt simply use:

find_package(Morpheus REQUIRED)

Then for every executable or library in your project:

target_link_libraries(myTarget Morpheus::morpheus)

Configuring CMake

A very basic installation is done with:

cmake ${srcdir} \
 -DCMAKE_CXX_COMPILER=g++ \
 -DCMAKE_INSTALL_PREFIX=${my_install_folder}
 -DKokkos_ROOT=${kokkos_install_prefix}

which builds and installs a default Morpheus when you run make install. Note that Morpheus REQUIRES Kokkos to be installed. There is no checking Morpheus preprocessor, compiler, or linker flags. CMake propagates all the necesssary flags to your project. This means not only is linking to Morpheus easy, but Morpheus itself can actually configure compiler and linker flags for your project. If building in-tree, there is no find_package. In fact, you only ever need to link to Morpheus and not Kokkos! Linking to Morpheus transitively provides Kokkos.

There are also option Third-party Libraries (TPLs)

cmake ${srcdir} \
 -DCMAKE_CXX_COMPILER=g++ \
 -DCMAKE_INSTALL_PREFIX=${my_install_folder} \
 -DMorpheus_ENABLE_TPL_CUBLAS=ON

which, e.g. activates the CUBLAS dependency. The full keyword listing is below.

Archer

Setup environment - Cray

$ module restore PrgEnv-cray
$ module load cmake
$ export CRAYPE_LINK_TYPE=dynamic
$ CXX_COMPILER=/opt/cray/pe/craype/2.7.2/bin/CC
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/cray
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/cray

Setup environment - GNU

$ module restore PrgEnv-gnu
$ module load cmake
$ export CRAYPE_LINK_TYPE=dynamic
$ CXX_COMPILER=/opt/cray/pe/craype/2.7.2/bin/CC
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/gnu
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/gnu

Setup environment - AMD

$ module restore PrgEnv-aocc
$ module load cmake
$ export CRAYPE_LINK_TYPE=dynamic
$ CXX_COMPILER=/opt/cray/pe/craype/2.7.2/bin/CC
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/aocc
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/aocc

Installing Kokkos

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_DIR} \
           -DCMAKE_BUILD_TYPE=Release -DKokkos_ENABLE_OPENMP=ON  -DKokkos_ENABLE_SERIAL=ON \
           -DKokkos_CXX_STANDARD=17 -DKokkos_ENABLE_COMPILER_WARNINGS=On -DKokkos_ARCH_ZEN2=On \
           -DKokkos_ENABLE_AGGRESSIVE_VECTORIZATION=On
$ make
$ make install

Cirrus - CPU

Setup environment - Intel

$ module load cmake
$ module load intel-20.4/compilers
$ module swap gcc/6.3.0 gcc/10.2.0
$ CXX_COMPILER=/lustre/sw/intel/compilers_and_libraries_2020.4.304/linux/bin/intel64/icpc
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/intel
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/intel

Setup environment - GNU

$ module load cmake
$ module load gcc/10.2.0
$ CXX_COMPILER=$(which g++)
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/gnu
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/gnu

Installing Kokkos

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_DIR} \
           -DCMAKE_BUILD_TYPE=Release -DKokkos_ENABLE_OPENMP=ON  -DKokkos_ENABLE_SERIAL=ON \
           -DKokkos_CXX_STANDARD=17 -DKokkos_ENABLE_COMPILER_WARNINGS=On -DKokkos_ARCH_BDW=On \
           -DKokkos_ENABLE_AGGRESSIVE_VECTORIZATION=On
$ make
$ make install

Cirrus - GPU

Setup environment

$ module load cmake
$ module load nvidia/cuda-11.0
$ module swap gcc/6.3.0 gcc/8.2.0 # otherwise complaints for not compatible with c++17 features
$ CXX_COMPILER=/path/to/kokkos/bin/nvcc_wrapper
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/cuda-11.0
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/cuda-11.0

Local Machine

$ CXX_COMPILER=/usr/local/bin/g++-12
$ KOKKOS_INSTALL_DIR=/install/path/of/kokkos/with/gnu
$ MORPHEUS_INSTALL_DIR=/install/path/of/morpheus/with/gnu

Installing Kokkos

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_DIR} \
           -DCMAKE_BUILD_TYPE=Release -DKokkos_ENABLE_CUDA=ON -DKokkos_ENABLE_OPENMP=ON  -DKokkos_ENABLE_SERIAL=ON \
           -DKokkos_CXX_STANDARD=17 -DKokkos_ENABLE_COMPILER_WARNINGS=On -DKokkos_ARCH_VOLTA70=On -DKokkos_ARCH_SKX=On \
           -DKokkos_ENABLE_AGGRESSIVE_VECTORIZATION=On -DKokkos_ENABLE_CUDA_CONSTEXPR=On -DKokkos_ENABLE_CUDA_LAMBDA=On
$ make
$ make install

Warning For cmake to find the cuda drivers you need to have a visible NVIDIA GPU. See here how to create an interactive GPU session on Cirrus.

Warning For C++17 support requires NVCC 11.0+ or Clang 4.0+

Warning For using lambdas on device Kokkos_ENABLE_CUDA_CONSTEXPR and Kokkos_ENABLE_CUDA_LAMBDA must be enabled.

Installing Morpheus

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${MORPHEUS_INSTALL_DIR} \
           -DKokkos_ROOT=${KOKKOS_INSTALL_DIR} -DCMAKE_BUILD_TYPE=Release \
           -DMorpheus_ENABLE_EXAMPLES=Off -DMorpheus_ENABLE_TESTS=Off
$ make
$ make install

Warning The installed Kokkos configuration does not support CXX extensions when build with CUDA enabled. Add the -DCMAKE_CXX_EXTENSIONS=Off to surpress warning.

P3 - MI100

Setup environment

$ module use /lustre/projects/bristol/modules/modulefiles
$ module load cmake/3.23.2
$ module load amd/4.5.1
$ CXX_COMPILER=$(which hipcc)
$ KOKKOS_INSTALL_DIR="/lustre/home/ri-cstylianou/morpheus-benchmarks/tpl/kokkos/installs/release-mi100-off-hip-4.5-off-hip"
$ MORPHEUS_INSTALL_DIR="/lustre/home/ri-cstylianou/morpheus-benchmarks/tpl/morpheus/installs/release-mi100-off-hip-4.5-off-hip"

Installing Kokkos

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_DIR} \
           -DCMAKE_BUILD_TYPE=Release -DKokkos_ENABLE_HIP=On -DKokkos_ENABLE_CUDA=Off -DKokkos_ENABLE_OPENMP=Off  -DKokkos_ENABLE_SERIAL=ON \
           -DKokkos_CXX_STANDARD=17 -DKokkos_ENABLE_COMPILER_WARNINGS=On -DKokkos_ARCH_ZEN3=On -DKokkos_ARCH_VEGA908=On \
           -DKokkos_ENABLE_AGGRESSIVE_VECTORIZATION=On 
           
$ make
$ make install

Installing Morpheus

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${MORPHEUS_INSTALL_DIR} \
           -DKokkos_ROOT=${KOKKOS_INSTALL_DIR} -DCMAKE_BUILD_TYPE=Release \
           -DMorpheus_ENABLE_EXAMPLES=Off -DMorpheus_ENABLE_TESTS=On -DMorpheus_ENABLE_INDIVIDUAL_TESTS=On
$ make
$ make install

module use /lustre/projects/bristol/modules/modulefiles
module load cmake
module load amd/4.5.1
CXX_COMPILER=$(which hipcc)
KOKKOS_INSTALL_DIR="/lustre/home/ri-cstylianou/morpheus-benchmarks/tpl/kokkos/installs/release-mi100-off-hip-4.5-off-hip"
MORPHEUS_INSTALL_DIR="/lustre/home/ri-cstylianou/morpheus-benchmarks/tpl/morpheus/installs/release-mi100-off-hip-4.5-off-hip"

cmake ../.. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${MORPHEUS_INSTALL_DIR} \
           -DKokkos_ROOT=${KOKKOS_INSTALL_DIR} -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_EXTENSIONS=Off \
           -DMorpheus_ENABLE_EXAMPLES=Off -DMorpheus_ENABLE_TESTS=On -DMorpheus_ENABLE_INDIVIDUAL_TESTS=On \
           -DGTest_ROOT=/lustre/home/ri-cstylianou/googletest/install

Valgrind Memcheck

$  valgrind -s --tool=memcheck --leak-check=full --track-origins=yes /path/to/exe

Installing Kokkos with Bound Checks

$ cmake .. -DCMAKE_CXX_COMPILER=${CXX_COMPILER} -DCMAKE_INSTALL_PREFIX=${KOKKOS_INSTALL_DIR} \
           -DCMAKE_BUILD_TYPE=Debug -DKokkos_ENABLE_OPENMP=ON  -DKokkos_ENABLE_SERIAL=ON \
           -DKokkos_CXX_STANDARD=17 -DKokkos_ENABLE_COMPILER_WARNINGS=On -DKokkos_ENABLE_DEBUG_BOUNDS_CHECK=On
$ make
$ make install

Interactive Sessions on Cirrus

GPU Session

$ ACCOUNT_ID=YOUR_PROJECT_ID
$ srun --exclusive --nodes=1 --time=01:00:00 --gres=gpu:4 --partition=gpu-cascade --qos=gpu --account=${ACCOUNT_ID} --pty /usr/bin/bash --login

CPU Session

$ ACCOUNT_ID=YOUR_PROJECT_ID
srun --exclusive --nodes=1 --time=01:00:00 --partition=standard --qos=standard --account=${ACCOUNT_ID} --pty /usr/bin/bash --login

Morpheus Keyword Listing

Enable Options

Options can be enabled by specifying -DMorpheus_ENABLE_X.

Morpheus_ENABLE_DEBUG
- Whether to activate extra debug features - may increase compile times
- BOOL Default: OFF
Morpheus_ENABLE_EXAMPLES
- Whether to enable building examples
- BOOL Default: OFF
Morpheus_ENABLE_TESTS
- Whether to enable building tests
- BOOL Default: OFF
Morpheus_ENABLE_DOCS
- Whether to enable building documentation
Morpheus_ENABLE_RAPID_TESTING
- Whether to enable building a small portion of tests
- BOOL Default: OFF
Morpheus_ENABLE_BENCHMARKS
- Whether to enable building benchmarks
- BOOL Default: OFF
Morpheus_INSTALL_TESTING
- Whether to build tests and examples against installation
- BOOL Default: OFF

Third-party Libraries (TPLs)

The following options control enabling TPLs:

Morpheus_ENABLE_TPL_CUBLAS: BOOL
- Whether to enable CUBLAS
- Default: ON if CUDA-enabled Kokkos, otherwise OFF
Morpheus_ENABLE_TPL_HIPBLAS: BOOL
- Whether to enable HIPBLAS
- Default: ON if HIP-enabled Kokkos, otherwise OFF
Morpheus_ENABLE_TPL_MPARK_VARIANT
- Whether to enable the Mpark Variant library
- BOOL Default: OFF

The following options control find_package paths for CMake-based TPLs:

Morpheus_CUBLAS_ROOT: PATH
- Location of CUBLAS install root.
- Default: None or the value of the environment variable CUBLAS_ROOT if set
GTest_ROOT: PATH
- Location of GoogleTest install root.
- Default: None or the value of the environment variable GTest_ROOT if set
CUBLAS_LIBRARIES: STRING
- Optional override for the libraries that comprise TPL CUBLAS.
- Default: None. Default common library names will be searched
CUBLAS_LIBRARY_DIRS: STRING
- Optional override for the library directories that comprise TPL CUBLAS.
- Default: None. Default common library locations will be searched
MPARK_VARIANT_DIR or MPARK_VARIANT_ROOT
- Location of MPARK_VARIANT prefix (ROOT) or CMake config file (DIR)
- PATH Default:

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BUILD.md

BUILD.md

Installing and Using Morpheus

Configuring CMake

Archer

Setup environment - Cray

Setup environment - GNU

Setup environment - AMD

Installing Kokkos

Cirrus - CPU

Setup environment - Intel

Setup environment - GNU

Installing Kokkos

Cirrus - GPU

Setup environment

Local Machine

Installing Kokkos

Installing Morpheus

P3 - MI100

Setup environment

Installing Kokkos

Installing Morpheus

Valgrind Memcheck

Installing Kokkos with Bound Checks

Interactive Sessions on Cirrus

GPU Session

CPU Session

Morpheus Keyword Listing

Enable Options

Third-party Libraries (TPLs)

Files

BUILD.md

Latest commit

History

BUILD.md

File metadata and controls

Installing and Using Morpheus

Configuring CMake

Archer

Setup environment - Cray

Setup environment - GNU

Setup environment - AMD

Installing Kokkos

Cirrus - CPU

Setup environment - Intel

Setup environment - GNU

Installing Kokkos

Cirrus - GPU

Setup environment

Local Machine

Installing Kokkos

Installing Morpheus

P3 - MI100

Setup environment

Installing Kokkos

Installing Morpheus

Valgrind Memcheck

Installing Kokkos with Bound Checks

Interactive Sessions on Cirrus

GPU Session

CPU Session

Morpheus Keyword Listing

Enable Options

Third-party Libraries (TPLs)