1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
# Copyright 2013-2023 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)
from spack.package import *
class Warpx(CMakePackage):
"""WarpX is an advanced electromagnetic Particle-In-Cell code. It supports
many features including Perfectly-Matched Layers (PML) and mesh refinement.
In addition, WarpX is a highly-parallel and highly-optimized code and
features hybrid OpenMP/MPI parallelization, advanced vectorization
techniques and load balancing capabilities.
For WarpX' Python bindings and PICMI input support, see the 'py-warpx' package.
"""
homepage = "https://ecp-warpx.github.io"
url = "https://github.com/ECP-WarpX/WarpX/archive/refs/tags/23.08.tar.gz"
git = "https://github.com/ECP-WarpX/WarpX.git"
maintainers("ax3l", "dpgrote", "MaxThevenet", "RemiLehe")
tags = ["e4s", "ecp"]
license("BSD-3-Clause-LBNL")
# NOTE: if you update the versions here, also see py-warpx
version("develop", branch="development")
version("23.08", sha256="67695ff04b83d1823ea621c19488e54ebaf268532b0e5eb4ea8ad293d7ab3ddc")
version("23.07", sha256="511633f94c0d0205013609bde5bbf92a29c2e69f6e69b461b80d09dc25602945")
version("23.06", sha256="75fcac949220c44dce04de581860c9a2caa31a0eee8aa7d49455fa5fc928514b")
version("23.05", sha256="34306a98fdb1f5f44ab4fb92f35966bfccdcf1680a722aa773af2b59a3060d73")
version("23.04", sha256="e5b285c73e13a0d922eba5d83760c168d4fd388e54a519830003b2e692dab823")
version("23.03", sha256="e1274aaa2a2c83d599d61c6e4c426db4ed5d4c5dc61a2002715783a6c4843718")
version("23.02", sha256="a6c63ebc38cbd224422259a814be501ac79a3b734dab7f59500b6957cddaaac1")
version("23.01", sha256="e853d01c20ea00c8ddedfa82a31a11d9d91a7f418d37d7f064cf8a241ea4da0c")
version("22.12", sha256="96019902cd6ea444a1ae515e8853048e9074822c168021e4ec1687adc72ef062")
version("22.11", sha256="528f65958f2f9e60a094e54eede698e871ccefc89fa103fe2a6f22e4a059515e")
version("22.10", sha256="3cbbbbb4d79f806b15e81c3d0e4a4401d1d03d925154682a3060efebd3b6ca3e")
version("22.09", sha256="dbef1318248c86c860cc47f7e18bbb0397818e3acdfb459e48075004bdaedea3")
version("22.08", sha256="5ff7fd628e8bf615c1107e6c51bc55926f3ef2a076985444b889d292fecf56d4")
version("22.07", sha256="0286adc788136cb78033cb1678d38d36e42265bcfd3d0c361a9bcc2cfcdf241b")
version("22.06", sha256="e78398e215d3fc6bc5984f5d1c2ddeac290dcbc8a8e9d196e828ef6299187db9")
version("22.05", sha256="2fa69e6a4db36459b67bf663e8fbf56191f6c8c25dc76301dbd02a36f9b50479")
version("22.04", sha256="9234d12e28b323cb250d3d2cefee0b36246bd8a1d1eb48e386f41977251c028f")
version("22.03", sha256="ddbef760c8000f2f827dfb097ca3359e7aecbea8766bec5c3a91ee28d3641564")
version("22.02", sha256="d74b593d6f396e037970c5fbe10c2e5d71d557a99c97d40e4255226bc6c26e42")
version("22.01", sha256="e465ffadabb7dc360c63c4d3862dc08082b5b0e77923d3fb05570408748b0d28")
# 22.01+ requires C++17 or newer
version("21.12", sha256="847c98aac20c73d94c823378803c82be9a14139f1c14ea483757229b452ce4c1")
version("21.11", sha256="ce60377771c732033a77351cd3500b24b5d14b54a5adc7a622767b9251c10d0b")
version("21.10", sha256="d372c573f0360094d5982d64eceeb0149d6620eb75e8fdbfdc6777f3328fb454")
version("21.09", sha256="861a65f11846541c803564db133c8678b9e8779e69902ef1637b21399d257eab")
version("21.08", sha256="6128a32cfd075bc63d08eebea6d4f62d33ce0570f4fd72330a71023ceacccc86")
version("21.07", sha256="a8740316d813c365715f7471201499905798b50bd94950d33f1bd91478d49561")
version("21.06", sha256="a26039dc4061da45e779dd5002467c67a533fc08d30841e01e7abb3a890fbe30")
version("21.05", sha256="f835f0ae6c5702550d23191aa0bb0722f981abb1460410e3d8952bc3d945a9fc")
version("21.04", sha256="51d2d8b4542eada96216e8b128c0545c4b7527addc2038efebe586c32c4020a0")
# 20.01+ requires C++14 or newer
variant("app", default=True, description="Build the WarpX executable application")
variant("ascent", default=False, description="Enable Ascent in situ visualization")
variant("sensei", default=False, description="Enable SENSEI in situ visualization")
variant(
"compute",
default="omp",
values=("omp", "cuda", "hip", "sycl", "noacc"),
multi=False,
description="On-node, accelerated computing backend",
)
variant(
"dims",
default="3",
values=("1", "2", "3", "rz"),
multi=False,
description="Number of spatial dimensions",
when="@:23.05",
)
variant(
"dims",
default="1,2,rz,3",
values=("1", "2", "3", "rz"),
multi=True,
description="Number of spatial dimensions",
when="@23.06:",
)
variant("eb", default=False, description="Embedded boundary support (in development)")
variant("lib", default=True, description="Build WarpX as a shared library")
variant("mpi", default=True, description="Enable MPI support")
variant(
"mpithreadmultiple",
default=True,
description="MPI thread-multiple support, i.e. for async_io",
)
variant("openpmd", default=True, description="Enable openPMD I/O")
variant(
"precision",
default="double",
values=("single", "double"),
multi=False,
description="Floating point precision (single/double)",
)
variant("psatd", default=True, description="Enable PSATD solver support")
variant("qed", default=True, description="Enable QED support")
variant("qedtablegen", default=False, description="QED table generation support")
variant("shared", default=True, description="Build a shared version of the library")
variant("tprof", default=True, description="Enable tiny profiling features")
depends_on("sensei@4.0.0:", when="@22.07: +sensei")
conflicts("+sensei", when="@:22.06", msg="WarpX supports SENSEI 4.0+ with 22.07 and newer")
depends_on("ascent", when="+ascent")
depends_on("ascent +cuda", when="+ascent compute=cuda")
depends_on("ascent +mpi", when="+ascent +mpi")
depends_on("boost@1.66.0: +math", when="+qedtablegen")
depends_on("cmake@3.15.0:", type="build")
depends_on("cmake@3.18.0:", type="build", when="@22.01:")
depends_on("cmake@3.20.0:", type="build", when="@22.08:")
depends_on("mpi", when="+mpi")
with when("compute=cuda"):
depends_on("cuda@9.2.88:")
depends_on("cuda@11.0:", when="@22.01:")
with when("compute=hip"):
depends_on("rocfft", when="+psatd")
depends_on("rocprim")
depends_on("rocrand")
with when("compute=noacc"):
with when("+psatd"):
depends_on("fftw@3: ~mpi", when="~mpi")
depends_on("fftw@3: +mpi", when="+mpi")
depends_on("pkgconfig", type="build")
with when("compute=omp"):
depends_on("llvm-openmp", when="%apple-clang")
with when("+psatd"):
depends_on("fftw@3: +openmp")
depends_on("fftw ~mpi", when="~mpi")
depends_on("fftw +mpi", when="+mpi")
depends_on("pkgconfig", type="build")
with when("+psatd dims=rz"):
depends_on("lapackpp")
depends_on("blaspp")
depends_on("blaspp +cuda", when="compute=cuda")
with when("+openpmd"):
depends_on("openpmd-api@0.13.1:")
depends_on("openpmd-api@0.14.2:", when="@21.09:")
depends_on("openpmd-api ~mpi", when="~mpi")
depends_on("openpmd-api +mpi", when="+mpi")
conflicts("dims=1", when="@:21.12", msg="WarpX 1D support starts in 22.01+")
conflicts("~qed +qedtablegen", msg="WarpX PICSAR QED table generation needs +qed")
conflicts(
"compute=sycl",
when="+psatd",
msg="WarpX spectral solvers are not yet tested with SYCL " '(use "warpx ~psatd")',
)
# The symbolic aliases for our +lib target were missing in the install
# location
# https://github.com/ECP-WarpX/WarpX/pull/2626
patch(
"https://github.com/ECP-WarpX/WarpX/pull/2626.patch?full_index=1",
sha256="a431d4664049d6dcb6454166d6a948d8069322a111816ca5ce01553800607544",
when="@21.12",
)
# Workaround for AMReX<=22.06 no-MPI Gather
# https://github.com/ECP-WarpX/WarpX/pull/3134
# https://github.com/AMReX-Codes/amrex/pull/2793
patch(
"https://github.com/ECP-WarpX/WarpX/pull/3134.patch?full_index=1",
sha256="b786ce64a3c2c2b96ff2e635f0ee48532e4ae7ad9637dbf03f11c0768c290690",
when="@22.02:22.05",
)
# Forgot to install ABLASTR library
# https://github.com/ECP-WarpX/WarpX/pull/3141
patch(
"https://github.com/ECP-WarpX/WarpX/pull/3141.patch?full_index=1",
sha256="dab6fb44556ee1fd466a4cb0e20f89bde1ce445c9a51a2c0f59d1740863b5e7d",
when="@22.04,22.05",
)
# Fix failing 1D CUDA build
# https://github.com/ECP-WarpX/WarpX/pull/3162
patch(
"https://github.com/ECP-WarpX/WarpX/pull/3162.patch?full_index=1",
sha256="0ae573d1390ed8063f84e3402d30d34e522e65dc5dfeea3d07e165127ab373e9",
when="@22.06",
)
def cmake_args(self):
spec = self.spec
args = [
self.define_from_variant("BUILD_SHARED_LIBS", "shared"),
"-DCMAKE_INSTALL_LIBDIR=lib",
# variants
self.define_from_variant("WarpX_APP", "app"),
self.define_from_variant("WarpX_ASCENT", "ascent"),
self.define_from_variant("WarpX_SENSEI", "sensei"),
"-DWarpX_COMPUTE={0}".format(spec.variants["compute"].value.upper()),
"-DWarpX_DIMS={0}".format(";".join(spec.variants["dims"].value).upper()),
self.define_from_variant("WarpX_EB", "eb"),
self.define_from_variant("WarpX_LIB", "lib"),
self.define_from_variant("WarpX_MPI", "mpi"),
self.define_from_variant("WarpX_MPI_THREAD_MULTIPLE", "mpithreadmultiple"),
self.define_from_variant("WarpX_OPENPMD", "openpmd"),
"-DWarpX_PRECISION={0}".format(spec.variants["precision"].value.upper()),
self.define_from_variant("WarpX_PSATD", "psatd"),
self.define_from_variant("WarpX_QED", "qed"),
self.define_from_variant("WarpX_QED_TABLE_GEN", "qedtablegen"),
]
# FindMPI needs an extra hint sometimes, particularly on cray systems
if "+mpi" in spec:
args.append(self.define("MPI_C_COMPILER", spec["mpi"].mpicc))
args.append(self.define("MPI_CXX_COMPILER", spec["mpi"].mpicxx))
if "+openpmd" in spec:
args.append("-DWarpX_openpmd_internal=OFF")
# Work-around for SENSEI 4.0: wrong install location for CMake config
# https://github.com/SENSEI-insitu/SENSEI/issues/79
if "+sensei" in spec:
args.append(self.define("SENSEI_DIR", spec["sensei"].prefix.lib.cmake))
return args
@property
def libs(self):
libsuffix = {"1": "1d", "2": "2d", "3": "3d", "rz": "rz"}
libs = []
for dim in self.spec.variants["dims"].value:
libs += find_libraries(
["libwarpx." + libsuffix[dim]], root=self.prefix, recursive=True, shared=True
)
libs += find_libraries(
["libablastr"],
root=self.prefix,
recursive=True,
shared=self.spec.variants["shared"],
)
return libs
# WarpX has many examples to serve as a suitable smoke check. One
# that is typical was chosen here
examples_src_dir = "Examples/Physics_applications/laser_acceleration/"
def _get_input_options(self, dim, post_install):
spec = self.spec
examples_dir = join_path(
self.install_test_root if post_install else self.stage.source_path,
self.examples_src_dir,
)
inputs_nD = {"1": "inputs_1d", "2": "inputs_2d", "3": "inputs_3d", "rz": "inputs_rz"}
if spec.satisfies("@:21.12"):
inputs_nD["rz"] = "inputs_2d_rz"
inputs = join_path(examples_dir, inputs_nD[dim])
cli_args = [inputs, "max_step=50", "diag1.intervals=10"]
# test openPMD output if compiled in
if "+openpmd" in spec:
cli_args.append("diag1.format=openpmd")
# RZ: New openPMD thetaMode output
if dim == "rz" and spec.satisfies("@22.04:"):
cli_args.append("diag1.fields_to_plot=Er Et Ez Br Bt Bz jr jt jz rho")
return cli_args
def check(self):
"""Checks after the build phase"""
spec = self.spec
if "+app" not in spec:
print("WarpX check skipped: requires variant +app")
return
with working_dir("spack-check", create=True):
for dim in spec.variants["dims"].value:
cli_args = self._get_input_options(dim, False)
exe_nD = {"1": "warpx.1d", "2": "warpx.2d", "3": "warpx.3d", "rz": "warpx.rz"}
warpx = Executable(join_path(self.build_directory, "bin/" + exe_nD[dim]))
warpx(*cli_args)
@run_after("install")
def copy_test_sources(self):
"""Copy the example input files after the package is installed to an
install test subdirectory for use during `spack test run`."""
self.cache_extra_test_sources([self.examples_src_dir])
def test(self):
"""Perform smoke tests on the installed package."""
if "+app" not in self.spec:
print("WarpX smoke tests skipped: requires variant +app")
return
# our executable names are a variant-dependent and naming evolves
for dim in self.spec.variants["dims"].value:
exe_nD = {"1": "warpx.1d", "2": "warpx.2d", "3": "warpx.3d", "rz": "warpx.rz"}
exe = find(self.prefix.bin, exe_nD[dim] + ".*", recursive=False)[0]
cli_args = self._get_input_options(dim, True)
self.run_test(
exe,
cli_args,
[],
installed=True,
purpose="Smoke test for WarpX",
skip_missing=False,
)
|
