ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/trunk/README
Revision: 1782
Committed: Wed Aug 22 02:28:28 2012 UTC (12 years, 9 months ago) by gezelter
File size: 2885 byte(s)
Log Message:
MERGE OpenMD development branch 1465:1781 into trunk

File Contents

# User Rev Content
1 gezelter 1394 What is OpenMD?
2 gezelter 2
3 gezelter 1390 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 gezelter 2
15 gezelter 1390 Simulations are started in OpenMD using a single Molecular Dynamics (.md)
16     file. These files must start with the <OpenMD> tag and must
17 gezelter 1055 have two sections:
18 gezelter 2
19 gezelter 1055 1) a C-based <MetaData> section, and
20 gezelter 2
21 gezelter 1055 2) a <Snapshot> block for initial coordinate and velocity information.
22 gezelter 2
23 gezelter 1055 Detailed descriptions of the structures of these files are
24 gezelter 2 available in the "doc" directory. Sample simulations are
25     available in the "samples" directory.
26    
27 gezelter 1390 What you need to compile and use OpenMD:
28 gezelter 2
29 gezelter 1782 1) Good C++ and C compilers. We've built and tested OpenMD
30 gezelter 2 on the following architecture & compiler combinations:
31    
32 gezelter 1782 Architecture CC CXX Notes
33     ------------------------- ---- ----- ----------------------
34     ix86-pc-linux-gnu icc icpc (Intel v. 10)
35     i386-apple-darwin11.1.0 gcc g++ (GNU v.4.3)
36     i386-apple-darwin11.1.0 icc icpc (Intel v. 12)
37     x86_64-unknown-linux-gnu gcc g++ (Pathscale 3.2)
38 gezelter 1390
39 gezelter 1782 2) CMake, a cross-platform build system which is available at
40     http://www.cmake.org Most Linux and some Unix distributions
41     provide CMake as a standard package. If not, please download it,
42     and make sure you get a recent version. Mac OS X users can either
43     download the CMake installer or install it from the command line
44     using macports.
45 gezelter 2
46 gezelter 1782 3) MPI-2 is optional for the single processor version of OpenMD, but
47     is required if you want OpenMD to run in parallel. We like
48     OpenMPI. Other implementations of MPI-2 might work, but we haven't
49     tested them. You can get Open MPI here: http://www.open-mpi.org/
50 gezelter 873
51 gezelter 1782 4) Other optional (but quite useful) libraries that will unlock some
52     features of OpenMD:
53 gezelter 873
54 gezelter 1782 Open Babel: http://openbabel.org
55     Qhull: http://www.qhull.org
56     FFTW: http://www.fftw.org
57     Doxygen: http://www.doxygen.org
58 gezelter 2
59 gezelter 1782 5) Some of the utility scripts depend on Python and Perl. These
60     interpreters are common installations on most flavors of Unix and
61     Mac OS X.
62 gezelter 508
63    
64 gezelter 2 INSTRUCTIONS
65    
66     1) Get, build, and test the required pieces above.
67 gezelter 1782 2) mkdir build
68     3) cd build
69     4) cmake ..
70     5) make
71     6) sudo make install
72 gezelter 2
73 gezelter 508 That's it.