MercuryDPM - Release 0.10

REQUIREMENTS

Minimum

compiler with c++11 features
svn (subversion) version above 1.7
cmake version 2.8 or higher (http://cmake.org/cmake/resources/software.html)
doxygen (optional: used for creating the documentation while building your source code)

For MAC users:

Latest version of xcode is preferred
For Mac OSX 10.7+ install XQuartz as an alternative to X11. Note: X11 is needed only for the purpose of visualisation.

HOW TO OBTAIN MERCURYDPM

For Windows users:

Install cygwin to get few of the above packages, goto http://cygwin.com/install.html. Download and open the executable (.exe).
Use default instructions until you are asked to select packages, see here.
Make sure to include the following packages during the installation process (They are found under Devel):
1. Complete X11 package
2. cmake: Cross-platform makefile generation system
3. cmake-gui: Cross-platform makefile generation system (GUI)
4. Note: cmake-gui is not available in the 32-bit version of cygwin. use ccmake instead (which comes with cmake)
5. make: the GNU version of the 'make' utility
6. optional: install gnuplot and gnuplot-x11 (a simple plotting visualiser)

INSTALLATION STEPS

For Mac/Linux users

Open the terminal or shell. Create a directory called "MercuryDPM", at a location of your choice, by typing

mkdir MercuryDPM

cd MercuryDPM/

Once in the folder MercuryDPM, download or check out the beta version of the DPM source by typing

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

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/

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 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/

As seen in the above picture, pressing the key 'c' configures or builds the object files or executables from the source directory (MercurySource).
Moreover, before configuring, 'BUILD_DOCUMENTATION' or/and 'Xballs_Support' can be enabled or disabled.
Cmake experts can toggle to advanced mode by pressing the key 't' to have more options and choices.

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/Release/0.10"
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

Please now follow the instructions to sign up for the mailing list, in order to receive updates about the code.