Merge pull request #93 from ComputationalRadiationPhysics/release-1.1

Release 1.1.0 and Close #61

Author: ax3l

.travis.yml

@@ -9,9 +9,14 @@ compiler:
   - clang
 
 env:
-  - SPLASHPARALLEL=ON  SPLASHMPI=ON
-  - SPLASHPARALLEL=OFF SPLASHMPI=ON
-  - SPLASHPARALLEL=OFF SPLASHMPI=OFF
+  global:
+    - SPLASH_ROOT=~/lib/splash
+    - BUILD=~/buildTmp
+    - SRC=$TRAVIS_BUILD_DIR
+  matrix:
+    - SPLASHPARALLEL=ON  SPLASHMPI=ON
+    - SPLASHPARALLEL=OFF SPLASHMPI=ON
+    - SPLASHPARALLEL=OFF SPLASHMPI=OFF
 
 script:
   - cd $BUILD
@@ -32,12 +37,24 @@ after_script:
   - $SRC/tests/run_parallel_tests $BUILD
 
 before_script:
-  - echo "yes" | sudo add-apt-repository ppa:jsm-8/lofar-deps
+  - uname -r
+  - lsb_release -a
+  - echo "$SRC"
+  - ls -hal $SRC
+# PPA providing hdf5 >= 1.8.6 and OpenMPI >= 1.5.1
+# -> remove legacy hdf5 and mpi packages/deps from travis
+  - sudo apt-get remove -qq libhdf5* libopenmpi* openmpi-bin
+  - echo "yes" | sudo add-apt-repository ppa:james-page/openmpi
+  - echo "yes" | sudo add-apt-repository ppa:axel-huebl/libsplash
   - sudo apt-get update -qq
+  - sudo apt-cache policy
+  - sudo apt-cache policy libhdf5-serial-dev
+  - sudo apt-cache policy libopenmpi-dev
   - if [ "$SPLASHMPI" == "ON" ]; then export APTMPI="libopenmpi-dev openmpi-bin"; fi
-  - if [ "$SPLASHPARALLEL" == "ON" ]; then export APTHDF5="libhdf5-openmpi-dev"; else export APTHDF5="libhdf5-serial-dev"; fi
-  - sudo apt-get install -qq libcppunit-dev libboost-program-options-dev $APTMPI $APTHDF5
-  - export SRC=`pwd`
-  - export BUILD=~/buildTmp
+  - if [ "$SPLASHPARALLEL" == "ON" ]; then export APTHDF5="libhdf5-openmpi-7 libhdf5-openmpi-dev"; else export APTHDF5="libhdf5-serial-dev"; fi
+  - sudo dpkg --get-selections
+  - sudo apt-get install -qq -f libcppunit-dev
+  - sudo apt-get install -qq -f libboost-program-options-dev
+  - sudo apt-get -t o=LP-PPA-james-page-openmpi install -q -f $APTMPI
+  - sudo apt-get -t o=LP-PPA-axel-huebl-libsplash install -q -f $APTHDF5
   - mkdir -p $BUILD ~/lib
-  - export SPLASH_ROOT=~/lib/splash

CHANGELOG.md

@@ -0,0 +1,33 @@
+Change Log for libSplash
+================================================================
+
+Release 1.1.0
+-------------
+**Date:** 2014-01-23
+
+**New Features**
+
+ - Added support for various new collection types.
+ - Added macros to generate array and compound collection types.
+ - Enabled support for using static HDF5 library.
+ - Added patch level and file format version information.
+ - Updated user manual for parallel I/O.
+ - New tests and examples.
+
+
+**Interface Changes**
+
+ - Header files moved to splash subfolder (include/splash/splash.h). 
+
+
+**Bug Fixes**
+
+ - Create duplicate of user-provided MPI communicator.
+ - Allow empty write/read calls (no data).
+ - Improved HDF5 detection in cmake file.
+ - Fix usage of MPI data types.
+
+
+**Misc:**
+
+ - Compiling with OpenMPI now requires version 1.5.1 or higher

CMakeLists.txt

@@ -1,5 +1,5 @@
  #
- # Copyright 2013 Felix Schmitt
+ # Copyright 2013 Felix Schmitt, Axel Huebl
  #
  # This file is part of libSplash. 
  # 
@@ -35,24 +35,56 @@ PROJECT(libSplash)
 #set helper pathes to find libraries and packages
 #- you need the multiarch dir x86_64-linux-gnu on 64bit Ubuntu's with
 #  self-compiled compilers
