Developer's version

Below you find instructions to install the developer's version of MercuryDPM, also called the "master". The developer's version contains the newest features of the code, whose interface might still be unstable. If you want the most recent stable version of Mercury, please download the release instead.

INSTALLATION STEPS

Step 1: Install external dependencies 

• Before installing MercuryDPM, you need to install a set of required external dependencies:

  1. C++ and Fortran compilers: Mercury uses C++14 features and thus requires an up-to-date compiler.
     We suggest you use gcc 5.2 or higher. To compile our Fortran files, we recommend gfortran.

  2. git version 2.2 or higher

  3. cmake version 2.8.14 or higher (http://cmake.org/cmake)

  4. python version 3

On Ubuntu 16.04, you can install the minimum dependencies with the following command:

sudo apt install build-essential g++ gfortran git cmake python3 python3-dev gdb

• We further recommend you to install a set of optional external dependencies:

  1. doxygen (http://www.doxygen.nl/download.html) and graphviz (dot) (https://graphviz.gitlab.io/download/), used to create a local copy of the documentation

  2. X11 used to visualise your simulation results with xballs

  3. Paraview used to visualise your simulation results, rendered in 3D

  4. OpenMPI libraries for parallel computing

On Ubuntu 16.04, you can install these optional dependencies with the following command:

sudo apt install doxygen graphviz libx11-dev libxt-dev libxres-dev libxtst-dev paraview openmpi-bin mpi-default-dev

Step 2: Clone the MercuryDPM repository

• To install Mercury, open the terminal. 

• Create a new directory in which to install MercuryDPM, and enter this directory:

mkdir MercuryDPM

cd MercuryDPM

• You now have three options to get the developers version of the code. We list them in order of simplicity:

1. Direct local clone:

Check out a local clone of the MercuryDPM developers version using the following command:

git clone https://bitbucket.org/mercurydpm/mercurydpm.git MercurySource

This option is recommended if you simply want to use/test MercuryDPM. You do not need an Atlassian account. However, it does not allow to push back features to Bitbucket.

2. Private fork:

If you want to develop a (private) feature with MercuryDPM (which we encourage you to push back to us at a later date), create a personalised local repo of MercuryDPM on bitbucket:

2. 1. Goto https://bitbucket.org/mercurydpm/mercurydpm/

   2. Create an account

   3. Establish a secure SSH connection to the Bitbucket cloud.

   4. Click the the three dots and select 'Fork this repository'

You then must also clone this to your computer:

git clone git@bitbucket.org:<yourBitBucketName>/mercurydpm.git MercurySource

3. Main (open) developers branch:

If you are a member of the MercuryDPM development team, create a public branch of MercuryDPM in the main git repository:

git clone git@bitbucket.org:mercurydpm/mercurydpm.git MercurySource

Note, you must first establish a secure SSH connection to the Bitbucket cloud. 

We highly encourage you to create branches while your feature is still in development. This way others can swap to your branch, see the new feature and maybe even comment on/help with it.  

The development team is open to everyone. If you want to be added to the development team, please contact info@mercurydpm.org.

Step 3: Install MercuryDPM

• Create another directory called "MercuryBuild", and enter the folder by typing

mkdir MercuryBuild

cd MercuryBuild

• Create the Makefiles necessary for compiling MercuryDPM using cmake:

cmake ../MercurySource

• Note 1: If you don't want to use the default cmake options, use ccmake instead of cmake. In ccmake, click "c" to configure, then modify the configuration as needed . Then click "c" to configure again. Finally, click "g" to generate the Makefiles.

• Note 2: To modify the build options, you can also using cmake's command line interface instead of ccmake. For example, you can change to build in Release mode instead of Debug mode using cmake ../MercurySource -DBUILD=Release

• To check if the installation was successful, go to your build directory "MercuryBuild" using the terminal and type

make fullTest

This will compile all MercuryDPM components, and run the selftest suite.

• If all the tests have passed, MercuryDPM is successfully installed on your machine.

• To get started, it's a good idea to work through the beginner's tutorials next: http://docs.mercurydpm.org/Trunk/d0/db0/BeginnerTutorials.html

MercuryDPM mailing list

Please sign up for the mailing list to receive updates about the code.