ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/README
Revision: 1632
Committed: Wed Sep 14 21:44:08 2011 UTC (13 years, 8 months ago) by gezelter
File size: 2299 byte(s)
Log Message:
cleaning up configure script & readme

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
17 have two 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
24 available in the "doc" directory. Sample simulations are
25 available in the "samples" directory.
26
27 What you need to compile and use OpenMD:
28
29 1) Good C++ and C compilers. We've built and tested OpenMD
30 on the following architecture & compiler combinations:
31
32 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
39 2) GNU make (also known as gmake). Regular make won't work.
40 Really. We've tried. Don't bother with regular make.
41 Seriously. You need GNU make. Did we mention that you
42 need GNU make?
43
44 3) Perl.
45
46 4) 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 tried. You can get Open MPI here: http://www.open-mpi.org/
50
51 INSTRUCTIONS
52
53 1) Get, build, and test the required pieces above.
54 2) ./configure
55 3) make
56 4) make install
57
58 That's it.