Merge branch 'master' of git://git.gromacs.org/gromacs
[gromacs/adressmacs.git] / INSTALL
blobc55d5ffc1cc9faabfa7dbe08bff5b8346a9b219d
2                     Welcome to GROMACS 3.1!
4 Note: Detailed, step-by-step installation instructions
5 are available on the website http://www.gromacs.org .
7 You will probably have to download and install FFTW the first
8 time you install GROMACS - our configuration script will check it!
12 * SHORT INSTRUCTIONS FOR THE IMPATIENT:
14 Starting with version 3.0, the GROMACS compile and install procedure 
15 was changed to simplify things for you. We now use a standard 
16 autoconf script and makefiles created by automake, like most 
17 GNU programs. This means your normal installation actions are 
18 limited to:
20 ./configure   
21 make
22 make install          
24 That's it! Most compiler flags and required libraries are checked
25 automatically by configure, and it will tell you if something is
26 missing. The default installation location is /usr/local/gromacs
27 (change it with --prefix).  
31 * INSTALLING FFTW:
33 The FFTW library has been removed from the distribution since it 
34 is not part of our package, but it is very easy to install separately
35 if it is not already present. Download the source code from 
36 http://www.fftw.org , or get it from http://www.gromacs.org .
38 Read the FFTW installation instructions for details. In short, to
39 install the single precision library under /usr/local type
41 ./configure --enable-float
43 and then type
45 make
46 make install
48 Note that in contrast to GROMACS, FFTW defaults to double. Even
49 if you don't think you'll need it's a good idea to install the
50 double precision libraries too, once and for all. Clean your
51 build by issuing 
53 make distclean
55 and then type
57 ./configure --enable-type-prefix
58 make
59 make install
61 Your double precision FFTW files will have a "d" prefix.
63 (It is possible to compile a crippled GROMACS without FFTW, but we
64 strongly discourage it - check the configure options for details)
68 * FFTW OR OTHER LIBRARIES IN NON-STANDARD LOCATIONS:
70 If you install FFTW in your homedirectory or some other place where
71 it isn't found automatically (not all systems search /usr/local)
72 by the compiler you should set the environment variables before 
73 executing configure. Assume we configured and installed FFTW with 
74 --prefix=/home/erik/fftw. If your shell is tcsh, you set
76 setenv CPPFLAGS -I/home/erik/fftw/include
77 setenv LDFLAGS  -L/home/erik/fftw/lib
79 or, if you are using a bash shell:
81 export CPPFLAGS=-I/home/erik/fftw/include
82 export LDFLAGS=-L/home/erik/fftw/lib
84 ...and then you run the Gromacs configure script. Similarly, if you
85 don't like the compilers configure selects, just set them with 
86 the variables CC and/or F77 (MPICC for an MPI compiler).
88 Don't use LDFLAGS to add extra libraries! Put them in LIBS instead, e.g.
90 setenv LIBS "-lstuff"     to add libstuff at the linking stage.
93 Once installed, you can link the Gromacs executables to e.g.
94 /usr/local/bin if you want all users to have them in their path.
98 * SPECIAL OPTIONS; FORTRAN, ASSEMBLY AND PARALLEL GROMACS WITH MPI:
100 Typing ./configure --help will give you some options like compiling
101 for parallel runs using MPI. Not all architecture use the fast
102 fortran loops per default, so if you know you have a fast fortan
103 compiler you should check that option. It won't have much effect
104 for modern x86 boxes though, since these use assembly innerloops.
106 To compile the assembly loops you need a reasonably recent version
107 of binutils. The configuration script checks it - pick up a later
108 version at www.gromacs.org if yours is too old. Don't disable
109 the assembly loops unless you absolutely have to...
112 For instance, if you want to compile only the mdrun executable
113 with parallel MPI support:
115 make clean               
116 ./configure --enable-mpi --disable-nice
117 make mdrun 
118 make install-mdrun
120 If you want to keep your non-mpi mdrun instead of overwriting
121 it, you can append a suffix with --program-suffix="_mpi":
122 If you only want to create the MPI version of the entire package 
123 you can just issue the normal make commands. The mdrun-only
124 installation can also be useful to have e.g. a general version 
125 of gromacs for analysis in the main binary directory, and then 
126 subdirectories with only an optimized mdrun for each cpu.
128 You can find more installation information on the GROMACS homepage
129 if you have any problems, and don't hesitate to contact us if you 
130 find any bugs in the configuration. The architecture names have 
131 been expanded and are almost identical to the GNU ones, but where 
132 it is possible we have added an extra level with more detailed 
133 processor specifications to enable higher optimization. If you 
134 have a very heterogeneous environment it might be a good idea
135 to compile a full non-optimized version in the main directory,
136 and then just optimized versions of mdrun in the processor
137 subdirectories!
141 * VPATH BUILDS:
143 If you want to do development on several architectures, you should
144 use a version of make that support VPATH (we suggest GNU make)
145 and create a new directory to contain the object files for this 
146 architecture (e.g. i686-pc-linux-gnu/obj). Then run configure from this 
147 new directory (../../configure) - you might have to make distclean first.
148 This way you keep all your object files (speeds up compiles) and 
149 change architecture by switching to a different object directory.
153 * ARE YOU STILL HAVING PROBLEMS?
155 Post it to the GROMACS mailing lists. We read these on a regular basis,
156 and in many cases another user might already be familiar with the
157 task you're trying to perform!
161                 Good luck compiling and running! 
163                        THE GROMACS CREW 
165                       gromacs@gromacs.org
169 ---------------------------------------------------------------------
171 These are the generic install instructions from autoconf:
172   
173    The `configure' shell script attempts to guess correct values for
174 various system-dependent variables used during compilation.  It uses
175 those values to create a `Makefile' in each directory of the package.
176 It may also create one or more `.h' files containing system-dependent
177 definitions.  Finally, it creates a shell script `config.status' that
178 you can run in the future to recreate the current configuration, a file
179 `config.cache' that saves the results of its tests to speed up
180 reconfiguring, and a file `config.log' containing compiler output
181 (useful mainly for debugging `configure').
183    If you need to do unusual things to compile the package, please try
184 to figure out how `configure' could check whether to do them, and mail
185 diffs or instructions to the address given in the `README' so they can
186 be considered for the next release.  If at some point `config.cache'
187 contains results you don't want to keep, you may remove or edit it.
189    The file `configure.in' is used to create `configure' by a program
190 called `autoconf'.  You only need `configure.in' if you want to change
191 it or regenerate `configure' using a newer version of `autoconf'.
193 The simplest way to compile this package is:
195   1. `cd' to the directory containing the package's source code and type
196      `./configure' to configure the package for your system.  If you're
197      using `csh' on an old version of System V, you might need to type
198      `sh ./configure' instead to prevent `csh' from trying to execute
199      `configure' itself.
201      Running `configure' takes awhile.  While running, it prints some
202      messages telling which features it is checking for.
204   2. Type `make' to compile the package.
206   3. Optionally, type `make check' to run any self-tests that come with
207      the package.
209   4. Type `make install' to install the programs and any data files and
210      documentation.
212   5. You can remove the program binaries and object files from the
213      source code directory by typing `make clean'.  To also remove the
214      files that `configure' created (so you can compile the package for
215      a different kind of computer), type `make distclean'.  There is
216      also a `make maintainer-clean' target, but that is intended mainly
217      for the package's developers.  If you use it, you may have to get
218      all sorts of other programs in order to regenerate files that came
219      with the distribution.
221 Compilers and Options
222 =====================
224    Some systems require unusual options for compilation or linking that
225 the `configure' script does not know about.  You can give `configure'
226 initial values for variables by setting them in the environment.  Using
227 a Bourne-compatible shell, you can do that on the command line like
228 this:
229      CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
231 Or on systems that have the `env' program, you can do it like this:
232      env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
234 Compiling For Multiple Architectures
235 ====================================
237    You can compile the package for more than one kind of computer at the
238 same time, by placing the object files for each architecture in their
239 own directory.  To do this, you must use a version of `make' that
240 supports the `VPATH' variable, such as GNU `make'.  `cd' to the
241 directory where you want the object files and executables to go and run
242 the `configure' script.  `configure' automatically checks for the
243 source code in the directory that `configure' is in and in `..'.
245    If you have to use a `make' that does not supports the `VPATH'
246 variable, you have to compile the package for one architecture at a time
247 in the source code directory.  After you have installed the package for
248 one architecture, use `make distclean' before reconfiguring for another
249 architecture.
251 Installation Names
252 ==================
254    By default, `make install' will install the package's files in
255 `/usr/local/bin', `/usr/local/man', etc.  You can specify an
256 installation prefix other than `/usr/local' by giving `configure' the
257 option `--prefix=PATH'.
259    You can specify separate installation prefixes for
260 architecture-specific files and architecture-independent files.  If you
261 give `configure' the option `--exec-prefix=PATH', the package will use
262 PATH as the prefix for installing programs and libraries.
263 Documentation and other data files will still use the regular prefix.
265    In addition, if you use an unusual directory layout you can give
266 options like `--bindir=PATH' to specify different values for particular
267 kinds of files.  Run `configure --help' for a list of the directories
268 you can set and what kinds of files go in them.
270    If the package supports it, you can cause programs to be installed
271 with an extra prefix or suffix on their names by giving `configure' the
272 option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'.
274 Optional Features
275 =================
277    Some packages pay attention to `--enable-FEATURE' options to
278 `configure', where FEATURE indicates an optional part of the package.
279 They may also pay attention to `--with-PACKAGE' options, where PACKAGE
280 is something like `gnu-as' or `x' (for the X Window System).  The
281 `README' should mention any `--enable-' and `--with-' options that the
282 package recognizes.
284    For packages that use the X Window System, `configure' can usually
285 find the X include and library files automatically, but if it doesn't,
286 you can use the `configure' options `--x-includes=DIR' and
287 `--x-libraries=DIR' to specify their locations.
289 Specifying the System Type
290 ==========================
292    There may be some features `configure' can not figure out
293 automatically, but needs to determine by the type of host the package
294 will run on.  Usually `configure' can figure that out, but if it prints
295 a message saying it can not guess the host type, give it the
296 `--host=TYPE' option.  TYPE can either be a short name for the system
297 type, such as `sun4', or a canonical name with three fields:
298      CPU-COMPANY-SYSTEM
300 See the file `config.sub' for the possible values of each field.  If
301 `config.sub' isn't included in this package, then this package doesn't
302 need to know the host type.
304    If you are building compiler tools for cross-compiling, you can also
305 use the `--target=TYPE' option to select the type of system they will
306 produce code for and the `--build=TYPE' option to select the type of
307 system on which you are compiling the package.
309 Sharing Defaults
310 ================
312    If you want to set default values for `configure' scripts to share,
313 you can create a site shell script called `config.site' that gives
314 default values for variables like `CC', `cache_file', and `prefix'.
315 `configure' looks for `PREFIX/share/config.site' if it exists, then
316 `PREFIX/etc/config.site' if it exists.  Or, you can set the
317 `CONFIG_SITE' environment variable to the location of the site script.
318 A warning: not all `configure' scripts look for a site script.
320 Operation Controls
321 ==================
323    `configure' recognizes the following options to control how it
324 operates.
326 `--cache-file=FILE'
327      Use and save the results of the tests in FILE instead of
328      `./config.cache'.  Set FILE to `/dev/null' to disable caching, for
329      debugging `configure'.
331 `--help'
332      Print a summary of the options to `configure', and exit.
334 `--quiet'
335 `--silent'
336 `-q'
337      Do not print messages saying which checks are being made.  To
338      suppress all normal output, redirect it to `/dev/null' (any error
339      messages will still be shown).
341 `--srcdir=DIR'
342      Look for the package's source code in directory DIR.  Usually
343      `configure' can determine that directory automatically.
345 `--version'
346      Print the version of Autoconf used to generate the `configure'
347      script, and exit.
349 `configure' also accepts some other, not widely useful, options.