Merge branch release-2016
[alexxy/gromacs.git] / docs / install-guide / index.rst
1 .. _install guide:
2
3 ******************
4 Installation guide
5 ******************
6
7 .. highlight:: bash
8
9 Introduction to building |Gromacs|
10 ==================================
11
12 These instructions pertain to building |Gromacs|
13 |version|. You might also want to check the `up-to-date installation instructions`_.
14
15 Quick and dirty installation
16 ----------------------------
17 1. Get the latest version of your C and C++ compilers.
18 2. Check that you have CMake version |CMAKE_MINIMUM_REQUIRED_VERSION| or later.
19 3. Get and unpack the latest version of the |Gromacs| tarball.
20 4. Make a separate build directory and change to it. 
21 5. Run ``cmake`` with the path to the source as an argument
22 6. Run ``make``, ``make check``, and ``make install``
23 7. Source ``GMXRC`` to get access to |Gromacs|
24
25 Or, as a sequence of commands to execute:
26
27 .. parsed-literal::
28
29     tar xfz gromacs-|version|.tar.gz
30     cd gromacs-|version|
31     mkdir build
32     cd build
33     cmake .. -DGMX_BUILD_OWN_FFTW=ON -DREGRESSIONTEST_DOWNLOAD=ON
34     make
35     make check
36     sudo make install
37     source /usr/local/gromacs/bin/GMXRC
38
39 This will download and build first the prerequisite FFT library
40 followed by |Gromacs|. If you already have FFTW installed, you can
41 remove that argument to ``cmake``. Overall, this build of |Gromacs|
42 will be correct and reasonably fast on the machine upon which
43 ``cmake`` ran. On another machine, it may not run, or may not run
44 fast. If you want to get the maximum value for your hardware with
45 |Gromacs|, you will have to read further. Sadly, the interactions of
46 hardware, libraries, and compilers are only going to continue to get
47 more complex.
48
49 Quick and dirty cluster installation
50 ------------------------------------
51
52 On a cluster where users are expected to be running across multiple
53 nodes using MPI, make one installation similar to the above, and
54 another using an MPI wrapper compiler and which is `building only
55 mdrun`_, because that is the only component of |Gromacs| that uses
56 MPI.
57
58 Typical installation
59 --------------------
60 As above, and with further details below, but you should consider
61 using the following `CMake options`_ with the
62 appropriate value instead of ``xxx`` :
63
64 * ``-DCMAKE_C_COMPILER=xxx`` equal to the name of the C99 `Compiler`_ you wish to use (or the environment variable ``CC``)
65 * ``-DCMAKE_CXX_COMPILER=xxx`` equal to the name of the C++98 `compiler`_ you wish to use (or the environment variable ``CXX``)
66 * ``-DGMX_MPI=on`` to build using `MPI support`_ (generally good to combine with `building only mdrun`_)
67 * ``-DGMX_GPU=on`` to build using nvcc to run using NVIDIA `CUDA GPU acceleration`_ or an OpenCL_ GPU
68 * ``-DGMX_USE_OPENCL=on`` to build with OpenCL_ support enabled. ``GMX_GPU`` must also be set.
69 * ``-DGMX_SIMD=xxx`` to specify the level of `SIMD support`_ of the node on which |Gromacs| will run
70 * ``-DGMX_BUILD_MDRUN_ONLY=on`` for `building only mdrun`_, e.g. for compute cluster back-end nodes
71 * ``-DGMX_DOUBLE=on`` to build |Gromacs| in double precision (slower, and not normally useful)
72 * ``-DCMAKE_PREFIX_PATH=xxx`` to add a non-standard location for CMake to `search for libraries, headers or programs`_
73 * ``-DCMAKE_INSTALL_PREFIX=xxx`` to install |Gromacs| to a `non-standard location`_ (default ``/usr/local/gromacs``)
74 * ``-DBUILD_SHARED_LIBS=off`` to turn off the building of shared libraries to help with `static linking`_
75 * ``-DGMX_FFT_LIBRARY=xxx`` to select whether to use ``fftw``, ``mkl`` or ``fftpack`` libraries for `FFT support`_
76 * ``-DCMAKE_BUILD_TYPE=Debug`` to build |Gromacs| in debug mode
77
78 Building older versions
79 -----------------------
80 Installation instructions for old |Gromacs| versions can be found at
81 the |Gromacs| `documentation page
82 <http://manual.gromacs.org/documentation>`_.
83
84 Prerequisites
85 =============
86 Platform
87 --------
88 |Gromacs| can be compiled for many operating systems and
89 architectures.  These include any distribution of Linux, Mac OS X or
90 Windows, and architectures including x86, AMD64/x86-64, several
91 PowerPC including POWER8, ARM v7, ARM v8, and SPARC VIII.
92
93 Compiler
94 --------
95
96 |Gromacs| can be compiled on any platform with ANSI C99 and C++11
97 compilers, and their respective standard C/C++ libraries. Good
98 performance on an OS and architecture requires choosing a good
99 compiler. We recommend gcc, because it is free, widely available and
100 frequently provides the best performance.
101
102 You should strive to use the most recent version of your
103 compiler. Since we require full C++11 support the minimum supported
104 compiler versions are
105
106 * GNU (gcc) 4.8.1
107 * Intel (icc) 15.0
108 * LLVM (clang) 3.3
109 * Microsoft (MSVC) 2015
110
111 Other compilers may work (Cray, Pathscale, older clang) but do
112 not offer competitive performance. We recommend against PGI because
113 the performance with C++ is very bad.
114
115 You may also need the most recent version of other compiler toolchain
116 components beside the compiler itself (e.g. assembler or linker);
117 these are often shipped by your OS distribution's binutils package.
118
119 C++11 support requires adequate support in both the compiler and the
120 C++ library. The gcc and MSVC compilers include their own standard
121 libraries and require no further configuration. For configuration of
122 other compilers, read on.
123
124 On Linux, both the Intel and clang compiler use the libstdc++ which
125 comes with gcc as the default C++ library. For |Gromacs|, we require
126 the compiler to support libstc++ version 4.8.1 or higher. To select a
127 particular libstdc++ library, use:
128
129 * For Intel: ``-DGMX_STDLIB_CXX_FLAGS=-gcc-name=/path/to/gcc/binary``
130   or make sure that the correct gcc version is first in path (e.g. by
131   loading the gcc module). It can also be useful to add
132   ``-DCMAKE_CXX_LINK_FLAGS="-Wl,-rpath,/path/to/gcc/lib64
133   -L/path/to/gcc/lib64"`` to ensure linking works correctly.
134 * For clang:
135   ``-DCMAKE_CXX_FLAGS=--gcc-toolchain=/path/to/gcc/folder``. This
136   folder should contain ``include/c++``.
137
138 On Windows with the Intel compiler, the MSVC standard library is used,
139 and at least MSVC 2015 is required. Load the enviroment variables with
140 vcvarsall.bat.
141
142 To build with any compiler and clang's libcxx standard library, use
143 ``-DGMX_STDLIB_CXX_FLAGS=-stdlib=libc++
144 -DGMX_STDLIB_LIBRARIES='-lc++abi -lc++'``.
145
146 If you are running on Mac OS X, the best option is the Intel
147 compiler. Both clang and gcc will work, but they produce lower
148 performance and each have some shortcomings. clang 3.8 now offers
149 support for OpenMP, and so may provide decent performance.
150
151 For all non-x86 platforms, your best option is typically to use gcc or
152 the vendor's default or recommended compiler, and check for
153 specialized information below.
154
155 For updated versions of gcc to add to your Linux OS, see
156
157 * Ubuntu: `Ubuntu toolchain ppa page`_
158 * RHEL/CentOS: `EPEL page`_ or the RedHat Developer Toolset
159
160 Compiling with parallelization options
161 --------------------------------------
162
163 For maximum performance you will need to examine how you will use
164 |Gromacs| and what hardware you plan to run on. Often OpenMP_
165 parallelism is an advantage for |Gromacs|, but support for this is
166 generally built into your compiler and detected automatically.
167
168 GPU support
169 ^^^^^^^^^^^
170 |Gromacs| has excellent support for NVIDIA GPUs supported via CUDA.
171 On Linux with gcc, NVIDIA's CUDA_ version |REQUIRED_CUDA_VERSION|
172 software development kit is required, and the latest
173 version is strongly encouraged. Using Intel or Microsoft compilers
174 requires version 7.0 and 8.0, respectively. NVIDIA GPUs with at
175 least NVIDIA compute capability |REQUIRED_CUDA_COMPUTE_CAPABILITY| are
176 required, e.g. Fermi, Kepler, Maxwell or Pascal cards. You are strongly recommended to
177 get the latest CUDA version and driver supported by your hardware, but
178 beware of possible performance regressions in newer CUDA versions on
179 older hardware. Note that while some CUDA compilers (nvcc) might not
180 officially support recent versions of gcc as the back-end compiler, we
181 still recommend that you at least use a gcc version recent enough to
182 get the best SIMD support for your CPU, since |Gromacs| always runs some
183 code on the CPU. It is most reliable to use the same C++ compiler
184 version for |Gromacs| code as used as the back-end compiler for nvcc,
185 but it could be faster to mix compiler versions to suit particular
186 contexts.
187
188 To make it possible to use other accelerators, |Gromacs| also includes
189 OpenCL_ support. The minimum OpenCL version required is
190 |REQUIRED_OPENCL_MIN_VERSION|. The current version is recommended for
191 use with GCN-based AMD GPUs. It does work with NVIDIA GPUs, but using
192 the latest NVIDIA driver (which includes the NVIDIA OpenCL runtime) is
193 recommended. Additionally, there are known limitations when using
194 recent versions of the AMD APPSDK (details are found in the |Gromacs|
195 user guide). It is not possible to configure both CUDA and OpenCL
196 support in the same version of |Gromacs|.
197
198 Please note that MSVC 2015 is the earliest version of MSVC supported
199 by |Gromacs|, but that requires at least CUDA 8 for an officially
200 supported CUDA build. This will likely not occur before |Gromacs| 2016
201 is released.
202
203 .. _mpi-support:
204
205 MPI support
206 ^^^^^^^^^^^
207
208 |Gromacs| can run in parallel on multiple cores of a single
209 workstation using its built-in thread-MPI. No user action is required
210 in order to enable this.
211
212 If you wish to run in parallel on multiple machines across a network,
213 you will need to have
214
215 * an MPI library installed that supports the MPI 1.3
216   standard, and
217 * wrapper compilers that will compile code using that library.
218
219 The |Gromacs| team recommends OpenMPI_ version
220 1.6 (or higher), MPICH_ version 1.4.1 (or
221 higher), or your hardware vendor's MPI installation. The most recent
222 version of either of these is likely to be the best. More specialized
223 networks might depend on accelerations only available in the vendor's
224 library. LAM-MPI_ might work, but since it has
225 been deprecated for years, it is not supported.
226
227 CMake
228 -----
229
230 |Gromacs| builds with the CMake build system, requiring at least
231 version |CMAKE_MINIMUM_REQUIRED_VERSION|. You can check whether
232 CMake is installed, and what version it is, with ``cmake
233 --version``. If you need to install CMake, then first check whether
234 your platform's package management system provides a suitable version,
235 or visit the `CMake installation page`_ for pre-compiled binaries,
236 source code and installation instructions. The |Gromacs| team
237 recommends you install the most recent version of CMake you can.
238
239 .. _FFT support:
240
241 Fast Fourier Transform library
242 ------------------------------
243
244 Many simulations in |Gromacs| make extensive use of fast Fourier
245 transforms, and a software library to perform these is always
246 required. We recommend FFTW_ (version 3 or higher only) or Intel
247 MKL_. The choice of library can be set with ``cmake
248 -DGMX_FFT_LIBRARY=<name>``, where ``<name>`` is one of ``fftw``,
249 ``mkl``, or ``fftpack``. FFTPACK is bundled with |Gromacs| as a
250 fallback, and is acceptable if simulation performance is not a
251 priority. When choosing MKL, |Gromacs| will also use MKL for BLAS and
252 LAPACK (see `linear algebra libraries`_). Generally, there is no
253 advantage in using MKL with |Gromacs|, and FFTW is often faster.
254
255 Using FFTW
256 ^^^^^^^^^^
257 FFTW_ is likely to be available for your platform via its package
258 management system, but there can be compatibility and significant
259 performance issues associated with these packages. In particular,
260 |Gromacs| simulations are normally run in "mixed" floating-point
261 precision, which is suited for the use of single precision in
262 FFTW. The default FFTW package is normally in double
263 precision, and good compiler options to use for FFTW when linked to
264 |Gromacs| may not have been used. Accordingly, the |Gromacs| team
265 recommends either
266
267 * that you permit the |Gromacs| installation to download and
268   build FFTW from source automatically for you (use
269   ``cmake -DGMX_BUILD_OWN_FFTW=ON``), or
270 * that you build FFTW from the source code.
271
272 If you build FFTW from source yourself, get the most recent version
273 and follow the `FFTW installation guide`_. Choose the precision for
274 FFTW (i.e. single/float vs. double) to match whether you will later
275 use mixed or double precision for |Gromacs|. There is no need to
276 compile FFTW with threading or MPI support, but it does no harm. On
277 x86 hardware, compile with *both* ``--enable-sse2`` and
278 ``--enable-avx`` for FFTW-3.3.4 and earlier. From FFTW-3.3.5, you
279 should also add ``--enable-avx2`` also. On Intel chipsets supporting
280 512-wide AVX, including KNL, add ``--enable-avx512`` also. FFTW will
281 create a fat library with codelets for all different instruction sets,
282 and pick the fastest supported one at runtime. On IBM Power8, you
283 definitely want FFTW-3.3.5 and to compile it with ``--enable-vsx`` for
284 SIMD support. If you are using a Cray, there is a special modified
285 (commercial) version of FFTs using the FFTW interface which can be
286 slightly faster.
287
288 Using MKL
289 ^^^^^^^^^
290 Use MKL bundled with Intel compilers by setting up the compiler
291 environment, e.g., through ``source /path/to/compilervars.sh intel64``
292 or similar before running CMake including setting
293 ``-DGMX_FFT_LIBRARY=mkl``.
294
295 If you need to customize this further, use
296
297 ::
298     -DGMX_FFT_LIBRARY=mkl
299     -DMKL_LIBRARIES="/full/path/to/libone.so;/full/path/to/libtwo.so"
300     -DMKL_INCLUDE_DIR="/full/path/to/mkl/include"
301
302 The full list and order(!) of libraries you require are found in Intel's MKL documentation for your system.
303
304 Other optional build components
305 -------------------------------
306 * Run-time detection of hardware capabilities can be improved by
307   linking with hwloc, which is automatically enabled if detected.
308 * Hardware-optimized BLAS and LAPACK libraries are useful
309   for a few of the |Gromacs| utilities focused on normal modes and
310   matrix manipulation, but they do not provide any benefits for normal
311   simulations. Configuring these is discussed at
312   `linear algebra libraries`_.
313 * The built-in |Gromacs| trajectory viewer ``gmx view`` requires X11 and
314   Motif/Lesstif libraries and header files. You may prefer to use
315   third-party software for visualization, such as VMD_ or PyMol_.
316 * An external TNG library for trajectory-file handling can be used
317   by setting ``-DGMX_EXTERNAL_TNG=yes``, but TNG
318   |GMX_TNG_MINIMUM_REQUIRED_VERSION| is bundled in the |Gromacs|
319   source already.
320 * An external lmfit library for Levenberg-Marquardt curve fitting
321   can be used by setting ``-DGMX_EXTERNAL_LMFIT=yes``, but lmfit
322   |GMX_LMFIT_MINIMUM_REQUIRED_VERSION| is bundled in the |Gromacs|
323   source already.
324 * zlib is used by TNG for compressing some kinds of trajectory data
325 * Building the |Gromacs| documentation is optional, and requires
326   ImageMagick, pdflatex, bibtex, doxygen, python 2.7, sphinx 1.2.4,
327   and pygments.
328 * The |Gromacs| utility programs often write data files in formats
329   suitable for the Grace plotting tool, but it is straightforward to
330   use these files in other plotting programs, too.
331   
332 Doing a build of |Gromacs|
333 ==========================
334 This section will cover a general build of |Gromacs| with CMake_, but it
335 is not an exhaustive discussion of how to use CMake. There are many
336 resources available on the web, which we suggest you search for when
337 you encounter problems not covered here. The material below applies
338 specifically to builds on Unix-like systems, including Linux, and Mac
339 OS X. For other platforms, see the specialist instructions below.
340
341 Configuring with CMake
342 ----------------------
343 CMake will run many tests on your system and do its best to work out
344 how to build |Gromacs| for you. If your build machine is the same as
345 your target machine, then you can be sure that the defaults and
346 detection will be pretty good. However, if you want to control aspects
347 of the build, or you are compiling on a cluster head node for back-end
348 nodes with a different architecture, there are a few things you
349 should consider specifying.
350
351 The best way to use CMake to configure |Gromacs| is to do an
352 "out-of-source" build, by making another directory from which you will
353 run CMake. This can be outside the source directory, or a subdirectory
354 of it. It also means you can never corrupt your source code by trying
355 to build it! So, the only required argument on the CMake command line
356 is the name of the directory containing the ``CMakeLists.txt`` file of
357 the code you want to build. For example, download the source tarball
358 and use
359
360 .. parsed-literal::
361
362     tar xfz gromacs-|version|.tgz
363     cd gromacs-|version|
364     mkdir build-gromacs
365     cd build-gromacs
366     cmake ..
367
368 You will see ``cmake`` report a sequence of results of tests and
369 detections done by the |Gromacs| build system. These are written to the
370 ``cmake`` cache, kept in ``CMakeCache.txt``. You can edit this file by
371 hand, but this is not recommended because you could make a mistake.
372 You should not attempt to move or copy this file to do another build,
373 because file paths are hard-coded within it. If you mess things up,
374 just delete this file and start again with ``cmake``.
375
376 If there is a serious problem detected at this stage, then you will see
377 a fatal error and some suggestions for how to overcome it. If you are
378 not sure how to deal with that, please start by searching on the web
379 (most computer problems already have known solutions!) and then
380 consult the gmx-users mailing list. There are also informational
381 warnings that you might like to take on board or not. Piping the
382 output of ``cmake`` through ``less`` or ``tee`` can be
383 useful, too.
384
385 Once ``cmake`` returns, you can see all the settings that were chosen
386 and information about them by using e.g. the curses interface
387
388 ::
389
390     ccmake ..
391
392 You can actually use ``ccmake`` (available on most Unix platforms)
393 directly in the first step, but then
394 most of the status messages will merely blink in the lower part
395 of the terminal rather than be written to standard output. Most platforms
396 including Linux, Windows, and Mac OS X even have native graphical user interfaces for
397 ``cmake``, and it can create project files for almost any build environment
398 you want (including Visual Studio or Xcode).
399 Check out `running CMake`_ for
400 general advice on what you are seeing and how to navigate and change
401 things. The settings you might normally want to change are already
402 presented. You may make changes, then re-configure (using ``c``), so that it
403 gets a chance to make changes that depend on yours and perform more
404 checking. It may take several configuration passes to reach the desired
405 configuration, in particular if you need to resolve errors.
406
407 When you have reached the desired configuration with ``ccmake``, the
408 build system can be generated by pressing ``g``.  This requires that the previous
409 configuration pass did not reveal any additional settings (if it did, you need
410 to configure once more with ``c``).  With ``cmake``, the build system is generated
411 after each pass that does not produce errors.
412
413 You cannot attempt to change compilers after the initial run of
414 ``cmake``. If you need to change, clean up, and start again.
415
416 .. _non-standard location:
417
418 Where to install GROMACS
419 ^^^^^^^^^^^^^^^^^^^^^^^^
420
421 |Gromacs| is installed in the directory to which
422 ``CMAKE_INSTALL_PREFIX`` points. It may not be the source directory or
423 the build directory.  You require write permissions to this
424 directory. Thus, without super-user privileges,
425 ``CMAKE_INSTALL_PREFIX`` will have to be within your home directory.
426 Even if you do have super-user privileges, you should use them only
427 for the installation phase, and never for configuring, building, or
428 running |Gromacs|!
429
430 .. _cmake options:
431
432 Using CMake command-line options
433 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
434 Once you become comfortable with setting and changing options, you may
435 know in advance how you will configure |Gromacs|. If so, you can speed
436 things up by invoking ``cmake`` and passing the various options at once
437 on the command line. This can be done by setting cache variable at the
438 cmake invocation using ``-DOPTION=VALUE``. Note that some
439 environment variables are also taken into account, in particular
440 variables like ``CC`` and ``CXX``.
441
442 For example, the following command line
443
444 ::
445
446     cmake .. -DGMX_GPU=ON -DGMX_MPI=ON -DCMAKE_INSTALL_PREFIX=/home/marydoe/programs
447
448 can be used to build with CUDA GPUs, MPI and install in a custom
449 location. You can even save that in a shell script to make it even
450 easier next time. You can also do this kind of thing with ``ccmake``,
451 but you should avoid this, because the options set with ``-D`` will not
452 be able to be changed interactively in that run of ``ccmake``.
453
454 SIMD support
455 ^^^^^^^^^^^^
456 |Gromacs| has extensive support for detecting and using the SIMD
457 capabilities of many modern HPC CPU architectures. If you are building
458 |Gromacs| on the same hardware you will run it on, then you don't need
459 to read more about this, unless you are getting configuration warnings
460 you do not understand. By default, the |Gromacs| build system will
461 detect the SIMD instruction set supported by the CPU architecture (on
462 which the configuring is done), and thus pick the best
463 available SIMD parallelization supported by |Gromacs|. The build system
464 will also check that the compiler and linker used also support the
465 selected SIMD instruction set and issue a fatal error if they
466 do not.
467
468 Valid values are listed below, and the applicable value with the
469 largest number in the list is generally the one you should choose.
470 In most cases, choosing an inappropriate higher number will lead
471 to compiling a binary that will not run.
472
473 1. ``None`` For use only on an architecture either lacking SIMD,
474    or to which |Gromacs| has not yet been ported and none of the
475    options below are applicable.
476 2. ``SSE2`` This SIMD instruction set was introduced in Intel
477    processors in 2001, and AMD in 2003. Essentially all x86
478    machines in existence have this, so it might be a good choice if
479    you need to support dinosaur x86 computers too.
480 3. ``SSE4.1`` Present in all Intel core processors since 2007,
481    but notably not in AMD Magny-Cours. Still, almost all recent
482    processors support this, so this can also be considered a good
483    baseline if you are content with slow simulations and prefer
484    portability between reasonably modern processors.
485 4. ``AVX_128_FMA`` AMD bulldozer processors (2011) have this.
486 5. ``AVX_256`` Intel processors since Sandy Bridge (2011). While this
487    code will work on recent AMD processors, it is significantly less
488    efficient than the ``AVX_128_FMA`` choice above - do not be fooled
489    to assume that 256 is better than 128 in this case.
490 6. ``AVX2_256`` Present on Intel Haswell (and later) processors (2013),
491    and it will also enable Intel 3-way fused multiply-add instructions.
492 7. ``AVX_512`` Skylake-EP Xeon processors (2017)
493 8. ``AVX_512_KNL`` Knights Landing Xeon Phi processors
494 9. ``IBM_QPX`` BlueGene/Q A2 cores have this.
495 10. ``Sparc64_HPC_ACE`` Fujitsu machines like the K computer have this.
496 11. ``IBM_VMX`` Power6 and similar Altivec processors have this.
497 12. ``IBM_VSX`` Power7 and Power8 have this.
498 13. ``ARM_NEON`` 32-bit ARMv7 with NEON support.
499 14. ``ARM_NEON_ASIMD`` 64-bit ARMv8 and later.
500
501 The CMake configure system will check that the compiler you have
502 chosen can target the architecture you have chosen. mdrun will check
503 further at runtime, so if in doubt, choose the lowest number you
504 think might work, and see what mdrun says. The configure system also
505 works around many known issues in many versions of common HPC
506 compilers.
507
508 A further ``GMX_SIMD=Reference`` option exists, which is a special
509 SIMD-like implementation written in plain C that developers can use
510 when developing support in |Gromacs| for new SIMD architectures. It is
511 not designed for use in production simulations, but if you are using
512 an architecture with SIMD support to which |Gromacs| has not yet been
513 ported, you may wish to try this option instead of the default
514 ``GMX_SIMD=None``, as it can often out-perform this when the
515 auto-vectorization in your compiler does a good job. And post on the
516 |Gromacs| mailing lists, because |Gromacs| can probably be ported for new
517 SIMD architectures in a few days.
518
519 CMake advanced options
520 ^^^^^^^^^^^^^^^^^^^^^^
521 The options that are displayed in the default view of ``ccmake`` are
522 ones that we think a reasonable number of users might want to consider
523 changing. There are a lot more options available, which you can see by
524 toggling the advanced mode in ``ccmake`` on and off with ``t``. Even
525 there, most of the variables that you might want to change have a
526 ``CMAKE_`` or ``GMX_`` prefix. There are also some options that will be
527 visible or not according to whether their preconditions are satisfied.
528
529 .. _search for libraries, headers or programs:
530
531 Helping CMake find the right libraries, headers, or programs
532 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
533 If libraries are installed in non-default locations their location can
534 be specified using the following variables:
535
536 * ``CMAKE_INCLUDE_PATH`` for header files
537 * ``CMAKE_LIBRARY_PATH`` for libraries
538 * ``CMAKE_PREFIX_PATH`` for header, libraries and binaries
539   (e.g. ``/usr/local``).
540
541 The respective ``include``, ``lib``, or ``bin`` is
542 appended to the path. For each of these variables, a list of paths can
543 be specified (on Unix, separated with ":"). These can be set as
544 enviroment variables like:
545
546 ::
547
548     CMAKE_PREFIX_PATH=/opt/fftw:/opt/cuda cmake ..
549
550 (assuming ``bash`` shell). Alternatively, these variables are also
551 ``cmake`` options, so they can be set like
552 ``-DCMAKE_PREFIX_PATH=/opt/fftw:/opt/cuda``.
553
554 The ``CC`` and ``CXX`` environment variables are also useful
555 for indicating to ``cmake`` which compilers to use. Similarly,
556 ``CFLAGS``/``CXXFLAGS`` can be used to pass compiler
557 options, but note that these will be appended to those set by
558 |Gromacs| for your build platform and build type. You can customize
559 some of this with advanced CMake options such as ``CMAKE_C_FLAGS``
560 and its relatives.
561
562 See also the page on `CMake environment variables`_.
563
564 .. _CUDA GPU acceleration:
565
566 CUDA GPU acceleration
567 ^^^^^^^^^^^^^^^^^^^^^
568 If you have the CUDA_ Toolkit installed, you can use ``cmake`` with:
569
570 ::
571
572     cmake .. -DGMX_GPU=ON -DCUDA_TOOLKIT_ROOT_DIR=/usr/local/cuda
573
574 (or whichever path has your installation). In some cases, you might
575 need to specify manually which of your C++ compilers should be used,
576 e.g. with the advanced option ``CUDA_HOST_COMPILER``.
577
578 To make it
579 possible to get best performance from NVIDIA Tesla and Quadro GPUs,
580 you should install the `GPU Deployment Kit
581 <https://developer.nvidia.com/gpu-deployment-kit>`_ and configure
582 |Gromacs| to use it by setting the CMake variable
583 ``-DGPU_DEPLOYMENT_KIT_ROOT_DIR=/path/to/your/kit``. The NVML support
584 is most useful if
585 ``nvidia-smi --applications-clocks-permission=UNRESTRICTED`` is run
586 (as root). When application clocks permissions are unrestricted, the
587 GPU clock speed can be increased automatically, which increases the
588 GPU kernel performance roughly proportional to the clock
589 increase. When using |Gromacs| on suitable GPUs under restricted
590 permissions, clocks cannot be changed, and in that case informative
591 log file messages will be produced. Background details can be found at
592 this `NVIDIA blog post
593 <http://devblogs.nvidia.com/parallelforall/increase-performance-gpu-boost-k80-autoboost/>`_.
594 NVML support is only available if detected, and may be disabled by
595 turning off the ``GMX_USE_NVML`` CMake advanced option.
596
597 By default, optimized code will be generated for CUDA architectures
598 supported by the nvcc compiler (and the |Gromacs| build system). 
599 However, it can be beneficial to manually pick the specific CUDA architecture(s)
600 to generate code for either to reduce compilation time (and binary size) or to
601 target a new architecture not yet supported by the |GROMACS| build system.
602 Setting the desired CUDA architecture(s) and virtual architecture(s)
603 can be done using the ``GMX_CUDA_TARGET_SM`` and ``GMX_CUDA_TARGET_COMPUTE``
604 variables, respectively. These take a semicolon delimited string with 
605 the two digit suffixes of CUDA (virtual) architectures names
606 (for details see the "Options for steering GPU code generation" section of the
607 nvcc man / help or Chapter 6. of the nvcc manual).
608
609 The GPU acceleration has been tested on AMD64/x86-64 platforms with
610 Linux, Mac OS X and Windows operating systems, but Linux is the
611 best-tested and supported of these. Linux running on POWER 8, ARM v7 and v8
612 CPUs also works well.
613
614 OpenCL GPU acceleration
615 ^^^^^^^^^^^^^^^^^^^^^^^
616
617 The primary target of the |Gromacs| OpenCL support is accelerating simulations
618 on AMD hardware, both discrete GPUs and APUs (integrated CPU+GPU chips).
619 The |Gromacs| OpenCL on NVIDIA GPUs works, but performance
620 and other limitations make it less practical (for details see the user guide).
621
622 To build |Gromacs| with OpenCL_ support enabled, two components are
623 required: the OpenCL_ headers and the wrapper library that acts
624 as a client driver loader (so-called ICD loader).
625 The additional, runtime-only dependency is the vendor-specific GPU driver
626 for the device targeted. This also contains the OpenCL_ compiler.
627 As the GPU compute kernels are compiled  on-demand at run time,
628 this vendor-specific compiler and driver is not needed for building |Gromacs|.
629 The former, compile-time dependencies are standard components,
630 hence stock versions can be obtained from most Linux distribution
631 repositories (e.g. ``opencl-headers`` and ``ocl-icd-libopencl1`` on Debian/Ubuntu).
632 Only the compatibility with the required OpenCL_ version |REQUIRED_OPENCL_MIN_VERSION|
633 needs to be ensured.
634 Alternatively, the headers and library can also be obtained from vendor SDKs
635 (e.g. `from AMD <http://developer.amd.com/appsdk>`_),
636 which must be installed in a path found in ``CMAKE_PREFIX_PATH`` (or via the environment
637 variables ``AMDAPPSDKROOT`` or ``CUDA_PATH``).
638
639 To trigger an OpenCL_ build the following CMake flags must be set
640
641 ::
642
643     cmake .. -DGMX_GPU=ON -DGMX_USE_OPENCL=ON
644
645 On Mac OS, an AMD GPU can be used only with OS version 10.10.4 and
646 higher; earlier OS versions are known to run incorrectly.
647
648 Static linking
649 ^^^^^^^^^^^^^^
650 Dynamic linking of the |Gromacs| executables will lead to a
651 smaller disk footprint when installed, and so is the default on
652 platforms where we believe it has been tested repeatedly and found to work.
653 In general, this includes Linux, Windows, Mac OS X and BSD systems.
654 Static binaries take more space, but on some hardware and/or under
655 some conditions they are necessary, most commonly when you are running a parallel
656 simulation using MPI libraries (e.g. BlueGene, Cray).
657
658 * To link |Gromacs| binaries statically against the internal |Gromacs|
659   libraries, set ``-DBUILD_SHARED_LIBS=OFF``.
660 * To link statically against external (non-system) libraries as well,
661   set ``-DGMX_PREFER_STATIC_LIBS=ON``. Note, that in
662   general ``cmake`` picks up whatever is available, so this option only
663   instructs ``cmake`` to prefer static libraries when both static and
664   shared are available. If no static version of an external library is
665   available, even when the aforementioned option is ``ON``, the shared
666   library will be used. Also note that the resulting binaries will
667   still be dynamically linked against system libraries on platforms
668   where that is the default. To use static system libraries,
669   additional compiler/linker flags are necessary, e.g. ``-static-libgcc
670   -static-libstdc++``.
671 * To attempt to link a fully static binary set
672   ``-DGMX_BUILD_SHARED_EXE=OFF``. This will prevent CMake from explicitly
673   setting any dynamic linking flags. This option also sets
674   ``-DBUILD_SHARED_LIBS=OFF`` and ``-DGMX_PREFER_STATIC_LIBS=ON`` by
675   default, but the above caveats apply. For compilers which don't
676   default to static linking, the required flags have to be specified. On
677   Linux, this is usually ``CFLAGS=-static CXXFLAGS=-static``.
678
679 Portability aspects
680 ^^^^^^^^^^^^^^^^^^^
681 A |Gromacs| build will normally not be portable, not even across
682 hardware with the same base instruction set, like x86. Non-portable
683 hardware-specific optimizations are selected at configure-time, such
684 as the SIMD instruction set used in the compute kernels. This
685 selection will be done by the build system based on the capabilities
686 of the build host machine or otherwise specified to ``cmake`` during
687 configuration.
688
689 Often it is possible to ensure portability by choosing the least
690 common denominator of SIMD support, e.g. SSE2 for x86, and ensuring
691 the you use ``cmake -DGMX_USE_RDTSCP=off`` if any of the target CPU
692 architectures does not support the ``RDTSCP`` instruction.  However, we
693 discourage attempts to use a single |Gromacs| installation when the
694 execution environment is heterogeneous, such as a mix of AVX and
695 earlier hardware, because this will lead to programs (especially
696 mdrun) that run slowly on the new hardware. Building two full
697 installations and locally managing how to call the correct one
698 (e.g. using a module system) is the recommended
699 approach. Alternatively, as at the moment the |Gromacs| tools do not
700 make strong use of SIMD acceleration, it can be convenient to create
701 an installation with tools portable across different x86 machines, but
702 with separate mdrun binaries for each architecture. To achieve this,
703 one can first build a full installation with the
704 least-common-denominator SIMD instruction set, e.g. ``-DGMX_SIMD=SSE2``,
705 then build separate mdrun binaries for each architecture present in
706 the heterogeneous environment. By using custom binary and library
707 suffixes for the mdrun-only builds, these can be installed to the
708 same location as the "generic" tools installation.
709 `Building just the mdrun binary`_ is possible by setting the
710 ``-DGMX_BUILD_MDRUN_ONLY=ON`` option.
711
712 Linear algebra libraries
713 ^^^^^^^^^^^^^^^^^^^^^^^^
714 As mentioned above, sometimes vendor BLAS and LAPACK libraries
715 can provide performance enhancements for |Gromacs| when doing
716 normal-mode analysis or covariance analysis. For simplicity, the text
717 below will refer only to BLAS, but the same options are available
718 for LAPACK. By default, CMake will search for BLAS, use it if it
719 is found, and otherwise fall back on a version of BLAS internal to
720 |Gromacs|. The ``cmake`` option ``-DGMX_EXTERNAL_BLAS=on`` will be set
721 accordingly. The internal versions are fine for normal use. If you
722 need to specify a non-standard path to search, use
723 ``-DCMAKE_PREFIX_PATH=/path/to/search``. If you need to specify a
724 library with a non-standard name (e.g. ESSL on AIX or BlueGene), then
725 set ``-DGMX_BLAS_USER=/path/to/reach/lib/libwhatever.a``.
726
727 If you are using Intel MKL_ for FFT, then the BLAS and
728 LAPACK it provides are used automatically. This could be
729 over-ridden with ``GMX_BLAS_USER``, etc.
730
731 On Apple platforms where the Accelerate Framework is available, these
732 will be automatically used for BLAS and LAPACK. This could be
733 over-ridden with ``GMX_BLAS_USER``, etc.
734
735 Changing the names of |Gromacs| binaries and libraries
736 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
737 It is sometimes convenient to have different versions of the same
738 |Gromacs| programs installed. The most common use cases have been single
739 and double precision, and with and without MPI. This mechanism can
740 also be used to install side-by-side multiple versions of mdrun
741 optimized for different CPU architectures, as mentioned previously.
742
743 By default, |Gromacs| will suffix programs and libraries for such builds
744 with ``_d`` for double precision and/or ``_mpi`` for MPI (and nothing
745 otherwise). This can be controlled manually with ``GMX_DEFAULT_SUFFIX
746 (ON/OFF)``, ``GMX_BINARY_SUFFIX`` (takes a string) and ``GMX_LIBS_SUFFIX``
747 (also takes a string). For instance, to set a custom suffix for
748 programs and libraries, one might specify:
749
750 ::
751
752     cmake .. -DGMX_DEFAULT_SUFFIX=OFF -DGMX_BINARY_SUFFIX=_mod -DGMX_LIBS_SUFFIX=_mod
753
754 Thus the names of all programs and libraries will be appended with
755 ``_mod``.
756
757 Changing installation tree structure
758 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
759 By default, a few different directories under ``CMAKE_INSTALL_PREFIX`` are used
760 when when |Gromacs| is installed. Some of these can be changed, which is mainly
761 useful for packaging |Gromacs| for various distributions. The directories are
762 listed below, with additional notes about some of them. Unless otherwise noted,
763 the directories can be renamed by editing the installation paths in the main
764 CMakeLists.txt.
765
766 ``bin/``
767     The standard location for executables and some scripts.
768     Some of the scripts hardcode the absolute installation prefix, which needs
769     to be changed if the scripts are relocated.
770 ``include/gromacs/``
771     The standard location for installed headers.
772 ``lib/``
773     The standard location for libraries. The default depends on the system, and
774     is determined by CMake.
775     The name of the directory can be changed using ``GMX_LIB_INSTALL_DIR`` CMake
776     variable.
777 ``lib/pkgconfig/``
778     Information about the installed ``libgromacs`` library for ``pkg-config`` is
779     installed here.  The ``lib/`` part adapts to the installation location of the
780     libraries.  The installed files contain the installation prefix as absolute
781     paths.
782 ``share/cmake/``
783     CMake package configuration files are installed here.
784 ``share/gromacs/``
785     Various data files and some documentation go here.
786     The ``gromacs`` part can be changed using ``GMX_DATA_INSTALL_DIR``. Using this
787     CMake variable is the preferred way of changing the installation path for
788     ``share/gromacs/top/``, since the path to this directory is built into
789     ``libgromacs`` as well as some scripts, both as a relative and as an absolute
790     path (the latter as a fallback if everything else fails).
791 ``share/man/``
792     Installed man pages go here.
793
794 Compiling and linking
795 ---------------------
796 Once you have configured with ``cmake``, you can build |Gromacs| with ``make``.
797 It is expected that this will always complete successfully, and
798 give few or no warnings. The CMake-time tests |Gromacs| makes on the settings
799 you choose are pretty extensive, but there are probably a few cases we
800 have not thought of yet. Search the web first for solutions to
801 problems, but if you need help, ask on gmx-users, being sure to
802 provide as much information as possible about what you did, the system
803 you are building on, and what went wrong. This may mean scrolling back
804 a long way through the output of ``make`` to find the first error
805 message!
806
807 If you have a multi-core or multi-CPU machine with ``N``
808 processors, then using
809
810 ::
811
812     make -j N
813
814 will generally speed things up by quite a bit. Other build generator systems
815 supported by ``cmake`` (e.g. ``ninja``) also work well.
816
817 .. _building just the mdrun binary:
818
819 Building only mdrun
820 ^^^^^^^^^^^^^^^^^^^
821
822 This is now supported with the ``cmake`` option
823 ``-DGMX_BUILD_MDRUN_ONLY=ON``, which will build a different version of
824 ``libgromacs`` and the ``mdrun`` program.
825 Naturally, now ``make install`` installs only those
826 products. By default, mdrun-only builds will default to static linking
827 against |Gromacs| libraries, because this is generally a good idea for
828 the targets for which an mdrun-only build is desirable.
829
830 Installing |Gromacs|
831 --------------------
832 Finally, ``make install`` will install |Gromacs| in the
833 directory given in ``CMAKE_INSTALL_PREFIX``. If this is a system
834 directory, then you will need permission to write there, and you
835 should use super-user privileges only for ``make install`` and
836 not the whole procedure.
837
838 .. _getting access to GROMACS:
839
840 Getting access to |Gromacs| after installation
841 ----------------------------------------------
842 |Gromacs| installs the script ``GMXRC`` in the ``bin``
843 subdirectory of the installation directory
844 (e.g. ``/usr/local/gromacs/bin/GMXRC``), which you should source
845 from your shell:
846
847 ::
848
849     source /your/installation/prefix/here/bin/GMXRC
850
851 It will detect what kind of shell you are running and set up your
852 environment for using |Gromacs|. You may wish to arrange for your
853 login scripts to do this automatically; please search the web for
854 instructions on how to do this for your shell. 
855
856 Many of the |Gromacs| programs rely on data installed in the
857 ``share/gromacs`` subdirectory of the installation directory. By
858 default, the programs will use the environment variables set in the
859 ``GMXRC`` script, and if this is not available they will try to guess the
860 path based on their own location.  This usually works well unless you
861 change the names of directories inside the install tree. If you still
862 need to do that, you might want to recompile with the new install
863 location properly set, or edit the ``GMXRC`` script.
864
865 Testing |Gromacs| for correctness
866 ---------------------------------
867 Since 2011, the |Gromacs| development uses an automated system where
868 every new code change is subject to regression testing on a number of
869 platforms and software combinations. While this improves
870 reliability quite a lot, not everything is tested, and since we
871 increasingly rely on cutting edge compiler features there is
872 non-negligible risk that the default compiler on your system could
873 have bugs. We have tried our best to test and refuse to use known bad
874 versions in ``cmake``, but we strongly recommend that you run through
875 the tests yourself. It only takes a few minutes, after which you can
876 trust your build.
877
878 The simplest way to run the checks is to build |Gromacs| with
879 ``-DREGRESSIONTEST_DOWNLOAD``, and run ``make check``.
880 |Gromacs| will automatically download and run the tests for you.
881 Alternatively, you can download and unpack the GROMACS
882 regression test suite |gmx-regressiontests-package| tarball yourself
883 and use the advanced ``cmake`` option ``REGRESSIONTEST_PATH`` to
884 specify the path to the unpacked tarball, which will then be used for
885 testing. If the above does not work, then please read on.
886
887 The regression tests are also available from the download_ section.
888 Once you have downloaded them, unpack the tarball, source
889 ``GMXRC`` as described above, and run ``./gmxtest.pl all``
890 inside the regression tests folder. You can find more options
891 (e.g. adding ``double`` when using double precision, or
892 ``-only expanded`` to run just the tests whose names match
893 "expanded") if you just execute the script without options.
894
895 Hopefully, you will get a report that all tests have passed. If there
896 are individual failed tests it could be a sign of a compiler bug, or
897 that a tolerance is just a tiny bit too tight. Check the output files
898 the script directs you too, and try a different or newer compiler if
899 the errors appear to be real. If you cannot get it to pass the
900 regression tests, you might try dropping a line to the gmx-users
901 mailing list, but then you should include a detailed description of
902 your hardware, and the output of ``gmx mdrun -version`` (which contains
903 valuable diagnostic information in the header).
904
905 A build with ``-DGMX_BUILD_MDRUN_ONLY`` cannot be tested with
906 ``make check`` from the build tree, because most of the tests
907 require a full build to run things like ``grompp``. To test such an
908 mdrun fully requires installing it to the same location as a normal
909 build of |Gromacs|, downloading the regression tests tarball manually
910 as described above, sourcing the correct ``GMXRC`` and running the
911 perl script manually. For example, from your |Gromacs| source
912 directory:
913
914 ::
915
916     mkdir build-normal
917     cd build-normal
918     cmake .. -DCMAKE_INSTALL_PREFIX=/your/installation/prefix/here
919     make -j 4
920     make install
921     cd ..
922     mkdir build-mdrun-only
923     cd build-mdrun-only
924     cmake .. -DGMX_MPI=ON -DGMX_GPU=ON -DGMX_BUILD_MDRUN_ONLY=ON -DCMAKE_INSTALL_PREFIX=/your/installation/prefix/here
925     make -j 4
926     make install
927     cd /to/your/unpacked/regressiontests
928     source /your/installation/prefix/here/bin/GMXRC
929     ./gmxtest.pl all -np 2
930
931 If your mdrun program has been suffixed in a non-standard way, then
932 the ``./gmxtest.pl -mdrun`` option will let you specify that name to the
933 test machinery. You can use ``./gmxtest.pl -double`` to test the
934 double-precision version. You can use ``./gmxtest.pl -crosscompiling``
935 to stop the test harness attempting to check that the programs can
936 be run. You can use ``./gmxtest.pl -mpirun srun`` if your command to
937 run an MPI program is called ``srun``.
938
939 The ``make check`` target also runs integration-style tests that may run
940 with MPI if ``GMX_MPI=ON`` was set. To make these work with various possible
941 MPI libraries, you may need to
942 set the CMake variables ``MPIEXEC``, ``MPIEXEC_NUMPROC_FLAG``,
943 ``MPIEXEC_PREFLAGS`` and ``MPIEXEC_POSTFLAGS`` so that
944 ``mdrun-mpi-test_mpi`` would run on multiple ranks via the shell command
945
946 ::
947
948     ${MPIEXEC} ${MPIEXEC_NUMPROC_FLAG} ${NUMPROC} ${MPIEXEC_PREFLAGS} \
949           mdrun-mpi-test_mpi ${MPIEXEC_POSTFLAGS} -otherflags
950
951 A typical example for SLURM is
952
953 ::
954
955      cmake .. -DGMX_MPI=on -DMPIEXEC=srun -DMPIEXEC_NUMPROC_FLAG=-n -DMPIEXEC_PREFLAGS= -DMPIEXEC_POSTFLAGS=
956
957
958 Testing |Gromacs| for performance
959 ---------------------------------
960 We are still working on a set of benchmark systems for testing
961 the performance of |Gromacs|. Until that is ready, we recommend that
962 you try a few different parallelization options, and experiment with
963 tools such as ``gmx tune_pme``.
964
965 Having difficulty?
966 ------------------
967 You are not alone - this can be a complex task! If you encounter a
968 problem with installing |Gromacs|, then there are a number of
969 locations where you can find assistance. It is recommended that you
970 follow these steps to find the solution:
971
972 1. Read the installation instructions again, taking note that you
973    have followed each and every step correctly.
974
975 2. Search the |Gromacs| webpage_ and users emailing list for information
976    on the error. Adding
977    ``site:https://mailman-1.sys.kth.se/pipermail/gromacs.org_gmx-users``
978    to a Google search may help filter better results.
979
980 3. Search the internet using a search engine such as Google.
981
982 4. Post to the |Gromacs| users emailing list gmx-users for
983    assistance. Be sure to give a full description of what you have
984    done and why you think it did not work. Give details about the
985    system on which you are installing.  Copy and paste your command
986    line and as much of the output as you think might be relevant -
987    certainly from the first indication of a problem. In particular,
988    please try to include at least the header from the mdrun logfile,
989    and preferably the entire file.  People who might volunteer to help
990    you do not have time to ask you interactive detailed follow-up
991    questions, so you will get an answer faster if you provide as much
992    information as you think could possibly help. High quality bug
993    reports tend to receive rapid high quality answers.
994
995 Special instructions for some platforms
996 =======================================
997
998 Building on Windows
999 -------------------
1000 Building on Windows using native compilers is rather similar to
1001 building on Unix, so please start by reading the above. Then, download
1002 and unpack the |Gromacs| source archive. Make a folder in which to do
1003 the out-of-source build of |Gromacs|. For example, make it within the
1004 folder unpacked from the source archive, and call it ``build-gromacs``.
1005
1006 For CMake, you can either use the graphical user interface provided on
1007 Windows, or you can use a command line shell with instructions similar
1008 to the UNIX ones above. If you open a shell from within your IDE
1009 (e.g. Microsoft Visual Studio), it will configure the environment for
1010 you, but you might need to tweak this in order to get either a 32-bit
1011 or 64-bit build environment. The latter provides the fastest
1012 executable. If you use a normal Windows command shell, then you will
1013 need to either set up the environment to find your compilers and
1014 libraries yourself, or run the ``vcvarsall.bat`` batch script provided
1015 by MSVC (just like sourcing a bash script under Unix).
1016
1017 With the graphical user interface, you will be asked about what
1018 compilers to use at the initial configuration stage, and if you use
1019 the command line they can be set in a similar way as under UNIX.
1020
1021 Unfortunately ``-DGMX_BUILD_OWN_FFTW=ON`` (see `Using FFTW`_) does not
1022 work on Windows, because there is no supported way to build FFTW on
1023 Windows. You can either build FFTW some other way (e.g. MinGW), or
1024 use the built-in fftpack (which may be slow), or `using MKL`_.
1025
1026 For the build, you can either load the generated solutions file into
1027 e.g. Visual Studio, or use the command line with ``cmake --build`` so
1028 the right tools get used.
1029
1030 Building on Cray
1031 ----------------
1032 |Gromacs| builds mostly out of the box on modern Cray machines, but
1033 you may need to specify the use of static binaries with
1034 ``-DGMX_BUILD_SHARED_EXE=off``, and you may need to set the F77
1035 environmental variable to ``ftn`` when compiling FFTW.
1036
1037 Building on BlueGene
1038 --------------------
1039
1040 BlueGene/Q
1041 ^^^^^^^^^^
1042 There is currently native acceleration on this platform for the Verlet
1043 cut-off scheme. There are no plans to provide accelerated kernels for
1044 the group cut-off scheme, but the default plain C kernels will work
1045 (slowly).
1046
1047 Only the bgclang compiler is supported, because it is the only
1048 availble C++11 compiler. Only static linking is supported.
1049
1050 Computation on BlueGene floating-point units is always done in
1051 double-precision. However, mixed-precision builds of |Gromacs| are still
1052 normal and encouraged since they use cache more efficiently.
1053
1054 You need to arrange for FFTW to be installed correctly, following the
1055 above instructions. You may prefer to configure FFTW with
1056 ``--disable-fortran`` to avoid complications.
1057
1058 MPI wrapper compilers should be used for compiling and linking. The
1059 MPI wrapper compilers can make it awkward to
1060 attempt to use IBM's optimized BLAS/LAPACK called ESSL (see the
1061 section on `linear algebra libraries`_. Since mdrun is the only part
1062 of |Gromacs| that should normally run on the compute nodes, and there is
1063 nearly no need for linear algebra support for mdrun, it is recommended
1064 to use the |Gromacs| built-in linear algebra routines - this is never
1065 a problem for normal simulations.
1066
1067 The recommended configuration is to use
1068
1069 ::
1070
1071     cmake .. -DCMAKE_C_COMPILER=mpicc \
1072              -DCMAKE_CXX_COMPILER=mpicxx \
1073              -DCMAKE_TOOLCHAIN_FILE=Platform/BlueGeneQ-static-bgclang-CXX.cmake \
1074              -DCMAKE_PREFIX_PATH=/your/fftw/installation/prefix \
1075              -DGMX_MPI=ON \
1076              -DGMX_BUILD_MDRUN_ONLY=ON
1077     make
1078     make install
1079
1080 which will build a statically-linked MPI-enabled mdrun for the compute
1081 nodes. Otherwise, |Gromacs| default configuration
1082 behaviour applies.
1083
1084 It is possible to configure and make the remaining |Gromacs| tools with
1085 the compute-node toolchain, but as none of those tools are MPI-aware,
1086 this would not normally
1087 be useful. Instead, users should plan to run these on the login node,
1088 and perform a separate |Gromacs| installation for that, using the login
1089 node's toolchain - not the above platform file, or any other
1090 compute-node toolchain. This may require requesting an up-to-date
1091 gcc or clang toolchain for the front end.
1092
1093 Note that only the MPI build is available for the compute-node
1094 toolchains. The |Gromacs| thread-MPI or no-MPI builds are not useful at
1095 all on BlueGene/Q.
1096
1097 BlueGene/P
1098 ^^^^^^^^^^
1099 There is currently no SIMD support on this platform and no plans to
1100 add it. The default plain C kernels will work if there is a C++11
1101 compiler for this platform.
1102
1103 Fujitsu PRIMEHPC
1104 ^^^^^^^^^^^^^^^^
1105 This is the architecture of the K computer, which uses Fujitsu
1106 Sparc64VIIIfx chips. On this platform, |Gromacs| has
1107 accelerated group kernels using the HPC-ACE instructions, no
1108 accelerated Verlet kernels, and a custom build toolchain. Since this
1109 particular chip only does double precision SIMD, the default setup
1110 is to build |Gromacs| in double. Since most users only need single, we have added
1111 an option GMX_RELAXED_DOUBLE_PRECISION to accept single precision square root
1112 accuracy in the group kernels; unless you know that you really need 15 digits
1113 of accuracy in each individual force, we strongly recommend you use this. Note
1114 that all summation and other operations are still done in double.
1115
1116 The recommended configuration is to use
1117
1118 ::
1119
1120     cmake .. -DCMAKE_TOOLCHAIN_FILE=Toolchain-Fujitsu-Sparc64-mpi.cmake \
1121              -DCMAKE_PREFIX_PATH=/your/fftw/installation/prefix \
1122              -DCMAKE_INSTALL_PREFIX=/where/gromacs/should/be/installed \
1123              -DGMX_MPI=ON \
1124              -DGMX_BUILD_MDRUN_ONLY=ON \
1125              -DGMX_RELAXED_DOUBLE_PRECISION=ON
1126     make
1127     make install
1128
1129 Intel Xeon Phi
1130 ^^^^^^^^^^^^^^
1131 |Gromacs| has preliminary support for Intel Xeon Phi. Only symmetric
1132 (aka native) mode is supported on Knights Corner, and it has so far
1133 not been optimized to the same level as other architectures. The
1134 performance depends among other factors on the system size, and for
1135 now the performance might not be faster than CPUs. Building for Xeon
1136 Phi works almost as any other Unix. See the instructions above for
1137 details. The recommended configuration is
1138
1139 ::
1140
1141     cmake .. -DCMAKE_TOOLCHAIN_FILE=Platform/XeonPhi
1142     make
1143     make install
1144
1145 Tested platforms
1146 ================
1147 While it is our best belief that |Gromacs| will build and run pretty
1148 much everywhere, it is important that we tell you where we really know
1149 it works because we have tested it. We do test on Linux, Windows, and
1150 Mac with a range of compilers and libraries for a range of our
1151 configuration options. Every commit in our git source code repository
1152 is currently tested on x86 with a number of gcc versions ranging from 4.8.1
1153 through 6.1, versions 16 of the Intel compiler, and Clang
1154 versions 3.4 through 3.8. For this, we use a variety of GNU/Linux
1155 flavors and versions as well as recent versions of Windows. Under
1156 Windows, we test both MSVC 2015 and version 16 of the Intel compiler.
1157 For details, you can
1158 have a look at the `continuous integration server used by GROMACS`_,
1159 which runs Jenkins_.
1160
1161 We test irregularly on ARM v7, ARM v8, BlueGene/Q, Cray, Fujitsu
1162 PRIMEHPC, Power8, Google Native Client and other environments, and
1163 with other compilers and compiler versions, too.