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