Installing LUMA

Before You Start

As LUMA is written in C++, you need to make sure you have a C++ compiler and implementation installed. The compiler must be capable of supporting the C++11 standard.

Windows Users

For Windows users, we recommend you install Visual Studio and also CMake to help build LUMA's dependencies. At the time of writing, LUMA has been built and tested using Visual Studio 2015. Dependencies have been configured for VS2015 using CMake v3.9.1. Visual Studio can be obtained from the Microsoft download website.

Mac and Linux Users

LUMA and its dependencies require the GNU C/C++ compiler to be installed. LUMA has been built successfully using GCC 4.9.0 on Ubuntu 14.04. Makefiles are supplied with LUMA to allow the use of the GNU Make utility for build management.

Dependencies

Before building LUMA you first need to build the dependencies following this guide.

Building LUMA

Once you have the dependencies built, you will need to make a note of the location of the relevant header files and library files. These paths will be required to allow LUMA to include and link to the dependencies you have just built.

Windows Users

As with the dependencies, we recommend on Windows that you use Visual Studio 2015 to build and run LUMA. Add the files in the inc and src directories to a new C++ project in Visual Studio.

Under Project->Properties, add the following to the Additional Include Directories value on the C/C++->General tab:

$(HDF5_INC);    
$(MSMPI_INC);    

where $(HDF5_INC) and $(MSMPI_INC) are the paths to your HDF5 and MPI header files respectively.

Under Linker->General add the following to the Additional Library Directories value:

$(MSMPI_LIB);   
$(HDF5_BIN);

where these are the paths to the built binaries for MPI and HDF5.

Finally, add the following to the Additional Dependencies value on the Linker->Input tab:

szip.lib;    
zlib.lib;    
libhdf5.lib;    
msmpi.lib;

to allow linking against HDF5 and MPI libraries.
Note: Debug builds for some dependencies append a _D to the end of the library name. You may need to set up Release and Debug build configurations separately in Visual Studio using the appropriately named library.

Building the Merge Tool

The h5mgm merge tool is a post-processor that takes the multi-grid HDF output from LUMA and converts this data into a time-series of VTU mesh files readable into Paraview. A guide to building the merge tool is available here.