Trunk (Developers version)
Below you find instructions to download the developer's version of MercuryDPM, also called the "Trunk". Note, the developer's version contains the newest features of the code, which might still be unstable. If you want the most recent stable version of Mercury, please download the release instead.
- doxygen and graphviz (dot) used to create a local copy of the documentation
- X11 required for visualising your simulations with xballs
- Paraview can be used to visualise your simulation results
- OpenMPI libraries for parallel computing
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 python3 cmake cmake-curses-gui cmake-qt-gui doxygen graphviz libx11-dev libxt-dev libxres-dev libxtst-dev paraview openmpi-bin mpi-default-dev
- Open the terminal or shell. Create a directory called "MercuryDPM" at a location of your choice by typing
- Enter the new directory by typing
- Check out the developer's version ('Trunk') of MercuryDPM by typing
- Create another directory called "MercuryBuild"
- Get into the folder "MercuryBuild" by typing
- Create Makefiles for compiling MercuryDPM with cmake-gui. To do so, type
- The CMake GUI pops up on your screen, as in the picture shown below
- Click on "Browse Source" and locate the "MercurySource" directory.
- Click on "Browse Build" and locate the "MercuryBuild" directory.
- Make sure option "Grouped" is selected and "Advanced" is deselected.
- Click "Configure"
- After clicking on "Configure", the following window appears on your screen
- Select "Unix makefiles" under "Specify the generator for this code"
- Choose "Use default native compilers"
- Click on "Done"
- If all required dependencies have been installed, then the log file displayed in the bottom panel ends with "Configuring done", as seen in the screenshot below. If not, please respond to the error messages, then click configure again.
- 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.
- Once "Configuring done" is displayed, you can select configuration options in the top panel:
- Select 'Release' as the 'CMAKE_BUILD_TYPE', see the picture above.
- Optional: tick Mercury_BUILD_DOCUMENTATION if you plan to build a local version of the documentation (requires doxygen and graphviz)
- Optional: tick Mercury_BUILD_USER_DIR if you want to compile codes in the USER directory
- Optional: tick Mercury_Include_XBalls_Support if you plan to use XBalls for visualisation (requires X11)
- Optional: tick Mercury_USE_MPI if you plan to use parallel computations (requires the MPI libraries)
- Once you entered all options, click 'Configure' again. Then click on 'Generate'. This generates Makefiles in your build directory ('TrunkBuild') that you can use to compile MercuryDPM.
- To check if the installation was successfull, go to your build directory "MercuryBuild" using the terminal and type
This will compile all MercuryDPM components, and run the selftest suite
- If all the tests have passed, MercuryDPM is successfully installed on your machine.
Note, you can also install MercuryDPM from the terminal, without using cmake-gui. cmake does include an alternative curses-based interface called ccmake. To do so, type ccmake instead of cmake-gui in the above instructions.
For Windows users
For MacOS users
MercuryDPM mailing list
Please sign up for the mailing list to receive updates about the code.