summaryrefslogtreecommitdiff
path: root/var/spack/repos/builtin/packages/yambo/package.py
blob: 8ff7e500a57ca8874ddc8b68e423326a851405bb (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
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
# 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 shutil

from spack.package import *


class Yambo(AutotoolsPackage):
    """Yambo is a FORTRAN/C code for Many-Body calculations in solid
    state and molecular physics.

    Yambo relies on the Kohn-Sham wavefunctions generated by two DFT
    public codes: abinit, and PWscf. The code was originally developed
    in the Condensed Matter Theoretical Group of the Physics Department
    at the University of Rome "Tor Vergata" by Andrea Marini. Previous
    to its release under the GPL license, yambo was known as SELF.
    """

    homepage = "https://www.yambo-code.org/index.php"
    url = "https://github.com/yambo-code/yambo/archive/4.2.2.tar.gz"

    maintainers("LydDeb")

    license("GPL-2.0-or-later")

    version("5.2.4", sha256="7c3f2602389fc29a0d8570c2fe85fe3768d390cfcbb2d371e83e75c6c951d5fc")
    version("5.2.3", sha256="a6168d1fa820af857ac51217bd6ad26dda4cc89c07e035bd7dc230038ae1ab9c")
    version("5.2.1", sha256="0ac362854313927d75bbf87be98ff58447f3805f79724c38dc79df07f03a7046")
    version("5.1.1", sha256="c85036ca60507e627c47b6c6aee8241830349e88110e1ce9132ef03ab2c4e9f6")
    version("4.2.2", sha256="86b4ebe679387233266aba49948246c85a32b1e6840d024f162962bd0112448c")
    version("4.2.1", sha256="8ccd0ca75cc32d9266d4a37edd2a7396cf5038f3a68be07c0f0f77d1afc72bdc")
    version("4.2.0", sha256="9f78c4237ff363ff4e9ea5eeea671b6fff783d9a6078cc31b0b1abeb1f040f4d")

    depends_on("c", type="build")  # generated
    depends_on("fortran", type="build")  # generated

    variant("dp", default=False, description="Enable double precision")
    variant(
        "profile",
        values=any_combination_of("time", "memory"),
        description="Activate profiling of specific sections",
    )
    variant(
        "io",
        default="iotk",
        values=("iotk", "etsf-io"),
        multi=True,
        description="Activate support for different io formats (requires network access)",
    )
    # MPI + OpenMP parallelism
    variant("mpi", default=True, description="Enable MPI support")
    variant("openmp", default=False, description="Enable OpenMP support")

    depends_on("blas")
    depends_on("lapack")

    # MPI dependencies are forced, until we have proper forwarding of variants
    #
    # Note that yambo is used as an application, and not linked as a library,
    # thus there will be no case where another package pulls-in e.g.
    # netcdf-c+mpi and wants to depend on yambo~mpi.
    depends_on("mpi", when="+mpi")
    depends_on("netcdf-c+mpi", when="+mpi")
    depends_on("hdf5+mpi", when="+mpi")
    depends_on("fftw+mpi", when="+mpi")
    depends_on("scalapack", when="+mpi")

    depends_on("netcdf-c~mpi", when="~mpi")
    depends_on("hdf5~mpi", when="~mpi")
    depends_on("fftw~mpi", when="~mpi")

    depends_on("hdf5+fortran")
    depends_on("netcdf-c")
    depends_on("netcdf-fortran")
    depends_on("libxc@2.0.3:")

    depends_on("etsf-io", when="io=etsf-io")

    build_targets = ["all"]

    parallel = False

    sanity_check_is_file = ["bin/yambo"]

    resource(
        when="@5.2.4",
        name="ydriver",
        url="https://github.com/yambo-code/Ydriver/archive/refs/tags/1.4.2.tar.gz",
        sha256="c242f0700a224325ff59326767614a561b02ce16ddb2ce6c13ddd2d5901cc3e4",
        destination="ydriver_archive",
        placement="archive",
        expand=False,
    )
    resource(
        when="@5.2.1:5.2.3",
        name="ydriver",
        url="https://github.com/yambo-code/Ydriver/archive/refs/tags/1.2.0.tar.gz",
        sha256="0f29a44e9c4b49d3f6be3f159a7ef415932b2ae2f2fdba163af60a0673befe6e",
        destination="ydriver_archive",
        placement="archive",
        expand=False,
    )
    # iotk archive is contained inside this git repository
    resource(
        when="@5.2",
        name="iotk",
        git="https://github.com/yambo-code/yambo-libraries.git",
        destination="yambo_libraries",
        expand=False,
    )

    # ydriver-1.1.0 is required by yambo 5.1.1 but the oldest release in
    # https://github.com/yambo-code/Ydriver is 1.2.0
    # So, the air-gapped installation is only available since yambo@5.2.1
    @when("@5.2")
    @run_before("autoreconf")
    def setup_archives(self):
        if self.spec.satisfies("@5.2.4"):
            shutil.move("ydriver_archive/archive/1.4.2.tar.gz", "lib/archive/Ydriver-1.4.2.tar.gz")
        if self.spec.satisfies("@5.2.1:5.2.3"):
            shutil.move("ydriver_archive/archive/1.2.0.tar.gz", "lib/archive/Ydriver-1.2.0.tar.gz")
        shutil.move(
            "yambo_libraries/yambo-libraries/external/iotk-y1.2.2.tar.gz",
            "lib/archive/iotk-y1.2.2.tar.gz",
        )
        shutil.rmtree("ydriver_archive")
        shutil.rmtree("yambo_libraries")

    def enable_or_disable_time(self, activated):
        return "--enable-time-profile" if activated else "--disable-time-profile"

    def enable_or_disable_memory(self, activated):
        return "--enable-memory-profile" if activated else "--disable-memory-profile"

    def enable_or_disable_openmp(self, activated):
        return "--enable-open-mp" if activated else "--disable-open-mp"

    @when("@5")
    def configure_args(self):
        spec = self.spec
        args = [
            f"--with-hdf5-path={spec['hdf5'].prefix}",
            f"--prefix={self.stage.source_path}",
            f"--exec-prefix={self.stage.source_path}",
        ]
        # Double precision
        args.extend(self.enable_or_disable("dp"))

        # Application profiling
        args.extend(self.enable_or_disable("profile"))

        # MPI + threading
        args.extend(self.enable_or_disable("mpi"))
        args.extend(self.enable_or_disable("openmp"))

        if spec.satisfies("+mpi"):
            args.append(f"--with-scalapack-libs={spec['scalapack'].libs}")

        args.append(f"--with-blas-libs={spec['blas'].libs}")
        args.append(f"--with-lapack-libs={spec['lapack'].libs}")
        args.append(f"--with-netcdf-path={spec['netcdf-c'].prefix}")
        args.append(f"--with-netcdff-path={spec['netcdf-fortran'].prefix}")
        args.append(f"--with-fft-path={spec['fftw'].prefix}")
        args.append(f"--with-libxc-path={spec['libxc'].prefix}")
        args.append("--enable-hdf5-p2y-support")
        # IO
        if spec.satisfies("io=etsf-io"):
            args.append(f"--with-etsf-io-path={spec['etsf-io'].prefix}")
        args.extend(self.enable_or_disable("io"))

        return args

    # The configure in the package has the string 'cat config/report'
    # hard-coded, which causes a failure at configure time due to the
    # current working directory in Spack. Fix this by using the absolute
    # path to the file.
    @when("@4.2.1")
    @run_before("configure")
    def filter_configure(self):
        report_abspath = join_path(self.build_directory, "config", "report")
        filter_file("config/report", report_abspath, "configure")

    @when("@4.2.1")
    def configure_args(self):
        args = [
            # As of version 4.2.1 there are hard-coded paths that make
            # the build process fail if the target prefix is not the
            # configure directory
            f"--prefix={self.stage.source_path}",
            "--disable-keep-objects",
            "--with-editor=none",
        ]
        spec = self.spec

        # Double precision
        args.extend(self.enable_or_disable("dp"))

        # Application profiling
        args.extend(self.enable_or_disable("profile"))

        # MPI + threading
        args.extend(self.enable_or_disable("mpi"))
        args.extend(self.enable_or_disable("openmp"))

        # LAPACK
        if spec.satisfies("+mpi"):
            args.append(
                "--with-scalapack-libs={0}".format(
                    spec["scalapack"].libs + spec["lapack"].libs + spec["blas"].libs
                )
            )

        args.extend(
            [f"--with-blas-libs={spec['blas'].libs}", f"--with-lapack-libs={spec['lapack'].libs}"]
        )

        # Netcdf
        args.extend(
            [
                "--enable-netcdf-hdf5",
                "--enable-hdf5-compression",
                f"--with-hdf5-libs={spec['hdf5'].libs}",
                f"--with-netcdf-path={spec['netcdf-c'].prefix}",
                f"--with-netcdff-path={spec['netcdf-fortran'].prefix}",
            ]
        )

        args.extend(self.enable_or_disable("io"))

        # Other dependencies
        args.append(f"--with-fft-path={spec['fftw'].prefix}")
        args.append(f"--with-libxc-path={spec['libxc'].prefix}")

        return args

    def install(self, spec, prefix):
        # As of version 4.2.1 an 'install' target is advertized,
        # but not present
        install_tree("bin", prefix.bin)
        install_tree("lib", prefix.lib)
        install_tree("include", prefix.include)
        install_tree("driver", prefix.driver)