Revert "draft"
[gromacs.git] / README
blob398c9fca27ec27446c4c5b32b695e0c5bc7d9769
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. Installation instructions are available in the INSTALL.* 
6 files (there is one for automake users, INSTALL.automake and one for cmake
7 users, INSTALL.cmake). A more extended step-by-step guide can be found 
8 on our website http://www.gromacs.org .
10 Of course we will do our utmost to help you with any problems, but PLEASE 
11 READ THE INSTALLATION INSTRUCTIONS BEFORE CONTACTING US!
13 There are also several other online resources available from the homepage, 
14 and special information for developers. We recommend all users to subscribe
15 at least to the gmx-announce list - there is almost no traffic at all, but 
16 you get notice of new versions or severe bugs, and it gives us a possibility
17 to keep track of the number of users since no signature is required anymore.
19 If you are a developer, or change the source for any other reason, check
20 out http://www.gromacs.org/developer for details on using automake & autoconf!
22                                * * * * *
24 GROMACS is free software, distributed under the GNU General Public License. 
25 However, scientific software is a little special compared to most other 
26 programs. Both you, we, and all other GROMACS users depend on the quality
27 of the code, and when we find bugs (every piece of software has them) it
28 is crucial that we can correct it and say that it was fixed in version X of 
29 the file or package release. For the same reason, it is important that you
30 can reproduce other people's result from a certain GROMACS version. 
32 The easiest way to avoid this kind of problems is to get your modifications
33 included in the main distribution. We'll be happy to consider any decent 
34 code. If it's a separate program it can probably be included in the contrib 
35 directory straight away (not supported by us), but for major changes in the 
36 main code we appreciate if you first test that it works with (and without) 
37 MPI, threads, double precision, etc.
39 If you still want to distribute a modified version or use part of GROMACS
40 in your own program, remember that the entire modified must be licensed 
41 under GPL, and that it must clearly be labeled as derived work. It should 
42 not use the name "official GROMACS", and make sure support questions are
43 directed to you instead of the GROMACS developers.
44 Sorry for the hard wording, but it is meant to protect YOUR reseach results!
46                                * * * * *
48 The development of GROMACS is mainly funded by academic research grants. 
49 To help us fund development, we humbly ask that you cite the GROMACS papers:
51 * GROMACS: A message-passing parallel molecular dynamics implementation
52   H.J.C. Berendsen, D. van der Spoel and R. van Drunen
53   Comp. Phys. Comm. 91, 43-56 (1995)
55 * GROMACS 4: Algorithms for highly efficient, load-balanced, and scalable
56   molecular simulation
57   B. Hess and C. Kutzner and D. van der Spoel and E. Lindahl
58   J. Chem. Theory Comput. 4 (2008) pp. 435-447
60 There are a lot of cool features we'd like to include in future versions,
61 but our resources are limited. All kinds of donations are welcome, both in 
62 form of code, hardware and funding! Industrial users who choose to pay
63 for a license pro bono (it is still GPL and can be redistributed freely) or
64 contribute in other ways are listed as GROMACS supporters on our webpages. 
65 Don't hesitate to contact us at gromacs@gromacs.org if you are interested.
68                        Good luck with your simulations!
70                               The GROMACS Crew