ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/OpenMD/branches/development/README
(Generate patch)

Comparing:
trunk/README (file contents), Revision 1055 by gezelter, Tue Sep 26 21:55:29 2006 UTC vs.
branches/development/README (file contents), Revision 1639 by gezelter, Sat Sep 24 20:18:07 2011 UTC

# Line 1 | Line 1
1 < OOPSE
1 > What is OpenMD?
2  
3 < OOPSE is an open-source Object-Oriented Parallel Simulation Engine.
4 < It is primarily used to perform molecular dynamics simulations on
5 < "strange" atom types that are not normally handled by other simulation
6 < packages.  This includes atoms with orientational degrees of freedom
7 < (point dipoles, sticky atoms), as well as transition metals under the
8 < Embedded Atom Method (EAM) or Sutton-Chen (SC) potentials.
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 OOPSE using a single Molecular Dynamics (.md)
16 < file.   These files must start with the <OOPSE> tag and must
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
# Line 19 | Line 24 | available in the "samples" directory.
24   available in the "doc" directory.  Sample simulations are
25   available in the "samples" directory.
26  
27 < What you need to compile and use OOPSE:
27 > What you need to compile and use OpenMD:
28  
29 < 1) Good C, C++ and Fortran95 compilers.  We've built and tested OOPSE
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     F90     Notes
33 <    -------------------------   ----   -----   -----   ----------------------
34 <    ix86-pc-linux-gnu           icc    icpc    ifort   (Intel versions 7-9)
35 <    i386-apple-darwin8.7.1      icc    icpc    ifort   (Intel version 9.1)
36 <    powerpc-apple-darwin8.7.0   gcc    g++     xlf95   (GNU v.4 / IBM XL v. 8.1)
37 <    x86_64-unknown-linux-gnu    gcc    g++     pathf95 (GNU v.4 / Pathscale 2.5)
33 <    sparc-sun-solaris2.10       cc     CC      f95     (Sun ONE Studio 10)
34 <    
35 <    We've also successfully compiled OOPSE with the Portland Group c, c++,
36 <    and Fortran95 compilers on the  x86_64-unknown-linux-gnu architecture.
37 <  
38 <    OOPSE uses features of the Fortran 95 language. The fortran
39 <    portions of our code will not compile if your compiler does not
40 <    support these particular features. Some (but not all) Fortran 90
41 <    compilers do support these features. None of the Fortran 77
42 <    compilers can be used to compile OOPSE.
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 <    Fortran compilers that are known to fail on OOPSE: g77, Gfortran,
40 <    Older Portland Group compilers (pgf77, pgf90).
39 > 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  
46 <    Fortran compilers that are known to work on OOPSE: Intel's ifort,
47 <    Pathscale's pathf95, IBM's xlf95, Portland's pgf95 (version 6 or
48 <    higher), Sun's f95. There may be others that work also.
46 > 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  
51 < 2) GNU make (also known as gmake).  Regular make won't work.  
52 <    Really.  We've tried.  Don't bother with regular make.  
53 <    Seriously.  You need GNU make.  Did we mention that you
54 <    need GNU make?
51 > 4) Other optional (but quite useful) libraries that will unlock some
52 >    features of OpenMD:
53  
54 < 3) Perl.  Compilation dependencies in Fortran95 are somewhat
55 <    complicated, so the build process uses a perl script called
56 <    filepp to do this job.  You need perl for filepp, so you
59 <    need perl to build OOPSE.
54 >      Open Babel:  http://openbabel.org
55 >      Qhull:       http://www.qhull.org
56 >      FFTW:        http://www.fftw.org
57  
58 < 4) MPI is optional for the single processor version of OOPSE,
59 <    but is required if you want OOPSE to run in parallel.
58 > 5) Some of the utility scripts depend on Python and Perl.  These
59 >    interpreters are common installations on most flavors of Unix and
60 >    Mac OS X.
61  
64    We like Open MPI.  Other implementations might work, but we
65    haven't tried.  You can get Open MPI here: http://www.open-mpi.org/
62  
63   INSTRUCTIONS
64  
65   1) Get, build, and test the required pieces above.
66 < 2) ./configure  (or ./configure --with-mpi=/usr/local/openmpi)
66 > 2) cmake .
67   3) make
68   4) make install
69  

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines