docs/manual/gromacs.tex

   1 %
   2 % This file is part of the GROMACS molecular simulation package.
   3 %
   4 % Copyright (c) 2013,2014,2015,2016,2017, 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 \documentclass[11pt,a4paper,twoside]{gmxmanual}
  36 \usepackage{here,picins,fancy,array,tabularx,multicol,dcolumn,makeidx,times,ifthen,enumitem,longtable,pdflscape}
  37 %citesort was old, deprecated in tex, and doesn't work with hyperref/pdftex.
  38 %it is rumored you could achieve the same functionality with natbib, but
  39 %after a couple of hours of trial I gave up... /EL
  40 \input{macros}
  41
  42 \usepackage[utf8]{inputenc}
  43 \usepackage[T1]{fontenc}
  44
  45 \newcommand{\projectContributors}{
  46 Emile Apol, Rossen Apostolov, Herman J.C. Berendsen, \\
  47 Aldert van Buuren, P\"ar Bjelkmar, Rudi van Drunen, \\
  48 Anton Feenstra, Sebastian Fritsch, Gerrit Groenhof, \\
  49 Christoph Junghans, Jochen Hub, Peter Kasson, \\
  50 Carsten Kutzner, Brad Lambeth, Per Larsson, \\
  51 Justin A. Lemkul, Magnus Lundborg, Erik Marklund, Peiter Meulenhoff, \\
  52 Teemu Murtola, Szil\'ard P\'all, Sander Pronk, \\
  53 Roland Schulz, Michael Shirts, Alfons Sijbers, \\
  54 Peter Tieleman, Christian Wennberg and Maarten Wolf.
  55 }
  56 \newcommand{\projectLeaders}{
  57      Mark Abraham, Berk Hess, David van der Spoel, and Erik Lindahl.
  58  }
  59
  60 \hypersetup{
  61 pdfencoding=unicode,
  62 pdfinfo={
  63    Author={The GROMACS team.
  64         Contributors: \projectContributors
  65         Project leaders: \projectLeaders
  66    For more details see http://www.gromacs.org/About\_Gromacs/People},
  67    Title={GROMACS Reference Manual},
  68    Subject={Theoretical and algorithmic background to molecular dynamics simulation using GROMACS},
  69    Keywords={GROMACS; molecular dynamics; molecular simulation; free energy; SIMD; GPU; GPGPU; MPI; OpenMP}
  70 }}
  71
  72 \begin{document}
  73
  74 %roman pagenumbers for the preamble stuff
  75 \pagenumbering{roman}
  76
  77 % Adjust margins on front page to make it
  78 % symmetrical. It is reset on the next page.
  79 \addtolength{\oddsidemargin}{-5mm}
  80
  81 %
  82 %       F R O N T P A G E
  83 %
  84 \pagestyle{empty}
  85 \begin{center}
  86
  87 \textcolor{blue}{\fontsize{84}{96} \selectfont GROMACS}
  88 \vspace{4mm}
  89
  90 \textcolor{blue}{\LARGE \em Groningen Machine for Chemical Simulations}
  91 \vspace{4mm}
  92
  93 \includegraphics[height=5in]{plots/peregrine}
  94 \vspace{4mm}
  95
  96 \fcolorbox{blue}{blue}{\textcolor{white}{\fontsize{56}{64} \selectfont ~Reference Manual~}}
  97 \vspace{4mm}
  98
  99 \textcolor{blue}{\fontsize{48}{56} \selectfont ~Version \gmxver~}
 100
 101
 102 %\vspace{0.25cm}
 103 %{\fontsize{30}{36} \selectfont \bf Version \gmxver}
 104
 105 \end{center}
 106 \vfill
 107
 108 \cleardoublepage
 109 %reset to normal margins
 110 \addtolength{\oddsidemargin}{5mm}
 111
 112 %
 113 %       P R E F A C E
 114 %
 115 \renewcommand{\chaptermark}[1]{\markboth{#1}{#1}} % remember chapter title
 116 \renewcommand{\sectionmark}[1]{\markright{\thesection\ #1}}
 117                                                 % section number and title
 118 \lhead[\fancyplain{}{\em\thepage}]{\fancyplain{}{\em\rightmark}}
 119 \rhead[\fancyplain{}{\em\leftmark}]{\fancyplain{}{\em\thepage}}
 120 \cfoot{}
 121
 122 \begin{center}
 123 \phantom{ }
 124 \vspace{1cm}
 125 {\fontsize{40}{50} \selectfont
 126 GROMACS\\
 127 Reference Manual\\[1cm]
 128 }
 129 {\LARGE\bf Version \gmxver}\\[1cm]
 130
 131 {\Large
 132 Contributions from \\
 133 \vspace{5mm}
 134
 135 \projectContributors}
 136 \vspace{5mm}
 137
 138 {\LARGE \projectLeaders}
 139 \vspace{10mm}
 140 \end{center}
 141
 142 \vfill
 143
 144
 145 \noindent \copyright\ 1991--2000:
 146 Department of Biophysical Chemistry, University of Groningen. \\
 147 Nijenborgh 4, 9747 AG Groningen, The Netherlands.\\
 148 \medskip
 149
 150 \noindent \copyright\ 2001--{\gmxyear}:
 151 The {\gromacs} development teams at the Royal Institute of Technology and \\
 152 Uppsala University, Sweden.
 153
 154 \vspace{5mm}
 155
 156 More information can be found on our website: {\wwwpage}.
 157
 158
 159 \newpage
 160 \pagestyle{fancyplain}
 161
 162 \subsection*{Preface \& Disclaimer}
 163 This manual is not complete and has no pretention to be so due
 164 to lack of time of the contributors -- our first priority is to improve
 165 the software. It is worked on continuously,
 166 which in some cases might mean the information is not entirely correct.
 167
 168 Comments on form and content are welcome, please send them to one of
 169 the mailing lists (see {\wwwpage}), or open an issue
 170 at {\redminepage}. Corrections can also be made in the GROMACS git
 171 source repository and uploaded to {\gerritpage}.
 172
 173 We release an updated version of the manual whenever
 174 we release a new version of the software, so in general
 175 it is a good idea to use a manual with the same major and
 176 minor release number as your {\gromacs} installation.
 177
 178 \subsection*{On-line Resources}
 179 You can find more documentation and other material at our homepage
 180 \wwwpage. Among other things there is an on-line reference, several
 181 {\gromacs} mailing lists with archives and contributed
 182 topologies/force fields.
 183
 184 \subsection*{Citation information}
 185 When \normindex{citing} this document in any scientific publication
 186 please refer to it as:
 187 \begin{quote}
 188 \raggedright
 189 M.J. Abraham, D. van der Spoel, E. Lindahl, B. Hess, and the GROMACS development team,
 190 \hspace{0.3em} {\em {\gromacs} {U}ser {M}anual version \gmxver},
 191 \hspace{0.3em} {\wwwpage} ({\gmxyear})
 192 \end{quote}
 193 However, we prefer that you cite (some of) the {\gromacs}
 194 papers~\cite{Bekker93a,Berendsen95a,Lindahl2001a,Spoel2005a,Hess2008b,Pronk2013,Pall2015,Abraham2015}
 195 when you publish your results. Any future development depends on academic research
 196 grants, since the package is distributed as free software!
 197
 198 \subsection*{{\gromacs} is {\em Free Software}}
 199 The entire {\gromacs} package is available under the GNU Lesser
 200 General Public License (LGPL), version 2.1. This means it's free as in free
 201 speech, not just that you can use it without paying us money.
 202 You can redistribute {\gromacs} and/or modify it under the terms of the LGPL
 203 as published by the Free Software Foundation;
 204 either version 2.1 of the License, or (at your option) any later version.
 205 For details, check the COPYING file in the source code or consult
 206 \href{http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html}{http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html}.
 207
 208 The {\gromacs} source code and and selected set of binary packages are
 209 available on our homepage, \wwwpage. Have fun.
 210
 211 \newpage
 212 %       C O N T E N T S
 213 %
 214 \tableofcontents
 215 %\listoffigures
 216 %\listoftables
 217
 218 %
 219 %       R E A L   M A N U A L
 220 %
 221 \cleardoublepage
 222 \pagenumbering{arabic}
 223
 224 \include{intro}
 225 \include{defunits}
 226 \include{algorithms}
 227 \include{forcefield}
 228
 229 \include{topology}
 230 \include{special}
 231 \include{programs}
 232 \include{analyse}
 233 %
 234 %       A P P E N D I C E S
 235 %
 236 \appendix
 237 \include{technical}
 238 \include{implement}
 239 \include{averages}
 240 %
 241 % The pdfdummy counter is a workaround to get correct
 242 % bookmarks for the index & bibliography in pdf files
 243
 244 \newcounter{pdfdummy}
 245
 246 %
 247 %       B I B L I O G R A P H Y
 248 %
 249 \cleardoublepage
 250 \refstepcounter{pdfdummy}
 251
 252 \addcontentsline{toc}{chapter}{Bibliography}
 253
 254 \bibliographystyle{proteins}
 255 \bibliography{monster,unpubl}
 256
 257 %
 258 %       I N D E X
 259 %
 260 \cleardoublepage
 261 \refstepcounter{pdfdummy}
 262
 263 \addcontentsline{toc}{chapter}{Index}
 264
 265 \renewcommand{\see}[2]{\mbox{} \mbox{\textit{see} #1}}
 266 \printindex
 267
 268 \end{document}
 269
 270 % LocalWords:  Groningen der Spoel Lindahl Nijenborgh Carsten Kutzner Aldert
 271 % LocalWords:  Buuren Apol Meulenhoff Tieleman Sijbers Feenstra Rudi Drunen Sij
 272 % LocalWords:  Berendsen pretention bers ser anual Uppsala Mainz unpubl
 273 % LocalWords:  Bioinformatics GROMACS Rossen Apostolov ar Bjelkmar
 274 % LocalWords:  Fritsch Gerrit Groenhof Junghans Kasson Larsson Peiter
 275 % LocalWords:  Teemu Murtola Szil ard Pronk Jochen Lambeth Lemkul
 276 % LocalWords:  Marklund Maarten