src/gromacs/utility/baseversion.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 2014,2015,2018,2019,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.
   8  *
   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.
  13  *
  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.
  18  *
  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.
  23  *
  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.
  31  *
  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.
  34  */
  35 /*! \file
  36  * \brief
  37  * Declares functions to get basic version information.
  38  *
  39  * \author Teemu Murtola <teemu.murtola@gmail.com>
  40  * \inpublicapi
  41  * \ingroup module_utility
  42  */
  43 #ifndef GMX_UTILITY_BASEVERSION_H
  44 #define GMX_UTILITY_BASEVERSION_H
  45
  46 /*! \brief
  47  * Version string, containing the version, date, and abbreviated hash.
  48  *
  49  * This can be a plain version if git version info was disabled during the
  50  * build.
  51  * The returned string used to start with a literal word `VERSION` before
  52  * \Gromacs 2016, but no longer does.
  53  *
  54  * \ingroup module_utility
  55  */
  56 const char* gmx_version();
  57 /*! \brief
  58  * Full git hash of the latest commit.
  59  *
  60  * If git version info was disabled during the build, returns an empty string.
  61  *
  62  * \ingroup module_utility
  63  */
  64 const char* gmx_version_git_full_hash();
  65 /*! \brief
  66  * Full git hash of the latest commit in a central \Gromacs repository.
  67  *
  68  * If git version info was disabled during the build, returns an empty string.
  69  * Also, if the latest commit was from a central repository, the return value
  70  * is an empty string.
  71  *
  72  * \ingroup module_utility
  73  */
  74 const char* gmx_version_git_central_base_hash();
  75
  76 /*! \brief
  77  * Defined if ``libgromacs`` has been compiled in double precision.
  78  *
  79  * Allows detecting the compiled precision of the library through checking the
  80  * presence of the symbol, e.g., from autoconf or other types of build systems.
  81  *
  82  * \ingroup module_utility
  83  */
  84 void gmx_is_double_precision();
  85 /*! \brief
  86  * Defined if ``libgromacs`` has been compiled in single/mixed precision.
  87  *
  88  * Allows detecting the compiled precision of the library through checking the
  89  * presence of the symbol, e.g., from autoconf or other types of build systems.
  90  *
  91  * \ingroup module_utility
  92  */
  93
  94 void gmx_is_single_precision();
  95
  96 /*! \brief Return a string describing what kind of GPU suport was configured in the build.
  97  *
  98  * Currently returns correctly for CUDA, OpenCL and SYCL.
  99  * Needs to be updated when adding new acceleration options.
 100  */
 101 const char* getGpuImplementationString();
 102
 103 /*! \brief
 104  * DOI string, or empty when not a release build.
 105  */
 106 const char* gmxDOI();
 107
 108 /*! \brief
 109  * Hash of the complete source released in the tarball.
 110  *
 111  * Empty when not a release tarball build.
 112  */
 113 const char* gmxReleaseSourceChecksum();
 114
 115 /*! \brief
 116  * Hash of the complete source actually used when building.
 117  *
 118  * Always computed when building from tarball.
 119  */
 120 const char* gmxCurrentSourceChecksum();
 121
 122 #endif