Installing the Developer Version of MercuryDPM

The developer version of MercuryDPM—also known as the master branch—contains the latest features and updates. Please note that these features may still be under development and subject to change. If you are looking for a more stable version of the software, we recommend downloading the latest official release instead.

Step 1: Install external dependencies 

• Required:

  1. A modern C++ compiler (g++ version 8.0 or clang version 10.0 or higher)

  2. A Fortran compiler (gfortran recommended)

  3. git (version 2.2 or higher)

  4. cmake (version 3.12 or higher)

  5. python 3.0 or higher

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

• Optional:

  1. doxygen and graphviz (for generating documentation)

  2. X11 development libraries (to use xballs for visualisation)

  3. paraview (for 3D visualisation)

  4. openMPI (for parallel computing support)

  5. ninja-build (for faster builds using the Ninja build system)

Install the optional packages on Ubuntu with:

sudo apt install doxygen graphviz

sudo apt install libx11-dev libxt-dev libxres-dev libxtst-dev 

sudo apt install paraview 

sudo apt install openmpi-bin mpi-default-dev 

sudo apt install ninja-build

Step 2: Clone the MercuryDPM repository

• Open a terminal and create a directory for MercuryDPM:

mkdir MercuryDPM

cd MercuryDPM

• You have three options to get the developers version of the MercuryDPM:

1. Direct Clone (Recommended for Users)

Use this method if you simply want to use or test MercuryDPM:

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

No Bitbucket account is required. However, you won’t be able to push changes back.

2. Private Fork (Recommended for Feature Development)

Use this if you plan to develop your own features (which you are encouraged to contribute back later):

2. 1. Go to: https://bitbucket.org/mercurydpm/mercurydpm/

   2. Create a Bitbucket account.

   3. Set up SSH access to Bitbucket.

   4. Fork the repository using the menu (⋯ → Fork this repository).

   5. Clone your fork:

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

3. Developer Access to the Main Repository

If you are a member of the MercuryDPM development team:

3. 1. Set up SSH access to Bitbucket.

   2. Clone the master branch:

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

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: Build and Install MercuryDPM

• Create a separate build directory:

mkdir MercuryBuild

cd MercuryBuild

• Generate the makefiles using cmake:

cmake ../MercurySource

• Optional: Use ccmake for a GUI-based configuration:

• Note: you can also build in Release mode:

cmake ../MercurySource  -DCMAKE_BUILD_TYPE=Release

• Compile and test the installation:

make fullTest

This command builds MercuryDPM and runs its test suite. If all tests pass, the installation was successful.

Next steps

To get started with MercuryDPM, follow the beginner tutorials.

Stay Informed

We recommend signing up for the MercuryDPM mailing list to receive updates about the code.