PK added extern C for rmpbc and atomprop
[gromacs.git] / README
blob873ca331fe05894bd86554d573cbb89e49ad7a33
2                Welcome to the official version of GROMACS!
4 There are no significant changes to the installation or use between version 
5 3.1 and 3.0, so if you're already used to 3.0 you can just go ahead and update.
6 A lot of things changed with version 3.0, though. Not only is the code 
7 significantly faster, but we also introduced a completely new installation
8 process and licensed the package under the GPL (see the COPYING file).
10 If you are familiar with unix, it should be fairly trivial to compile and
11 install GROMACS. Installation instructions are available in the INSTALL file,
12 and a more extended step-by-step guide can be found on http://www.gromacs.org .
14 Of course we will do our utmost to help you with any problems, but PLEASE 
15 READ THE INSTALLATION INSTRUCTIONS BEFORE CONTACTING US!
17 There are also several other online resources available from the homepage, 
18 and special information for developers. We recommend all users to subscribe
19 at least to the gmx-announce list - there is almost no traffic at all, but 
20 you get notice of new versions or severe bugs, and it gives us a possibility
21 to keep track of the number of users since no signature is required anymore.
23 If you are a developer, or change the source for any other reason, check
24 out http://www.gromacs.org/developer for details on using automake & autoconf!
26                                * * * * *
28 GROMACS is free software, distributed under the GNU General Public License. 
29 However, scientific software is a little special compared to most other 
30 programs. Both you, we, and all other GROMACS users depend on the quality
31 of the code, and when we find bugs (every piece of software has them) it
32 is crucial that we can correct it and say that it was fixed in version X of 
33 the file or package release. For the same reason, it is important that you
34 can reproduce other people's result from a certain GROMACS version. 
36 The easiest way to avoid this kind of problems is to get your modifications
37 included in the main distribution. We'll be happy to consider any decent 
38 code. If it's a separate program it can probably be included in the contrib 
39 directory straight away (not supported by us), but for major changes in the 
40 main code we appreciate if you first test that it works with MPI, 
41 double precision, fortran code, etc.
43 If you still want to distribute a modified version or use part of GROMACS
44 in your own program, remember that the entire modified must be licensed 
45 under GPL, and that it must clearly be labeled as derived work. It should 
46 not use the name "official GROMACS", and make sure support questions are
47 directed to you instead of the GROMACS developers.
48 Sorry for the hard wording, but it is meant to protect YOUR reseach results!
50                                * * * * *
52 The development of GROMACS is mainly funded by academic research grants. 
53 To help us fund development, we humbly ask that you cite the GROMACS papers:
55 * GROMACS: A message-passing parallel molecular dynamics implementation
56   H.J.C. Berendsen, D. van der Spoel and R. van Drunen
57   Comp. Phys. Comm. 91, 43-56 (1995)
59 * GROMACS 3.0: A package for molecular simulation and trajectory analysis
60   Erik Lindahl, Berk Hess and David van der Spoel
61   J. Mol. Mod. 7, 306-317 (2001)
63 There are a lot of cool features we'd like to include in future versions,
64 but our resources are limited. All kinds of donations are welcome, both in 
65 form of code, hardware and funding! Industrial users who choose to pay
66 for a license pro bono (it is still GPL and can be redistributed freely) or
67 contribute in other ways are listed as GROMACS supporters on our webpages. 
68 Don't hesitate to contact us at gromacs@gromacs.org if you are interested.
71                        Good luck with your simulations!
73                               The GROMACS Crew