2 # This file is part of the GROMACS molecular simulation package.
4 # Copyright (c) 2020, by the GROMACS development team, led by
5 # Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6 # and including many others, as listed in the AUTHORS file in the
7 # top-level source directory and at http://www.gromacs.org.
9 # GROMACS is free software; you can redistribute it and/or
10 # modify it under the terms of the GNU Lesser General Public License
11 # as published by the Free Software Foundation; either version 2.1
12 # of the License, or (at your option) any later version.
14 # GROMACS is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 # Lesser General Public License for more details.
19 # You should have received a copy of the GNU Lesser General Public
20 # License along with GROMACS; if not, see
21 # http://www.gnu.org/licenses, or write to the Free Software Foundation,
22 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 # If you want to redistribute modifications to GROMACS, please
25 # consider that scientific software is very special. Version
26 # control is crucial - bugs must be traceable. We will be happy to
27 # consider code for inclusion in the official distribution, but
28 # derived work must not be called official GROMACS. Details are found
29 # in the README & COPYING files - if they are missing, get the
30 # official version at http://www.gromacs.org.
32 # To help us fund GROMACS development, we humbly ask that you cite
33 # the research papers on the package. Check out http://www.gromacs.org.
35 """A `utility` module helps manage the matrix of configurations for CI testing and build containers.
37 Provides importable argument parser.
40 * Paul Bauer <paul.bauer.q@gmail.com>
41 * Eric Irrgang <ericirrgang@gmail.com>
42 * Joe Jordan <e.jjordan12@gmail.com>
49 parser = argparse.ArgumentParser(description='GROMACS CI image slug options.', add_help=False)
50 """A parent parser for tools referencing image parameters.
52 This argparse parser is defined for convenience and may be used to partially initialize
55 .. warning:: Do not modify this parser.
57 Instead, inherit from it with the *parents* argument to :py:class:`argparse.ArgumentParser`
60 # TODO: Try using distutils.version.StrictVersion.
61 parser.add_argument('--cmake', type=str, default='3.13.0',
62 choices=['3.9.6', '3.11.4', '3.13.0', '3.14.7', '3.15.7', '3.16.6', '3.17.2'],
63 help='Selection of CMake version to provide to base image')
64 compiler_group = parser.add_mutually_exclusive_group()
65 compiler_group.add_argument('--gcc', type=int, nargs='?', const=7, default=7,
66 choices=[5, 6, 7, 8, 9],
67 help='Select GNU compiler tool chain. (Default) '
68 'Some checking is implemented to avoid incompatible combinations')
69 compiler_group.add_argument('--llvm', type=str, nargs='?', const='7', default=None,
70 choices=['3.6', '6', '7', '8', '9'],
71 help='Select LLVM compiler tool chain. '
72 'Some checking is implemented to avoid incompatible combinations')
73 compiler_group.add_argument('--icc', type=int, nargs='?', const=19, default=None,
75 help='Select Intel compiler tool chain. '
76 'Some checking is implemented to avoid incompatible combinations')
78 linux_group = parser.add_mutually_exclusive_group()
79 linux_group.add_argument('--ubuntu', type=str, nargs='?', const='18.04', default='20.04',
80 choices=['16.04', '18.04', '20.04'],
81 help='Select Ubuntu Linux base image. (default: ubuntu 20.04)')
82 linux_group.add_argument('--centos', type=str, nargs='?', const='7', default=None,
84 help='Select Centos Linux base image.')
86 parser.add_argument('--cuda', type=str, nargs='?', const='10.2', default=None,
87 choices=['9.0', '10.0', '10.1', '10.2', '11.0'],
88 help='Select a CUDA version for a base Linux image from NVIDIA.')
90 parser.add_argument('--mpi', type=str, nargs='?', const='openmpi', default=None,
91 choices=['openmpi', 'impi'],
92 help='Enable MPI (default disabled) and optionally select distribution (default: openmpi)')
94 parser.add_argument('--tsan', type=str, nargs='?', const='llvm', default=None,
96 help='Build special compiler versions with TSAN OpenMP support')
98 parser.add_argument('--opencl', type=str, nargs='?', const='nvidia', default=None,
99 choices=['nvidia', 'intel', 'amd'],
100 help='Provide environment for OpenCL builds')
102 parser.add_argument('--clfft', type=str, nargs='?', const='master', default=None,
103 choices=['master', 'develop'],
104 help='Add external clFFT libraries to the build image')
106 parser.add_argument('--doxygen', type=str, nargs='?', const='1.8.5', default=None,
107 help='Add doxygen environment for documentation builds. Also adds other requirements needed for final docs images.')