spack/var/spack/repos/builtin/packages/arborx/package.py
2024-11-19 15:44:59 +01:00

173 lines
6.7 KiB
Python

# Copyright 2013-2024 Lawrence Livermore National Security, LLC and other
# Spack Project Developers. See the top-level COPYRIGHT file for details.
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
from spack.package import *
class Arborx(CMakePackage, CudaPackage, ROCmPackage):
"""ArborX is a performance-portable library for geometric search"""
homepage = "https://github.com/arborx/arborx"
url = "https://github.com/arborx/arborx/archive/v1.1.tar.gz"
git = "https://github.com/arborx/arborx.git"
tags = ["e4s", "ecp"]
maintainers("aprokop")
test_requires_compiler = True
license("BSD-3-Clause")
version("master", branch="master")
version("1.7", sha256="e3d9a57a1d7c1ad62f6bbb43fd29a366506f3a16cbbe801c04d10f5fb0dec201")
version("1.6", sha256="c2230de185d62f1999d36c6b8b92825f19ab9fbf30bdae90595cab04e76561a4")
version("1.5", sha256="c26f23c17e749ccf3e2d353a68969aa54d31b8e720dbfdbc2cef16c5d8477e9e")
version("1.4.1", sha256="2ca828ef6615859654b233a7df17017e7cfd904982b80026ec7409eb46b77a95")
version("1.4", sha256="803a1018a6305cf3fea161172b3ada49537f59261279d91c2abbcce9492ee7af")
version("1.3", sha256="3f1e17f029a460ab99f8396e2772cec908eefc4bf3868c8828907624a2d0ce5d")
version("1.2", sha256="ed1939110b2330b7994dcbba649b100c241a2353ed2624e627a200a398096c20")
version("1.1", sha256="2b5f2d2d5cec57c52f470c2bf4f42621b40271f870b4f80cb57e52df1acd90ce")
version("1.0", sha256="9b5f45c8180622c907ef0b7cc27cb18ba272ac6558725d9e460c3f3e764f1075")
version(
"0.9-beta",
sha256="b349b5708d1aa00e8c20c209ac75dc2d164ff9bf1b85adb5437346d194ba6c0d",
deprecated=True,
)
depends_on("c", type="build")
depends_on("cxx", type="build")
# Allowed C++ standard
variant(
"cxxstd",
default="17",
values=("14", "17", "2a", "2b"),
multi=False,
description="Use the specified C++ standard when building.",
)
conflicts("cxxstd=14", when="@1.3:")
# ArborX relies on Kokkos to provide devices, providing one-to-one matching
# variants. The only way to disable those devices is to make sure Kokkos
# does not provide them.
kokkos_backends = {
"serial": (True, "enable Serial backend (default)"),
"openmp": (False, "enable OpenMP backend"),
"sycl": (False, "enable SYCL backend"),
}
variant("mpi", default=True, description="enable MPI")
for backend in kokkos_backends:
deflt, descr = kokkos_backends[backend]
variant(backend.lower(), default=deflt, description=descr)
variant("trilinos", default=False, when="@:1.5", description="use Kokkos from Trilinos")
depends_on("cmake@3.12:", type="build")
depends_on("cmake@3.16:", type="build", when="@1.0:")
depends_on("mpi", when="+mpi")
depends_on("rocthrust", when="+rocm")
patch("0001-update-major-version-required-for-rocm-6.0.patch", when="@:1.5+rocm ^hip@6.0:")
# Standalone Kokkos
depends_on("kokkos@3.1.00:", when="~trilinos")
depends_on("kokkos@3.4.00:", when="@1.2~trilinos")
depends_on("kokkos@3.6.00:", when="@1.3~trilinos")
depends_on("kokkos@3.7.01:", when="@1.4:1.4.1~trilinos")
depends_on("kokkos@4.0.00:", when="@1.5~trilinos")
depends_on("kokkos@4.1.00:", when="@1.6")
depends_on("kokkos@4.2.00:", when="@1.7:")
for backend in kokkos_backends:
depends_on("kokkos+%s" % backend.lower(), when="~trilinos+%s" % backend.lower())
for arch in CudaPackage.cuda_arch_values:
cuda_dep = f"+cuda cuda_arch={arch}"
depends_on(f"kokkos {cuda_dep}", when=f"~trilinos {cuda_dep}")
depends_on(f"trilinos {cuda_dep}", when=f"+trilinos {cuda_dep}")
for arch in ROCmPackage.amdgpu_targets:
rocm_dep = f"+rocm amdgpu_target={arch}"
depends_on(f"kokkos {rocm_dep}", when=f"~trilinos {rocm_dep}")
depends_on(f"trilinos {rocm_dep}", when=f"+trilinos {rocm_dep}")
conflicts("+cuda", when="cuda_arch=none")
conflicts("^kokkos", when="+trilinos")
depends_on("kokkos+cuda_lambda", when="~trilinos+cuda")
# Trilinos with internal Kokkos
# Notes:
# - starting with Trilinos 14.4, Trilinos' spack package uses external Kokkos
# - current version of Trilinos package does not allow disabling Serial
# - current version of Trilinos package does not allow enabling CUDA
depends_on("trilinos+kokkos", when="+trilinos")
depends_on("trilinos+openmp", when="+trilinos+openmp")
depends_on("trilinos@13.2.0:", when="@1.2+trilinos")
depends_on("trilinos@13.4.0:", when="@1.3+trilinos")
depends_on("trilinos@14.0.0:", when="@1.4:1.4.1+trilinos")
depends_on("trilinos@14.2.0:", when="@1.5+trilinos")
patch("trilinos14.0-kokkos-major-version.patch", when="@1.4+trilinos ^trilinos@14.0.0")
conflicts("~serial", when="+trilinos")
def cmake_args(self):
spec = self.spec
if "+trilinos" in spec:
kokkos_spec = spec["trilinos"]
else:
kokkos_spec = spec["kokkos"]
options = [
f"-DKokkos_ROOT={kokkos_spec.prefix}",
self.define_from_variant("ARBORX_ENABLE_MPI", "mpi"),
]
if spec.satisfies("+cuda"):
options.append(f"-DCMAKE_CXX_COMPILER={kokkos_spec.kokkos_cxx}")
if spec.satisfies("+rocm"):
options.append("-DCMAKE_CXX_COMPILER=%s" % spec["hip"].hipcc)
return options
examples_src_dir = "examples"
@run_after("install")
def setup_build_tests(self):
"""Copy the example source files after the package is installed to an
install test subdirectory for use during `spack test run`."""
cache_extra_test_sources(self, [self.examples_src_dir])
@property
def cached_tests_work_dir(self):
"""The working directory for cached test sources."""
return join_path(self.test_suite.current_test_cache_dir, self.examples_src_dir)
def test_run_ctest(self):
"""run ctest tests on the installed package"""
cmake_args = [
".",
cmake_prefix_path,
f"-DCMAKE_CXX_COMPILER={os.environ['CXX']}",
self.define(
"Kokkos_ROOT",
(
self.spec["kokkos"].prefix
if "~trilinos" in self.spec
else self.spec["trilinos"].prefix
),
),
self.define("ArborX_ROOT", self.spec["arborx".prefix]),
]
if self.spec.satisfies("+mpi"):
cmake_args.append(self.define("MPI_HOME", self.spec["mpi"].prefix))
cmake = which(self.spec["cmake"].prefix.bin.cmake)
make = which("make")
ctest = which("ctest")
with working_dir(self.cached_tests_work_dir):
cmake(*cmake_args)
make()
ctest("-V")