ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/README
Revision: 2079
Committed: Tue Mar 10 15:20:28 2015 UTC (10 years, 1 month ago) by gezelter
File size: 3198 byte(s)
Log Message:
Updated some of the root-level text files for 2.3 release

File Contents

# Content
1 What is OpenMD?
2
3 OpenMD is an open source molecular dynamics engine which is capable of
4 efficiently simulating liquids, proteins, nanoparticles, interfaces,
5 and other complex systems using atom types with orientational degrees
6 of freedom (e.g. "sticky" atoms, point dipoles, and coarse-grained
7 assemblies). Proteins, zeolites, lipids, transition metals (bulk, flat
8 interfaces, and nanoparticles) have all been simulated using force
9 fields included with the code. OpenMD works on parallel computers
10 using the Message Passing Interface (MPI), and comes with a number of
11 analysis and utility programs that are easy to use and modify. An
12 OpenMD simulation is specified using a very simple meta-data language
13 that is easy to learn.
14
15 Simulations are started in OpenMD using a single Molecular Dynamics (.md)
16 file. These files must start with the <OpenMD> tag and must have two
17 sections:
18
19 1) a C-based <MetaData> section, and
20
21 2) a <Snapshot> block for initial coordinate and velocity information.
22
23 Detailed descriptions of the structures of these files are available
24 in the "doc" directory. Sample simulations are available in the
25 "samples" directory.
26
27 What you need to compile and use OpenMD:
28
29 1) A good C++ compiler. We've built and tested OpenMD on the
30 following architecture & compiler combinations:
31
32 Architecture CXX Notes
33 ------------------------- ---- ----------------------
34 Mac OS X 10.10 (intel) c++ (Apple LLVM version 6.0, Open MPI 1.7.5)
35 Mac OS X 10.10 (intel) g++ (GNU version 4.8.3)
36 Mac OS X 10.10 (intel) icpc (Intel version 14.0.2)
37 Linux (Ubuntu 13 – x86_64) g++ (GNU version 4.8.1, Open MPI 1.4.5)
38 Linux (RHEL 6.6 - x86_64) icpc (Intel version 14.0, Open MPI 1.6.5)
39 Linux (RHEL 6.6 - x86_64) pgCC (Portland Group version 14.6)
40
41 OpenMD uses features in the standard template library (STL). Most
42 (but not all) C++ compilers support these features.
43
44 2) CMake, a cross-platform build system which is available at
45 http://www.cmake.org Most Linux and some Unix distributions
46 provide CMake as a standard package. If not, please download it,
47 and make sure you get a recent version. Mac OS X users can either
48 download the CMake installer or install it from the command line
49 using macports.
50
51 3) An implementation of MPI-2 is optional for the single processor
52 version of OpenMD, but is required if you want OpenMD to run in
53 parallel. We like OpenMPI. Other implementations of MPI-2 might
54 work, but we haven't tried. You can get Open MPI here:
55 http://www.open-mpi.org/
56
57 4) Other optional (but quite useful) libraries that will unlock some
58 features of OpenMD:
59
60 Open Babel: http://openbabel.org
61 Qhull: http://www.qhull.org
62 FFTW: http://www.fftw.org
63 Doxygen: http://www.doxygen.org
64
65 5) Some of the utility scripts depend on Python and Perl. These
66 interpreters are common installations on most flavors of Unix and
67 Mac OS X.
68
69 INSTRUCTIONS
70
71 1) Get, build, and test the required pieces above.
72 2) mkdir build
73 3) cd build
74 4) cmake ..
75 5) make
76 6) umask 0022; sudo make install
77
78 That's it.