Merge branch 'release-4-5-patches' of git.gromacs.org:gromacs into release-4-5-patches
[gromacs.git] / INSTALL-GPU
blob08c5b248be2dd68e30395a487849430287dd9c00
2                     Welcome to GROMACS-GPU!
4 Note: Detailed, step-by-step installation instructions as 
5 well as additional information are available on the website 
6 http://www.gromacs.org/gpu
9 * INSTALLING FROM BINARY DISTRIBUTION:
11 0. Prerequisites: 
12     - OpenMM (included in the binary release)
13     - NVIDIA CUDA libraries (version >=3.0);
14     - NVIDIA driver (for details on compatiblity consult
15           http://www.nvidia.com/Download/index5.aspx);
16     - NVIDIA CUDA-enabled GPU (for compatiblity list see 
17           http://www.gromacs.org/gpu).
20 1. Download and unpack the binary package for the respective 
21 OS and architecture. Copy the content of the package to your 
22 normal GROMACS installation directory (or to a custom location). 
23 Note that as the distributed Gromacs-GPU packages do not contain 
24 the entire set of tools and utilities included in a full GROAMCS 
25 installation. Therefore, it is recommended to have a ≥v4.5 
26 standard Gromacs installation along the GPU accelerated one.
27 e.g. on unix: 
29 tar -xvf gromacs-4.5-GPU.tar.gz
30 cp -R gromacs-4.5-GPU/* PATH_TO_GROMACS_INSTALLATION
33 2. Add the openmm/lib directory to your library path, e.g. in bash:
35 export LD_LIBRARY_PATH=PATH_TO_GROMACS/openmm/lib:$LD_LIBRARY_PATH
37 If there are other OpenMM versions installed, make sure that the 
38 supplied libraries have preference when running mdrun-gpu. 
39 Also, make sure that the CUDA libraries installed match the version 
40 of CUDA with which GROMACS-GPU is compiled.
43 3. Set the OPENMM_PLUGIN_DIR environment variable to contain the path 
44 to the openmm/lib/plugins directory, e.g. in bash:
46 export OPENMM_PLUGIN_DIR=PATH_TO_GROMACS/openmm/lib/plugins
49 4. At this point, running the command: 
51 PATH_TO_GROMACS/bin/mdrun-gpu -h 
53 should display the standard mdrun help which means that all the 
54 necessary libraries are accessible.
58 * INSTALLING FROM SOURCE DISTRIBUTION:
60 GROMACS-GPU uses a cmake build-generator and makefiles on unix. 
61 This means your normal installation actions are limited to:
63 cmake PATH_TO_SOURCE_DIRECTORY -DGMX_OPENMM=ON -DGMX_THREADS=OFF 
64 make mdrun
65 make install-mdrun
69 * ARE YOU STILL HAVING PROBLEMS?
71 Post it to the GROMACS mailing lists. We read these on a regular basis,
72 and in many cases another user might already be familiar with the
73 task you're trying to perform!