2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 2014,2015, 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.
37 * Declares functions to get basic version information.
39 * \author Teemu Murtola <teemu.murtola@gmail.com>
41 * \ingroup module_utility
43 #ifndef GMX_UTILITY_BASEVERSION_H
44 #define GMX_UTILITY_BASEVERSION_H
47 * Version string, containing the version, date, and abbreviated hash.
49 * This can be a plain version if git version info was disabled during the
51 * The returned string starts with a literal word `VERSION`.
53 * \ingroup module_utility
55 const char *gmx_version(void);
57 * Full git hash of the latest commit.
59 * If git version info was disabled during the build, returns an empty string.
61 * \ingroup module_utility
63 const char *gmx_version_git_full_hash(void);
65 * Full git hash of the latest commit in a central \Gromacs repository.
67 * If git version info was disabled during the build, returns an empty string.
68 * Also, if the latest commit was from a central repository, the return value
71 * \ingroup module_utility
73 const char *gmx_version_git_central_base_hash(void);
76 * Defined if ``libgromacs`` has been compiled in double precision.
78 * Allows detecting the compiled precision of the library through checking the
79 * presence of the symbol, e.g., from autoconf or other types of build systems.
81 * \ingroup module_utility
83 void gmx_is_double_precision();
85 * Defined if ``libgromacs`` has been compiled in single/mixed precision.
87 * Allows detecting the compiled precision of the library through checking the
88 * presence of the symbol, e.g., from autoconf or other types of build systems.
90 * \ingroup module_utility
93 void gmx_is_single_precision();
95 /*! \brief Return a string describing what kind of GPU suport was configured in the build. */
96 const char *getGpuImplementationString();