-SET(CMAKE_PREFIX_PATH "/usr/lib/x86_64-linux-gnu/" "$ENV{MPI_ROOT}" "$ENV{HDF5_ROOT}")
+SET(CMAKE_PREFIX_PATH "/usr/lib/x86_64-linux-gnu/" "$ENV{MPI_ROOT}"
+                      "$ENV{HDF5_ROOT}")
 
 #-------------------------------------------------------------------------------
 
 # install prefix
 IF(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
-    SET(CMAKE_INSTALL_PREFIX "${PROJECT_BINARY_DIR}" CACHE PATH "install prefix" FORCE)
+    SET(CMAKE_INSTALL_PREFIX "${PROJECT_BINARY_DIR}" CACHE PATH "install prefix"
+        FORCE)
 ENDIF(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT) 
 
 #-------------------------------------------------------------------------------
 
+# whats my version?
+FILE(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/version.hpp"
+     SPLASH_VERSION_MAJOR_HPP REGEX "#define SPLASH_VERSION_MAJOR ")
+FILE(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/version.hpp"
+     SPLASH_VERSION_MINOR_HPP REGEX "#define SPLASH_VERSION_MINOR ")
+FILE(STRINGS "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/version.hpp"
+     SPLASH_VERSION_PATCH_HPP REGEX "#define SPLASH_VERSION_PATCH ")
+
+STRING(REGEX MATCH "([0-9]+)" SPLASH_VERSION_MAJOR
+                            ${SPLASH_VERSION_MAJOR_HPP})
+STRING(REGEX MATCH "([0-9]+)" SPLASH_VERSION_MINOR
+                            ${SPLASH_VERSION_MINOR_HPP})
+STRING(REGEX MATCH "([0-9]+)" SPLASH_VERSION_PATCH
+                            ${SPLASH_VERSION_PATCH_HPP})
+
+SET(SPLASH_VERSION "${SPLASH_VERSION_MAJOR}.${SPLASH_VERSION_MINOR}.${SPLASH_VERSION_PATCH}")
+MESSAGE(STATUS "Building libSplash version ${SPLASH_VERSION}")
+
+#-------------------------------------------------------------------------------
+
 # HDF5 is required package
 FIND_PACKAGE(HDF5 REQUIRED)
 INCLUDE_DIRECTORIES(SYSTEM ${HDF5_INCLUDE_DIR})
 
+# check if static version of HDF5 is used
+#   CMake prefers .so/shared libraries                 
+#   if we find a static HDF5 lib in the ${HDF5_LIBRARIES}
+#   it means there is only a static version installed
+SET(HDF5_IS_STATIC ON)
+STRING(FIND "${HDF5_LIBRARIES}" "hdf5.a" HDF5_IS_STATIC_POS)
+IF(${HDF5_IS_STATIC_POS} EQUAL -1)
+    SET(HDF5_IS_STATIC OFF)
+ENDIF(${HDF5_IS_STATIC_POS} EQUAL -1)
+
 #-------------------------------------------------------------------------------
 
-SET(CMAKE_CXX_FLAGS "-Wall -Werror -Wextra -Woverloaded-virtual")
+SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -Werror -Wextra -Woverloaded-virtual")
 
 # options
 OPTION(DEBUG_VERBOSE "Enable verbose HDF5 debug output" OFF)
@@ -110,50 +142,62 @@ AUX_SOURCE_DIRECTORY("${CMAKE_CURRENT_SOURCE_DIR}/tools" TOOLS_SOURCES)
 
 #-------------------------------------------------------------------------------
 
-# build libsplash shared
-ADD_LIBRARY(splash SHARED ${LIBRARY_SOURCES})
-TARGET_LINK_LIBRARIES (splash ${SPLASH_LIBS})
+# build libsplash shared (if shared HDF5 is used)
+IF(HDF5_IS_STATIC)
+    MESSAGE(WARNING "Skipping dynamic libSplash because HDF5 library is static")
+ELSE(HDF5_IS_STATIC)
+    ADD_LIBRARY(splash SHARED ${LIBRARY_SOURCES})
+    TARGET_LINK_LIBRARIES(splash ${SPLASH_LIBS})
+ENDIF(HDF5_IS_STATIC)
 
-#build libsplash static
+# build libsplash static
 ADD_LIBRARY(splash_static STATIC ${LIBRARY_SOURCES})
 SET_TARGET_PROPERTIES(splash_static PROPERTIES OUTPUT_NAME splash)
 TARGET_LINK_LIBRARIES (splash_static ${SPLASH_LIBS})
 
 # install libs
-INSTALL(TARGETS splash LIBRARY DESTINATION lib)
+IF(NOT HDF5_IS_STATIC)
+    INSTALL(TARGETS splash LIBRARY DESTINATION lib)
+ENDIF(NOT HDF5_IS_STATIC)
+
 INSTALL(TARGETS splash_static ARCHIVE DESTINATION lib)
 
 # copy include folder to install folder
 INSTALL(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/src/include/."
-  DESTINATION "${CMAKE_INSTALL_PREFIX}/include"
+  DESTINATION include
   PATTERN ".svn" EXCLUDE
   PATTERN ".git" EXCLUDE
   PATTERN "splash_*.h" EXCLUDE
 )
 
 # install correct splash header file
-INSTALL(SCRIPT "${CMAKE_CURRENT_BINARY_DIR}/PostInstall.cmake")
+# (will be executed after the POST_BUILD copies of splash.h)
+INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/splash/splash.h
+        DESTINATION include/splash)
+
+ADD_CUSTOM_COMMAND(TARGET splash_static POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E make_directory
+                "${CMAKE_CURRENT_BINARY_DIR}/splash"
+)
+
 IF(HDF5_IS_PARALLEL)
