Clarified gmx rmsf documentation
[gromacs.git] / README
blobf2e3b302b1eea1f2c3fb66cc96ed30770096f544
2                Welcome to the official version of GROMACS!
4 If you are familiar with Unix, it should be fairly trivial to compile and
5 install GROMACS. GROMACS uses only the CMake build sytem, and our
6 installation guide can be found at
7 http://www.gromacs.org/Documentation/Installation_Instructions.
9 Of course we will do our utmost to help you with any problems, but PLEASE 
10 READ THE INSTALLATION INSTRUCTIONS BEFORE CONTACTING US!
12 There are also several other online resources available from the homepage, 
13 and special information for developers.
15 If you are a developer, or change the source for any other reason, check
16 out http://www.gromacs.org/Developer_Zone.
18                                * * * * *
20 GROMACS is free software, distributed under the GNU Lesser General
21 Public License, version 2.1 However, scientific software is a little
22 special compared to most other programs. Both you, we, and all other
23 GROMACS users depend on the quality of the code, and when we find bugs
24 (every piece of software has them) it is crucial that we can correct
25 it and say that it was fixed in version X of the file or package
26 release. For the same reason, it is important that you can reproduce
27 other people's result from a certain GROMACS version.
29 The easiest way to avoid this kind of problems is to get your modifications
30 included in the main distribution. We'll be happy to consider any decent 
31 code. If it's a separate program it can probably be included in the contrib 
32 directory straight away (not supported by us), but for major changes in the 
33 main code we appreciate if you first test that it works with (and without) 
34 MPI, threads, double precision, etc.
36 If you still want to distribute a modified version or use part of GROMACS
37 in your own program, remember that the entire project must be licensed
38 according to the requirements of the LGPL v2.1 license under which you
39 received this copy of GROMACS. We request that it must clearly be labeled as
40 derived work. It should not use the name "official GROMACS", and make
41 sure support questions are directed to you instead of the GROMACS developers.
42 Sorry for the hard wording, but it is meant to protect YOUR reseach results!
44                                * * * * *
46 The development of GROMACS is mainly funded by academic research grants. 
47 To help us fund development, we humbly ask that you cite the GROMACS papers:
49 * GROMACS: A message-passing parallel molecular dynamics implementation
50   H.J.C. Berendsen, D. van der Spoel and R. van Drunen
51   Comp. Phys. Comm. 91, 43-56 (1995)
52   DOI: 10.1016/0010-4655(95)00042-E
54 * GROMACS 4: Algorithms for highly efficient, load-balanced, and scalable
55   molecular simulation
56   B. Hess and C. Kutzner and D. van der Spoel and E. Lindahl
57   J. Chem. Theory Comput. 4 (2008) pp. 435-447
58   DOI: 10.1021/ct700301q
60 * GROMACS 4.5: a high-throughput and highly parallel open source
61   molecular simulation toolkit
62   Sander Pronk, Szilárd Páll, Roland Schulz, Per Larsson, Pär Bjelkmar,
63   Rossen Apostolov, Michael R. Shirts, Jeremy C. Smith, Peter M. Kasson,
64   David van der Spoel, Berk Hess, Erik Lindahl.
65   Bioinformatics 29 (2013) pp. 845-54
66   DOI: 10.1093/bioinformatics/btt055
68 * Tackling Exascale Software Challenges in Molecular Dynamics Simulations
69   with GROMACS
70   Szilárd Páll, Mark J. Abraham, Carsten Kutzner, Berk Hess, Erik Lindahl
71   In S. Markidis & E. Laure (Eds.), Solving Software Challenges for Exascale,
72   8759 (2015) pp. 3–27
73   DOI: 10.1007/978-3-319-15976-8_1
75 There are a lot of cool features we'd like to include in future versions,
76 but our resources are limited. All kinds of donations are welcome, both in 
77 form of code, hardware and funding! Industrial users who choose to pay
78 for a license pro bono (it is still LGPL and can be redistributed freely) or
79 contribute in other ways are listed as GROMACS supporters on our webpages. 
80 Don't hesitate to contact us if you are interested.
83                        Good luck with your simulations!
85                               The GROMACS Crew