include/copyrite.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   4  * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
   5  * Copyright (c) 2001-2004, The GROMACS development team,
   6  * check out http://www.gromacs.org for more information.
   7  * Copyright (c) 2012,2013, 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.
  11  *
  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.
  16  *
  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.
  21  *
  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.
  26  *
  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.
  34  *
  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.
  37  */
  38
  39 #ifndef _copyrite_h
  40 #define _copyrite_h
  41 #include "visibility.h"
  42
  43 #include <stdio.h>
  44 #include "types/simple.h"
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 /* Has to be a function, so we can get version number from autoconf */
  51 GMX_LIBGMX_EXPORT
  52 const char *GromacsVersion(void);
  53
  54 void
  55 gmx_print_version_info(FILE *fp);
  56
  57
  58 static const char *
  59 CopyrightText[] = {
  60     "Contributions from Mark Abraham, Emile Apol, Rossen Apostolov, ",
  61     "Herman J.C. Berendsen, Aldert van Buuren, Pär Bjelkmar,  ",
  62     "Rudi van Drunen, Anton Feenstra, Gerrit Groenhof, Christoph Junghans, ",
  63     "Peter Kasson, Carsten Kutzner, Per Larsson, Pieter Meulenhoff, ",
  64     "Teemu Murtola, Szilard Pall, Sander Pronk, Roland Schulz, ",
  65     "Michael Shirts, Alfons Sijbers, Peter Tieleman,\n",
  66     "Berk Hess, David van der Spoel, and Erik Lindahl.\n",
  67     "Copyright (c) 1991-2000, University of Groningen, The Netherlands.",
  68     "Copyright (c) 2001-2012,2013, The GROMACS development team at",
  69     "Uppsala University & The Royal Institute of Technology, Sweden.",
  70     "check out http://www.gromacs.org for more information.\n"
  71 };
  72
  73 static const char *
  74 LicenseText[] = {
  75     "This program is free software; you can redistribute it and/or",
  76     "modify it under the terms of the GNU Lesser General Public License",
  77     "as published by the Free Software Foundation; either version 2.1",
  78     "of the License, or (at your option) any later version."
  79 };
  80
  81
  82 void
  83 pr_difftime(FILE *out, double dt);
  84
  85 GMX_LIBGMX_EXPORT
  86 void
  87 CopyRight(FILE *out, const char *szProgram);
  88
  89
  90 /* For both bromacs() and cool_quote() you have to provide a pointer to
  91  * a string of reasonable length (say 256) and the string length. This
  92  * is necessary to make the routines threadsafe and avoid allocating
  93  * a new string each time. The retstring pointer will be the return value.
  94  */
  95 GMX_LIBGMX_EXPORT
  96 void
  97 bromacs(char *retstring, int retsize);
  98
  99 /* For cool_quote, the number of the quote used will be returned in cqnum
 100  * if it is non-NULL.
 101  */
 102 GMX_LIBGMX_EXPORT
 103 void
 104 cool_quote(char *retstring, int retsize, int *cqnum);
 105
 106 gmx_bool
 107 be_cool(void);
 108 /* Return TRUE when the user is COOL, FALSE otherwise */
 109
 110 GMX_LIBGMX_EXPORT
 111 void
 112 thanx(FILE *fp);
 113
 114 enum {
 115     eCITEGMX, eCITEBATH, eCITESHAKE, eCITESETTLE, eCITESOR,
 116     eCITEDISRE, eCITERF, eCITELINCS, eCITENR
 117 };
 118
 119 GMX_LIBGMX_EXPORT
 120 void
 121 please_cite(FILE *fp, const char *key);
 122 /* Print a message asking to cite something... */
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 #endif  /* _copyright_h */