MercuryDPM : Fast, flexible particle simulations

News

Archive

RSS Feed

Linux

Requirements

Minimum
  • C++ and fortran compilers
    • Note, Mercury uses C++11 features. Version 4.7 of gcc claims to have C++11 feature, but the implementation is incomplete.
      Thus, gcc 4.8 is minimum version for gcc family of compliers.
  • cmake version 2.8 or higher (http://cmake.org/cmake/resources/software.html)
  • python version 2.x
  • subversion (svn) version 1.7 or higher
  • doxygen (optional: used for creating the documentation while building your source code)
  • X11 (optional: for using xballs)
  • OpenMPI (optional: for parallel computing, which will be in the next beta version)
Installation steps
For Linux users
  • Make sure the above mentioned packages are installed. On Ubuntu 16.04, you need to install the following dependencies
    sudo apt install build-essential g++ gfortran subversion python2 cmake-curses-gui cmake-qt-gui doxygen \
libx11-dev libxt-dev libxres-dev libxtst-dev openmpi-bin mpi-default-dev
  • Open the terminal or shell. Create a directory called "MercuryDPM", at a location of your choice, by typing 
    mkdir MercuryDPM
  • To get into mercuryDPM, type 
    cd MercuryDPM/
  • Once in the folder MercuryDPM, download or check out the beta version of the DPM source by typing 
    svn checkout https://svn.MercuryDPM.org/SourceCode/Beta MercurySource

    The above command downloads the DPM source code into the folder named "MercurySource"

  • In the current folder, i.e. mercuryDPM, create another directory called "MercuryBuild" 
    mkdir MercuryBuild
  • Get into the folder "MercuryBuild" by typing 
    cd MercuryBuild
    • With cmake GUI
    • Assuming cmake is successfully installed, goto directory "MercuryBuild" in order to create the executables from the source code. Do it by typing 
      cmake-gui ../MercurySource/
    • A GUI pops up on your screen as in the picture shown below
      1. Click on "Browse Source" and locate the "MercurySource" directory.
      2. Click on "Browse Build" and locate the "MercuryBuild" directory.
      3. Make sure option "Grouped" is selected and "Advanced" is deselected.
      4. Click "Configure"
    • After clicking on "Configure", the following window appears on your screen
      [img src="http://mercurydpm.org/assets/img/pageDownldsInstall/cmake-gui2.png" align="middle" border="0" height="280" width="430">
      1. Select "Unix makefiles" under specify the generator for this code
      2. Choose "use default native compilers"
      3. Click on "Done"
    • Clicking on "Done", builds all the files in the directory "mercuryDPMSource" and creates the executables.
    • The building/installation progress is visible in the bottom panel of your cmake window screen, as seen in the screenshot below.
      1. Any red line in the bottom panel, indicates that some package is missing or needs to be installed to have a successful "configure". In that case, click on the "Advanced" option to see exactly where the issue is or contact any of the MercuryDPM team of developers.
      2. Once configured for the first time, under the group named 'CMAKE' type 'Release' at 'CMAKE_BUILD_TYPE'. See the picture above.
    • Optional: for documentation tick the box make_BUILD_DOCUMENTATION, in the picture as shown below, before you click on configure.
    • Once you entered all options and configured, click on 'generate'.
    • To check if successfully installed, go to your build directory "MercuryBuild" using the terminal and type
    • If all the tests have passed, MercuryDPM is successfully installed on your machine.
    Without cmake GUI
    • For users without the GUI, cmake does include an alternative curses-based interface called 'ccmake'.
    • At the terminal, in directory MercuryBuild type 
      ccmake ../MercurySource/
      1. As seen in the above picture, pressing the key 'c' configures or builds the object files or executables from the source directory (MercurySource).
      2. Moreover, before configuring, 'BUILD_DOCUMENTATION' or/and 'Xballs_Support' can be enabled or disabled.
      3. Cmake experts can toggle to advanced mode by pressing the key 't' to have more options and choices.
      [img src="http://mercurydpm.org/assets/img/pageDownldsInstall/ccmake-2.png" align="middle" border="0" height="380" width="430">
    • Once configured, press the key 'g' to generate the executables.
    To check if successfully installed, go to your build directory "MercuryBuild" using the terminal and type 
    make fullTest
  • If all the tests have passed, MercuryDPM is successfully installed on your machine.
For Windows users:
  • To avail the benefits of subversion, install TortoiseSVN. Goto http://tortoisesvn.net . Download and install the program using the default setup (version 1.8.5 released)
  • Open windows explorer:
    1. Goto the folder where you want to copy the MercuryDPM source code, for e.g. "C:\cygwin\home\username\MercuryDpm"
    2. 2. Right click and select: "svn checkout .... "
    3. At the url type "http://svn.mercurydpm.org/SourceCode/Beta"
    4. Click "ok" and wait for the checkout to finish. Click "ok"
To install mercuryDPM on windows OS: (still to be tested by our alpha tester)
  • Open the "XWin Server" tool (under Start Menu -> cygwin). Now you should a mac/linux terminal.
  • Follow the installation steps listed above for MAC/Linux users. If cmake-gui is not installed use ccmake instead.

mercuryDPM mailing list