-    SET(splash_inc_file "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash_parallel.h")
+    SET(splash_inc_file "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/splash_parallel.h")
 
-    ADD_CUSTOM_COMMAND(TARGET splash POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E create_symlink
-                "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash_parallel.h"
-                "${CMAKE_CURRENT_BINARY_DIR}/splash.h"
+    ADD_CUSTOM_COMMAND(TARGET splash_static POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+                "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/splash_parallel.h"
+                "${CMAKE_CURRENT_BINARY_DIR}/splash/splash.h"
         )
 ELSE(HDF5_IS_PARALLEL)
-    SET(splash_inc_file "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash_serial.h")
+    SET(splash_inc_file "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/splash_serial.h")
 
-    ADD_CUSTOM_COMMAND(TARGET splash POST_BUILD
-            COMMAND ${CMAKE_COMMAND} -E create_symlink
-                "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash_serial.h"
-                "${CMAKE_CURRENT_BINARY_DIR}/splash.h"
+    ADD_CUSTOM_COMMAND(TARGET splash_static POST_BUILD
+            COMMAND ${CMAKE_COMMAND} -E copy
+                "${CMAKE_CURRENT_SOURCE_DIR}/src/include/splash/splash_serial.h"
+                "${CMAKE_CURRENT_BINARY_DIR}/splash/splash.h"
         )
 ENDIF(HDF5_IS_PARALLEL)
 
-CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/PostInstall.cmake.in
-    ${CMAKE_CURRENT_BINARY_DIR}/PostInstall.cmake @ONLY)
-
 #-------------------------------------------------------------------------------
 
 # build tools
@@ -190,7 +234,7 @@ IF(WITH_TOOLS)
     ENDIF(HDF5_IS_PARALLEL)
 
     ADD_EXECUTABLE(splashtools ${TOOLS_SOURCES})
-    ADD_DEPENDENCIES(splashtools splash splash_static)
+    ADD_DEPENDENCIES(splashtools splash_static)
     TARGET_LINK_LIBRARIES(splashtools ${TOOLS_LIBS})
 
     #install tools

PostInstall.cmake.in

@@ -1,12 +1,12 @@
 libSplash - Simple Parallel file output Library for Accumulating Simulation data using Hdf5
 ===========================================================================================
 
-### Build Status by branch
+### Build Status by branch (master/dev)
 
 [![Build Status Master](https://travis-ci.org/ComputationalRadiationPhysics/libSplash.png?branch=master)]
-(https://travis-ci.org/ComputationalRadiationPhysics/libSplash)
-[![Build Status Parallel](https://travis-ci.org/ComputationalRadiationPhysics/libSplash.png?branch=parallel)]
-(https://travis-ci.org/ComputationalRadiationPhysics/libSplash)
+(https://travis-ci.org/ComputationalRadiationPhysics/libSplash "master")
+[![Build Status Development](https://travis-ci.org/ComputationalRadiationPhysics/libSplash.png?branch=dev)]
+(https://travis-ci.org/ComputationalRadiationPhysics/libSplash "dev")
 
 Introduction
 ------------

README.md

@@ -16,7 +16,7 @@ To use the CMakeLists.txt file which comes with the source code, you must have
 **CMake version 2.8.5** or higher installed.
 
 The splashtools and some tests also require an **MPI 2.2** compatible MPI library,
-e.g. OpenMPI 1.4.3 or higher.
+e.g. **OpenMPI 1.5.1** or higher.
 
 Tests require the development version of the **CppUnit** library.
 
@@ -39,13 +39,25 @@ pass `-DSPLASH_RELEASE=OFF` to your cmake command.
 To see verbose internal (!) HDF5 debug output, pass `-DDEBUG_VERBOSE=ON`
 to your cmake command line.
 
+Afterwards, please add `<INSTALL PATH>/bin` to your `$PATH` environment variable and
+`<INSTALL PATH>/lib` to your `$LD_LIBRARY_PATH`.
+Setting an additional environment variable `export SPLASH_ROOT=<INSTALL PATH>` will
+help finding the installed libraries with CMake scripts.
+
 
 Linking
 -------
 
 To use libSplash in your project, you must link against the created shared object library
 libsplash.so or against the statically linked archive libsplash.a.
 
+Because we are linking to HDF5, the following **external dependencies** must be linked:
+- `-lhdf5`
+- `-lpthread`
+- `-lz`
+- `-lrt`
+- `-ldl`
+- `-lm`
 
 Tests
 -----
@@ -80,4 +92,3 @@ This builds the *ParallelDataCollector* and *ParallelDomainCollector* classes.
 *Please note that this feature is beta stage and not fully tested!*
 See *IParallelDataCollector* and *IParallelDomainCollector* interfaces for further
 information on how to use the parallel version.
-