octopus: update to 11.4 and add tests (#30321)

* octopus: adding versions up to 11.4

* octopus: add smoke tests

* octopus: add necessary flags for gcc@10

* octopus: update to compilation and dependencies

* octopus: adding new variants

* octopus: remove 'poke' (as this poke is not in spack [yet])

* octopus: allow compilation from git repo develop branch

* octopus: adapt to spack style requirements

* octopus: add maintainer

* octopus: make tests after install optional

Thank you @tldahlgren

* octopus: follow recommended practice for test input data

Move the two configuration files we use for smoke tests into `test`
subdirectory. Thanks @tldahlgren.

* Adding maintainer

with their agreement by email

* octopus: reduce duplication of flags

- part of code review

* octopus: https is preferred over http

* octopus: remove .99 from versioning information

Thanks to https://github.com/spack/spack/pull/26402, we can drop the
"2:3.99" notation when we mean all versions 2.x and 3.x

Examples: b9e72557e8 (diff-b8373d30b3a141c495c2281273ee6184fc513413142afaf2adac1f406cd6b0d7)

(from review)

* octopus: args.extend([x]) -> args.append(x)

(hint from review)
This commit is contained in:
Hans Fangohr 2022-05-05 17:33:16 +02:00 committed by GitHub
parent e88396e5ed
commit 9a33121859
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 245 additions and 30 deletions

View File

@ -3,6 +3,8 @@
#
# SPDX-License-Identifier: (Apache-2.0 OR MIT)
import os
import llnl.util.tty as tty
from spack import *
@ -13,14 +15,26 @@ class Octopus(Package, CudaPackage):
theory code."""
homepage = "https://octopus-code.org/"
url = "http://octopus-code.org/down.php?file=6.0/octopus-6.0.tar.gz"
url = "https://octopus-code.org/down.php?file=6.0/octopus-6.0.tar.gz"
git = "https://gitlab.com/octopus-code/octopus"
maintainers = ['fangohr', 'RemiLacroix-IDRIS']
version('11.4', sha256='73bb872bff8165ddd8efc5b891f767cb3fe575b5a4b518416c834450a4492da7')
version('11.3', sha256='0c98417071b5e38ba6cbdd409adf917837c387a010e321c0a7f94d9bd9478930')
version('11.1', sha256='d943cc2419ca409dda7459b7622987029f2af89984d0d5f39a6b464c3fc266da')
version('10.5', sha256='deb92e3491b0c6ac5736960d075b44cab466f528b69715ed44968ecfe2953ec4')
version('10.4', sha256='4de9dc6f5815a45e43320e4abc7ef3e501e34bc327441376ea20ca1a992bdb72')
version('10.3', sha256='4633490e21593b51b60a8391b8aa0ed17fa52a3a0030630de123b67a41f88b33')
version('10.2', sha256='393e2ba7b18af1b736ad6deb339ba0cef18c6417671da7a6f1fcc3a5d8f7586b')
version('10.1', sha256='b6a660a99ed593c1d491e2d11cfff9ce87f0d80d527d9ff47fd983533d45adc6')
version('10.0', sha256='ccf62200e3f37911bfff6d127ebe74220996e9c09383a10b1420c81d931dcf23')
version('7.3', sha256='ad843d49d4beeed63e8b9a2ca6bfb2f4c5a421f13a4f66dc7b02f6d6a5c4d742')
version('6.0', sha256='4a802ee86c1e06846aa7fa317bd2216c6170871632c9e03d020d7970a08a8198')
version('5.0.1', sha256='3423049729e03f25512b1b315d9d62691cd0a6bd2722c7373a61d51bfbee14e0')
version('develop', branch='develop')
variant('scalapack', default=False,
description='Compile with Scalapack')
variant('metis', default=False,
@ -31,26 +45,62 @@ class Octopus(Package, CudaPackage):
description='Compile with Netcdf')
variant('arpack', default=False,
description='Compile with ARPACK')
variant('cgal', default=False,
description='Compile with CGAL library support')
variant('pfft', default=False,
description='Compile with PFFT')
# poke here refers to https://gitlab.e-cam2020.eu/esl/poke
# variant('poke', default=False,
# description='Compile with poke (not available in spack yet)')
variant('python', default=False,
description='Activates Python support')
variant('likwid', default=False,
description='Compile with likwid')
variant('libvdwxc', default=False,
description='Compile with libvdwxc')
variant('libyaml', default=False,
description='Compile with libyaml')
variant('elpa', default=False,
description='Compile with ELPA')
variant('nlopt', default=False,
description='Compile with nlopt')
variant('debug', default=False,
description='Compile with debug flags')
depends_on('autoconf', type='build')
depends_on('automake', type='build')
depends_on('libtool', type='build')
depends_on('m4', type='build')
depends_on('blas')
depends_on('gsl@1.9:')
depends_on('lapack')
depends_on('libxc@2.0:2', when='@:5')
depends_on('libxc@2.0:3', when='@6:7')
depends_on('libxc@2.0:4', when='@8:9')
depends_on('libxc@3:5.0.0', when='@10:')
depends_on('libxc@2:2', when='@:5')
depends_on('libxc@2:3', when='@6:7')
depends_on('libxc@2:4', when='@8:9')
depends_on('libxc@5.1.0:', when='@10:')
depends_on('libxc@5.1.0:', when='@develop')
depends_on('mpi')
depends_on('fftw@3:+mpi+openmp', when='@8:9')
depends_on('fftw-api@3:', when='@10:')
depends_on('metis@5:', when='+metis')
depends_on('parmetis', when='+parmetis')
depends_on('fftw-api@3:+mpi+openmp', when='@10:')
depends_on('py-numpy', when='+python')
depends_on('py-mpi4py', when='+python')
depends_on('metis@5:+int64', when='+metis')
depends_on('parmetis+int64', when='+parmetis')
depends_on('scalapack', when='+scalapack')
depends_on('netcdf-fortran', when='+netcdf')
depends_on('arpack-ng', when='+arpack')
depends_on('cgal', when='+cgal')
depends_on('pfft', when='+pfft')
depends_on('likwid', when='+likwid')
depends_on('libvdwxc', when='+libvdwxc')
depends_on('libyaml', when='+libyaml')
depends_on('elpa', when='+elpa')
depends_on('nlopt', when='+nlopt')
# optional dependencies:
# TODO: etsf-io, sparskit,
# feast, libfm, pfft, isf, pnfft
# feast, libfm, pfft, isf, pnfft, poke
def install(self, spec, prefix):
lapack = spec['lapack'].libs
@ -65,19 +115,20 @@ def install(self, spec, prefix):
'CC=%s' % spec['mpi'].mpicc,
'FC=%s' % spec['mpi'].mpifc,
'--enable-mpi',
'--enable-openmp',
])
if '^fftw' in spec:
args.extend([
'--with-fftw-prefix=%s' % spec['fftw'].prefix,
])
args.append(
'--with-fftw-prefix=%s' % spec['fftw'].prefix
)
elif '^mkl' in spec:
# As of version 10.0, Octopus depends on fftw-api instead
# of FFTW. If FFTW is not in the dependency tree, then
# it ought to be MKL as it is currently the only providers
# available for fftw-api.
args.extend([
args.append(
'FCFLAGS_FFTW=-I%s' % spec['mkl'].prefix.include.fftw
])
)
else:
# To be foolproof, fail with a proper error message
# if neither FFTW nor MKL are in the dependency tree.
@ -85,13 +136,13 @@ def install(self, spec, prefix):
'currently only FFTW and MKL are supported.\n'
"Please report this issue on Spack's repository.")
if '+metis' in spec:
args.extend([
'--with-metis-prefix=%s' % spec['metis'].prefix,
])
args.append(
'--with-metis-prefix=%s' % spec['metis'].prefix
)
if '+parmetis' in spec:
args.extend([
'--with-parmetis-prefix=%s' % spec['parmetis'].prefix,
])
args.append(
'--with-parmetis-prefix=%s' % spec['parmetis'].prefix
)
if '+netcdf' in spec:
args.extend([
'--with-netcdf-prefix=%s' % spec['netcdf-fortran'].prefix,
@ -100,13 +151,13 @@ def install(self, spec, prefix):
])
if '+arpack' in spec:
arpack_libs = spec['arpack-ng'].libs.joined()
args.extend([
args.append(
'--with-arpack={0}'.format(arpack_libs),
])
)
if '+mpi' in spec['arpack-ng']:
args.extend([
'--with-parpack={0}'.format(arpack_libs),
])
args.append(
'--with-parpack={0}'.format(arpack_libs)
)
if '+scalapack' in spec:
args.extend([
@ -114,10 +165,53 @@ def install(self, spec, prefix):
'--with-scalapack=%s' % spec['scalapack'].libs
])
if '+cgal' in spec:
args.append(
'--with-cgal-prefix=%s' % spec['cgal'].prefix
)
if '+likwid' in spec:
args.append(
'--with-likwid-prefix=%s' % spec['likwid'].prefix
)
if '+pfft' in spec:
args.append(
'--with-pfft-prefix=%s' % spec['pfft'].prefix,
)
# if '+poke' in spec:
# args.extend([
# '--with-poke-prefix=%s' % spec['poke'].prefix,
# ])
if '+libvdwxc' in spec:
args.append(
'--with-libvdwxc-prefix=%s' % spec['libvdwxc'].prefix
)
if '+libyaml' in spec:
args.append(
'--with-libyaml-prefix=%s' % spec['libyaml'].prefix
)
if '+elpa' in spec:
args.append(
'--with-elpa-prefix=%s' % spec['elpa'].prefix
)
if '+nlopt' in spec:
args.append(
'--with-nlopt-prefix=%s' % spec['nlopt'].prefix
)
if '+cuda' in spec:
args.extend([
args.append(
'--enable-cuda'
])
)
if '+python' in spec:
args.append('--enable-python')
# --with-etsf-io-prefix=
# --with-sparskit=${prefix}/lib/libskit.a
@ -134,12 +228,112 @@ def install(self, spec, prefix):
if (spec.satisfies('%apple-clang') or
spec.satisfies('%clang') or
spec.satisfies('%gcc')):
args.extend([
'FCFLAGS=-O2 -ffree-line-length-none'
])
# In case of GCC version 10, we will have errors because of
# argument mismatching. Need to provide a flag to turn this into a
# warning and build sucessfully
fcflags = 'FCFLAGS=-O2 -ffree-line-length-none'
fflags = 'FFLAGS=O2 -ffree-line-length-none'
if (spec.satisfies('%gcc@10:')):
gcc10_extra = '-fallow-argument-mismatch -fallow-invalid-boz'
args.append(fcflags + ' ' + gcc10_extra)
args.append(fflags + ' ' + gcc10_extra)
else:
args.append(fcflags)
args.append(fflags)
autoreconf('-i')
configure(*args)
make()
# short tests take forever...
# make('check-short')
make('install')
@run_after('install')
@on_package_attributes(run_tests=True)
def smoke_tests_after_install(self):
"""Function stub to run tests after install if desired
(for example through `spack install --test=root octopus`)
"""
self.smoke_tests()
def test(self):
"""Entry point for smoke tests run through `spack test run octopus`.
"""
self.smoke_tests()
def smoke_tests(self):
"""Actual smoke tests for Octopus."""
#
# run "octopus --version"
#
exe = join_path(self.spec.prefix.bin, "octopus")
options = ["--version"]
purpose = "Check octopus can execute (--version)"
# Example output:
#
# spack-v0.17.2$ octopus --version
# octopus 11.3 (git commit )
expected = ["octopus "]
self.run_test(
exe,
options=options,
expected=expected,
status=[0],
installed=False,
purpose=purpose,
skip_missing=False)
# Octopus expects a file with name `inp` in the current working
# directory to read configuration information for a simulation run from
# that file. We copy the relevant configuration file in a dedicated
# subfolder for each test.
#
# As we like to be able to run these tests also with the
# `spack install --test=root` command, we cannot rely on
# self.test_suite.current_test_data_dir, and need to copy the test
# input files manually (see below).
#
# run recipe example
#
expected = ["Running octopus", "CalculationMode = recipe",
"DISCLAIMER: The authors do not "
"guarantee that the implementation",
'recipe leads to an edible dish, '
'for it is clearly "system-dependent".',
"Calculation ended on"]
options = []
purpose = "Run Octopus recipe example"
with working_dir("example-recipe", create=True):
print("Current working directory (in example-recipe)")
copy(join_path(os.path.dirname(__file__), "test", "recipe.inp"), "inp")
self.run_test(exe,
options=options,
expected=expected,
status=[0],
installed=False,
purpose=purpose,
skip_missing=False)
#
# run He example
#
expected = ["Running octopus", "Info: Starting calculation mode.",
"CalculationMode = gs",
'''Species "helium" is a user-defined potential.''',
"Info: Writing states.", "Calculation ended on"]
options = []
purpose = "Run tiny calculation for He"
with working_dir("example-he", create=True):
print("Current working directory (in example-he)")
copy(join_path(os.path.dirname(__file__), "test", "he.inp"), "inp")
self.run_test(exe,
options=options,
expected=expected,
status=[0],
installed=False,
purpose=purpose,
skip_missing=False)

View File

@ -0,0 +1,20 @@
CalculationMode = gs
Dimensions = 2
TheoryLevel = independent_particles
BoxShape = parallelepiped
Lsize = 8
Spacing = 0.1
%Output
wfs | plane_z
%
%Species
"helium" | species_user_defined | potential_formula | "-2/(1+x^2)^(1/2)-2/(1+y^2)^(1/2)+1/(1+(x-y)^2)^(1/2)" | valence | 1
%
%Coordinates
"helium"| 0 | 0
%

View File

@ -0,0 +1 @@
CalculationMode = recipe