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