diff --git a/install.md b/install.md index abff97a..38bc924 100644 --- a/install.md +++ b/install.md @@ -6,9 +6,9 @@ title: Installation cheat sheet for Kokkos # Kokkos install cheat sheet -Doc https://kokkos.org/kokkos-core-wiki/ProgrammingGuide/Compiling.html +Doc https://kokkos.org/kokkos-core-wiki/get-started/quick-start.html -Doc https://kokkos.org/kokkos-core-wiki/building.html +Doc https://kokkos.org/kokkos-core-wiki/ProgrammingGuide/Compiling.html Doc https://github.com/kokkos/kokkos-tutorials/blob/main/LectureSeries/KokkosTutorial_01_Introduction.pdf @@ -41,14 +41,13 @@ title: Installation cheat sheet for Kokkos | CMake | 3.18 | For better Fortran linking | | CMake | 3.16 | | - -Doc https://kokkos.org/kokkos-core-wiki/requirements.html +Doc https://kokkos.org/kokkos-core-wiki/get-started/requirements.html ## How to build Kokkos -### As part of your application +### As a sub-directory dependency ```cmake add_subdirectory(path/to/kokkos) @@ -65,13 +64,41 @@ cmake -B build \ ``` +You may want to provide Kokkos as a Git submodule. + -Code Code example: +Doc https://kokkos.org/kokkos-core-wiki/get-started/integrating-kokkos-into-your-cmake-project.html#embedded-kokkos-via-add-subdirectory-and-git-submodules +Doc https://cmake.org/cmake/help/latest/command/add_subdirectory.html#command:add_subdirectory + + +### As an online dependency + +```cmake +include(FetchContent) +FetchContent_Declare( + kokkos + URL https://github.com/kokkos/kokkos/releases/download/x.y.z/kokkos-x.y.z.zip +) +FetchContent_MakeAvailable(kokkos) +target_link_libraries( + my-app + Kokkos::kokkos +) +``` + +```sh +cd path/to/your/code +cmake -B build \ + -DCMAKE_CXX_COMPILER= \ + +``` -- https://github.com/kokkos/kokkos/tree/master/example/build_cmake_in_tree + +Doc https://kokkos.org/kokkos-core-wiki/get-started/integrating-kokkos-into-your-cmake-project.html#embedded-kokkos-via-fetchcontent +Doc https://cmake.org/cmake/help/latest/module/FetchContent.html -### As an external library +### As an external dependency #### Configure, build and install Kokkos @@ -85,14 +112,10 @@ cmake --build build cmake --install build ``` - -Doc https://kokkos.org/kokkos-core-wiki/building.html - - #### Use in your code ```cmake -find_package(Kokkos REQUIRED) +find_package(Kokkos x.y.z REQUIRED) target_link_libraries( my-app Kokkos::kokkos @@ -107,16 +130,31 @@ cmake -B build \ ``` +Doc https://kokkos.org/kokkos-core-wiki/get-started/integrating-kokkos-into-your-cmake-project.html#external-kokkos-recommended-for-most-users Doc https://cmake.org/cmake/help/latest/guide/tutorial/index.html +### As an external or sub-directory/online dependency + +```cmake +find_package(Kokkos x.y.z QUIET) +if(Kokkos_FOUND) + message(STATUS "Using installed Kokkos in ${Kokkos_DIR}") +else() + message(STATUS "Using Kokkos from ...") + # use either the sub-directory or the online dependency approach +endif() +``` + +Depending if Kokkos is already installed, you may have to call CMake with `-DKokkos_ROOT`, or with Kokkos compile options. + ### As a Spack package TODO finish this part -Doc See https://kokkos.org/kokkos-core-wiki/building.html#spack +Doc https://kokkos.org/kokkos-core-wiki/get-started/package-managers.html?highlight=spack#spack-https-spack-io @@ -166,7 +204,7 @@ See [architecture-specific options](#architecture-specific-options). -Doc For more, see https://kokkos.org/kokkos-core-wiki/keywords.html +Doc https://kokkos.org/kokkos-core-wiki/get-started/configuration-guide.html ### Architecture-specific options @@ -350,7 +388,7 @@ They can be deduced from the device if present at CMake configuration time. ### Third-party Libraries (TPLs) -Doc See https://kokkos.org/kokkos-core-wiki/keywords.html#third-party-libraries-tpls +Doc https://kokkos.org/kokkos-core-wiki/get-started/configuration-guide.html#keywords-tpls ### Examples for the most common architectures diff --git a/patches/print/install.tex.diff b/patches/print/install.tex.diff index 769817f..db64d32 100644 --- a/patches/print/install.tex.diff +++ b/patches/print/install.tex.diff @@ -1,6 +1,15 @@ ---- .install.tex 2024-06-11 16:45:25.798270906 +0200 -+++ install.tex 2024-06-11 16:45:51.158407213 +0200 -@@ -497,7 +497,7 @@ +--- .install.tex 2025-02-28 15:37:52.208429178 +0100 ++++ install.tex 2025-02-28 15:38:14.746538842 +0100 +@@ -471,7 +471,7 @@ + \KeywordTok{include}\NormalTok{(FetchContent)} + \FunctionTok{FetchContent\_Declare}\NormalTok{(} + \NormalTok{ kokkos} +-\NormalTok{ URL https://github.com/kokkos/kokkos/releases/download/x.y.z/kokkos{-}x.y.z.zip} ++\NormalTok{ URL https://github.com/kokkos/kokkos/releases/download/x.y.z/\break{}kokkos{-}x.y.z.zip} + \NormalTok{)} + \FunctionTok{FetchContent\_MakeAvailable}\NormalTok{(kokkos)} + \KeywordTok{target\_link\_libraries}\NormalTok{(} +@@ -645,7 +645,7 @@ \begin{tabularx}{\linewidth}{llX} \toprule @@ -8,8 +17,8 @@ +\tblhead{Option} & \tblhead{Arch.} & \tblhead{Associated cards} \\ \midrule - \texttt{-DKokkos\_ARCH\_AMD\_GFX942=ON} & GFX942 & MI300A, MI300X \\ -@@ -537,7 +537,7 @@ + \texttt{-DKokkos\_ARCH\_AMD\_GFX942\_APU=ON} & GFX942 APU & MI300A \\ +@@ -688,7 +688,7 @@ \begin{tabularx}{\linewidth}{lllX} \toprule @@ -18,12 +27,3 @@ cards} \\ \midrule \texttt{-DKokkos\_ARCH\_HOPPER90=ON} & Hopper & 9.0 & H200, H100 \\ -@@ -639,7 +639,7 @@ - \ExtensionTok{{-}DKokkos\_ENABLE\_SYCL}\NormalTok{=ON }\KeywordTok{\textbackslash{}} - \ExtensionTok{{-}DKokkos\_ARCH\_INTEL\_PVC}\NormalTok{=ON }\KeywordTok{\textbackslash{}} - \ExtensionTok{{-}DKokkos\_ENABLE\_OPENMP}\NormalTok{=ON }\KeywordTok{\textbackslash{}} -- \ExtensionTok{{-}DCMAKE\_CXX\_FLAGS}\NormalTok{=}\StringTok{"{-}fp{-}model=precise"}\NormalTok{ \# for math precision} -+ \ExtensionTok{{-}DCMAKE\_CXX\_FLAGS}\NormalTok{=}\StringTok{"{-}fp{-}model=precise"}\CommentTok{ \# for math precision} - \end{Highlighting} - \end{Shaded} -