2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2012, The GROMACS development team,
6 * check out http://www.gromacs.org for more information.
7 * Copyright (c) 2012, by the GROMACS development team, led by
8 * David van der Spoel, Berk Hess, Erik Lindahl, and including many
9 * others, as listed in the AUTHORS file in the top-level source
10 * directory and at http://www.gromacs.org.
12 * GROMACS is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU Lesser General Public License
14 * as published by the Free Software Foundation; either version 2.1
15 * of the License, or (at your option) any later version.
17 * GROMACS is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * Lesser General Public License for more details.
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with GROMACS; if not, see
24 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
25 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 * If you want to redistribute modifications to GROMACS, please
28 * consider that scientific software is very special. Version
29 * control is crucial - bugs must be traceable. We will be happy to
30 * consider code for inclusion in the official distribution, but
31 * derived work must not be called official GROMACS. Details are found
32 * in the README & COPYING files - if they are missing, get the
33 * official version at http://www.gromacs.org.
35 * To help us fund GROMACS development, we humbly ask that you cite
36 * the research papers on the package. Check out http://www.gromacs.org.
39 #ifndef _gmx_version_h
40 #define _gmx_version_h
42 /* This include file will be configured by CMake and contains version
43 information, primarily for software that links to Gromacs.
45 This file exists from 4.6 onward. In 4.6, it is #included in
46 include/typedefs.h, but that is not guaranteed to be the case in later
49 The versions are in numerical form, where, for example, version
51 The values come from the main CMakeLists.txt.
53 This header defines two values, the Gromacs version, and the API version.
55 The API version is defined in GMX_API_VERSION, and denotes the
56 version of the programmer interface, i.e. the installed header files
57 and compatible library.
59 programs written against the gromacs library can use this file
60 to provide some backward compatibility even though parts of the API
63 #include <gromacs/version.h>
64 #if (GMX_API_VERSION < 50000)
65 .... <do pre-5.0 stuff>
67 .... <do post-5.0 stuff>
70 where version.h is included directly. For code that must be compatible
71 between 4.5 and 4.6, an interim solution is to include typedefs.h, which
74 #include <gromacs/typedefs.h>
75 #if !defined(GMX_API_VERSION) || (GMX_API_VERSION < 40600)
76 .... <do 4.5 specific stuff>
77 #elif (GMX_API_VERSION < 40700)
78 .... <do 4.6 specific stuff>
82 #define GMX_API_VERSION @API_VERSION@
85 /* GMX_VERSION contains the version number of the actual Gromacs library
86 and the Gromacs programs, in numerical format.
88 As of 4.6, the Gromacs and API versions are the same, but this is not
89 guaranteed to be the case in the future. */
90 #define GMX_VERSION @NUM_VERSION@
92 #endif /* _gmx_version_h */