summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/openpmd-api/package.py
blob: 59198de454e688614e12a2eaf1b8e16a82ef11a4 (plain) (blame)
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
# 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 OpenpmdApi(CMakePackage):
    """C++ & Python API for Scientific I/O"""

    homepage = "https://www.openPMD.org"
    url = "https://github.com/openPMD/openPMD-api/archive/0.15.2.tar.gz"
    git = "https://github.com/openPMD/openPMD-api.git"

    maintainers("ax3l", "franzpoeschel")

    tags = ["e4s"]

    license("LGPL-3.0-only")

    # C++17 up until here
    version("develop", branch="dev")
    version("0.15.2", sha256="fbe3b356fe6f4589c659027c8056844692c62382e3ec53b953bed1c87e58ba13")
    version("0.15.1", sha256="0e81652152391ba4d2b62cfac95238b11233a4f89ff45e1fcffcc7bcd79dabe1")
    version("0.15.0", sha256="290e3a3c5814204ea6527d53423bfacf7a8dc490713227c9e0eaa3abf4756177")
    # C++14 up until here
    version("0.14.5", sha256="e3f509098e75014394877e0dc91f833e57ced5552b110c7339a69e9dbe49bf62")
    version("0.14.4", sha256="42b7bcd043e772d63f0fe0e5e70da411f001db10096d5b8be797ffc88e786379")
    version("0.14.3", sha256="57282455e0fb1873b4def1894fadadd6425dfc8349eac7fcc68daf677c48b7ce")
    version("0.14.2", sha256="25c6b4bcd0ae1ba668b633b8514e66c402da54901c26861fc754fca55717c836")
    version("0.14.1", sha256="172fd1d785627d01c77f1170adc5a18bd8a6302e804d0f271dc0d616a5156791")
    version("0.14.0", sha256="7bb561c1a6f54e9a6a1b56aaf1d4d098bbe290d204f84ebe5a6f11b3cab2be6e")
    version("0.13.4", sha256="46c013be5cda670f21969675ce839315d4f5ada0406a6546a91ec3441402cf5e")
    version("0.13.3", sha256="4b8f84bd89cd540c73ffe8c21085970453cb7f0e4f125f11a4e288433f64b58c")
    version("0.13.2", sha256="2e5170d41bb7b2c0608ec833eee7f9adf8175b46734743f6e46dcce6f6685fb0")
    version("0.13.1", sha256="81ff79419982eb1b0865d1736f73f950f5d4c356d3c78200ceeab7f54dc07fd7")
    version("0.13.0", sha256="97c2e43d80ee5c5288f278bd54f0dcb40e7f48a575b278fcef9660214b779bb0")
    # C++11 up until here
    version("0.12.0", tag="0.12.0-alpha", commit="23be484dd2570b5277779eafcc5f1eb70c6d98f2")
    version("0.11.1", tag="0.11.1-alpha", commit="c40292aafbf564807710424d106304f9670a8304")

    variant("shared", default=True, description="Build a shared version of the library")
    variant("mpi", default=True, description="Enable parallel I/O")
    variant("hdf5", default=True, description="Enable HDF5 support")
    variant("adios1", default=False, description="Enable ADIOS1 support")
    variant("adios2", default=True, description="Enable ADIOS2 support")
    variant("python", default=False, description="Enable Python bindings")

    depends_on("cmake@3.15.0:", type="build")
    depends_on("catch2@2.6.1:2", type="test")
    depends_on("catch2@2.13.4:2", type="test", when="@0.14.0:")
    depends_on("catch2@2.13.10:2", type="test", when="@0.15.0:")
    depends_on("mpi@2.3:", when="+mpi")  # might become MPI 3.0+
    depends_on("nlohmann-json@3.9.1:")
    depends_on("mpark-variant@1.4.0:", when="@:0.14")  # pre C++17 releases
    depends_on("toml11@3.7.1:", when="@0.15.0:")
    with when("+hdf5"):
        depends_on("hdf5@1.8.13:")
        depends_on("hdf5@1.8.13: ~mpi", when="~mpi")
        depends_on("hdf5@1.8.13: +mpi", when="+mpi")
    with when("+adios1"):
        depends_on("adios@1.13.1: ~sz")
        depends_on("adios@1.13.1: ~mpi ~sz", when="~mpi")
        depends_on("adios@1.13.1: +mpi ~sz", when="+mpi")
    with when("+adios2"):
        depends_on("adios2@2.5.0:")
        depends_on("adios2@2.6.0:", when="@0.12.0:")
        depends_on("adios2@2.7.0:", when="@0.14.0:")
        depends_on("adios2@2.5.0: ~mpi", when="~mpi")
        depends_on("adios2@2.5.0: +mpi", when="+mpi")
    with when("+python"):
        depends_on("py-pybind11@2.6.2:", type="link")
        depends_on("py-numpy@1.15.1:", type=["test", "run"])
        depends_on("py-mpi4py@2.1.0:", when="+mpi", type=["test", "run"])
        depends_on("python@3.7:", type=["link", "test", "run"])
        depends_on("python@3.8:", when="@0.15.2:", type=["link", "test", "run"])

    conflicts("^hdf5 api=v16", msg="openPMD-api requires HDF5 APIs for 1.8+")

    # Fix breaking HDF5 1.12.0 API when build with legacy api options
    # https://github.com/openPMD/openPMD-api/pull/1012
    patch("hdf5-1.12.0.patch", when="@:0.13 +hdf5")

    # CMake: Fix Python Install Directory
    patch(
        "https://github.com/openPMD/openPMD-api/pull/1393.patch?full_index=1",
        sha256="b5cecbdbe16d98c0ba352fa861fcdf9d7c7cc85f21226fa03effa7d62a7cb276",
        when="@0.15.0",
    )

    # macOS AppleClang12 Fixes
    patch(
        "https://github.com/openPMD/openPMD-api/pull/1395.patch?full_index=1",
        sha256="791c0a9d1dc09226beb26e8e67824b3337d95f4a2a6e7e64637ea8f0d95eee61",
        when="@0.15.0",
    )

    # forgot to bump version.hpp in 0.15.1
    patch(
        "https://github.com/openPMD/openPMD-api/pull/1417.patch?full_index=1",
        sha256="c306483f1f94b308775a401c9cd67ee549fac6824a2264f5985499849fe210d5",
        when="@0.15.1",
    )

    extends("python", when="+python")

    def cmake_args(self):
        spec = self.spec

        args = [
            self.define_from_variant("BUILD_SHARED_LIBS", "shared"),
            # variants
            self.define_from_variant("openPMD_USE_MPI", "mpi"),
            self.define_from_variant("openPMD_USE_HDF5", "hdf5"),
            self.define_from_variant("openPMD_USE_ADIOS1", "adios1"),
            self.define_from_variant("openPMD_USE_ADIOS2", "adios2"),
            self.define_from_variant("openPMD_USE_PYTHON", "python"),
            # tests and examples
            self.define("BUILD_TESTING", self.run_tests),
            self.define("BUILD_EXAMPLES", self.run_tests),
        ]

        # switch internally shipped third-party libraries for spack
        if spec.satisfies("+python"):
            py_exe_define = (
                "Python_EXECUTABLE" if spec.version >= Version("0.13.0") else "PYTHON_EXECUTABLE"
            )
            args += [
                self.define(py_exe_define, self.spec["python"].command.path),
                self.define("openPMD_USE_INTERNAL_PYBIND11", False),
            ]

        args.append(self.define("openPMD_USE_INTERNAL_JSON", False))
        if spec.satisfies("@:0.14"):  # pre C++17 releases
            args.append(self.define("openPMD_USE_INTERNAL_VARIANT", False))
        if spec.satisfies("@0.15:"):
            args.append(self.define("openPMD_USE_INTERNAL_TOML11", False))

        if self.run_tests:
            args.append(self.define("openPMD_USE_INTERNAL_CATCH", False))

        return args

    def setup_run_environment(self, env):
        spec = self.spec
        # pre-load dependent CMake-PUBLIC header-only libs
        if spec.satisfies("@:0.14"):  # pre C++17 releases
            env.prepend_path("CMAKE_PREFIX_PATH", spec["mpark-variant"].prefix)
            env.prepend_path("CPATH", spec["mpark-variant"].prefix.include)

        # more deps searched in openPMDConfig.cmake
        if spec.satisfies("+mpi"):
            env.prepend_path("CMAKE_PREFIX_PATH", spec["mpi"].prefix)
        if spec.satisfies("+adios1"):
            env.prepend_path("CMAKE_PREFIX_PATH", spec["adios"].prefix)
            env.prepend_path("PATH", spec["adios"].prefix.bin)  # adios-config
        if spec.satisfies("+adios2"):
            env.prepend_path("CMAKE_PREFIX_PATH", spec["adios2"].prefix)
        if spec.satisfies("+hdf5"):
            env.prepend_path("CMAKE_PREFIX_PATH", spec["hdf5"].prefix)

    def setup_dependent_build_environment(self, env, dependent_spec):
        spec = self.spec
        # pre-load dependent CMake-PUBLIC header-only libs
        if spec.satisfies("@:0.14"):  # pre C++17 releases
            env.prepend_path("CMAKE_PREFIX_PATH", spec["mpark-variant"].prefix)
            env.prepend_path("CPATH", spec["mpark-variant"].prefix.include)

    def check(self):
        """CTest checks after the build phase"""
        # note: for MPI-parallel tests, you can overwrite the standard CMake
        #       option -DMPIEXEC_EXECUTABLE=$(which jsrun) for jsrun or srun,
        #       etc.. Alternatively, you can also use -E <regex> to exclude
        #       parallel and MPI tests
        with working_dir(self.build_directory):
            # -j1 because individual tests create files that are read again by
            # later tests
            ctest("--output-on-failure", "-j1")

    def test(self):
        """Perform smoke tests on the installed package."""
        exes = ["openpmd-ls"]  # in 0.11.1+
        for exe in exes:
            spec_vers_str = "{0}".format(self.spec.version)
            reason = "test version of {0} is {1}".format(exe, spec_vers_str)
            self.run_test(
                exe,
                ["--version"],
                [spec_vers_str],
                installed=True,
                purpose=reason,
                skip_missing=False,
            )