To get OpenMD up and running, there are some required (and optional) software packages you should have to create a functioning build environment:

On a Mac (macOS Mojave or later)

  1. Install Xcode
  2. Install homebrew
  3. Open a Terminal window, and update your homebrew packages to the latest updates:
    brew update
    brew upgrade

    (Note that the brew command is usually located in /usr/local/bin)

  4. Install the relevant prerequisite packages:
    brew install cmake open-babel qhull zlib fftw open-mpi numpy scipy

    You can go have lunch or coffee while these are being built and installed.

  5. Install some optional software if you want to use and interact with the data produced by OpenMD:
    brew install grace brewsci/bio/jmol 
  6. Install some optional software if you want to develop or add to OpenMD:
    brew install antlr@2 gengetopt doxygen

On Linux

  1. Use yum, apt-get, or the package manager in your favorite distribution to install the following packages and all of their prerequisites. Package names depend on the Linux variant, so in Fedora (and Red Hat) the package names are:
    openbabel openbabel-devel openmpi3 openmpi3-devel perl
    python3-scipy qhull qhull-devel zlib zlib-devel

    In Ubuntu (and probably other Debian-based versions), the packages are:

    python3-scipy qhull-bin libqhull-dev minizip zlib1g-dev
  2. Install some optional packages if you want to use and interact with the data produced by OpenMD:
  3. Install some optional software if you want to develop or add to OpenMD:

On Windows

Building and installing OpenMD on Windows is now quite straightforward. All it takes is the installation of an Ubuntu subsystem on your Windows Machine. Once you have this, all the commands for the Linux build are exactly the same. Alternatively, CMake will generate a (mostly) working build of OpenMD 2.6 in Windows with the Visual Studio 2019 C++ compiler, but we don’t routinely test the code in this configuration. 

  1. Follow the steps to building and installing OpenMD on Windows. (Note that if you’re planning on using visualization software that relies on an X Server, you’ll need to follow the Windows-specific instructions for that as well.)
  2. Refer to the list of packages for linux above to get the correct packages installed.

Building from source

If you are building all of the prerequisites from source, you’ll need (in addition to a C++ compiler):

  1. CMake – This cross-platform build system is required for building OpenMD.  You need to install CMake 2.8.11 or newer. This is available as a binary package from the KitWare website; alternatively, it may be available through your package manager (on Linux). If necessary, you can also compile it yourself from the source code.
  2. perl and python – interpreted scripting languages that some of the OpenMD utilities use to parse and process data files.
    You probably already have these.
  3. Open MPI – A very good implementation of the MPI-2 specification for parallel computing.
  4. qhull – A computational geometry toolbox for computing convex hulls and Delaunay triangulations. qhull is required for the LangevinHull integrator and for any of the tools that compute the Hull atoms or hull volumes of nanoparticles and clusters.
  5. openbabel – a chemical toolbox for converting between different data formats.  This is required for building the atom2omd program which helps prepare initial “metadata” or omd files for simulations.
  6. fftw – a library for computing discrete Fourier transforms. This is required for surface undulation spectra (Hxy in staticProps). Get version 3.
  7. zlib – required to support reading compressed trajectory files.

You’ll also likely want to download and compile the following useful tools for interacting with the data:

  1. Jmol
  2. xmgr
  3. grace
  4. NumPy
  5. SciPy
  6. vmd

If you are going to be extending or developing OpenMD, you’ll need the following tool:

  1. antlr – our tool for parsing meta-data files.  You’ll want version 2.7, not 3.
  2. gengetopt – a tool to generate C code to parse the command line arguments argc and argv that are part of every C or C++ program