Merge pull request #16 from DCM-UPB/polish

new release v0.2

Author: Ithanil

.gitignore

@@ -60,21 +60,10 @@ DerivedData
 
 # -- project specific ignores --
 lib*
+build
 config.sh
-*exe*
 vgcore*
 
-src/*.o
-
-debug/*.o
-debug/*.txt
-
-debug/unittests/ut*/*.o
-debug/unittests/ut*/*.sh
-
-examples/*/a.out
-examples/*/*.o
-
 doc/*.aux
 doc/*.dvi
 doc/*.idx

CMakeLists.txt

@@ -0,0 +1,32 @@
+cmake_minimum_required (VERSION 3.5)
+include(FindPackageHandleStandardArgs)
+
+project (mci LANGUAGES CXX VERSION 0.0.1)
+
+set(CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${USER_CXX_FLAGS}")
+
+# find packages
+message(STATUS "Configured CMAKE_CXX_COMPILER: ${CMAKE_CXX_COMPILER}")
+message(STATUS "Configured CMAKE_CXX_FLAGS: ${CMAKE_CXX_FLAGS}")
+
+find_package(MPI)
+if (MPI_FOUND)
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DUSE_MPI=1")
+  include_directories(SYSTEM ${MPI_INCLUDE_PATH})
+  message(STATUS "MPI_INCLUDE_PATH: ${MPI_INCLUDE_PATH}")
+  message(STATUS "MPI_CXX_LIBRARIES: ${MPI_CXX_LIBRARIES}")
+endif()
+
+# set header / library paths
+include_directories(include/) # headers
+
+enable_testing()
+
+# continue with subdirectories
+add_subdirectory(src) 
+add_subdirectory(test)
+add_subdirectory(examples)
+

README.md

@@ -6,12 +6,15 @@ Some basic tools for finding the average and standard deviation of an array of d
 
 In `doc/` there is a user manual in pdf.
 
-In `examples/` there are several examples (STILL TO BE DONE).
+In `examples/` there are examples.
 
 
 
 # Build the library
 
-Insert the system parameters in a file named `config.sh` (use `config_template.sh` as template) and then simply execute the command
+We use the CMake build system, so you need to have it on your system to build the library out of the box.
+Then copy the file `config_template.sh` to `config.sh`, edit it to your liking and then simply execute the command
 
    `./build.sh`
+
+Note that we build out-of-tree, so the compiled library and executable files can be found in the directories under `./build/`.

build.sh

@@ -1,49 +1,6 @@
-#!/bin/bash
-
-OS_NAME=$(uname)
-echo "The Operating System is: "${OS_NAME}  # here we consider only Linux and Darwin (Mac Os X)
-
-source config.sh
-ACTUAL_FOLDER=$(pwd)
-
-\rm -f *.so
-cd src/
-\rm -f *.o *.so
-echo "$CC $FLAGS $OPTFLAGS -fpic -c *.cpp"
-$CC $FLAGS $OPTFLAGS -fpic -c *.cpp
-
-case ${OS_NAME} in
-    "Linux")
-        echo "$CC $FLAGS $OPTFLAGS -shared -o lib${LIBNAME}.so *.o"
-        $CC $FLAGS $OPTFLAGS -shared -o lib${LIBNAME}.so *.o
-        ;;
-    "Darwin")
-        ROOT_FOLDER=$(dirname $(pwd))
-        echo "$CC $FLAGS $OPTFLAGS -shared -install_name ${ROOT_FOLDER}/lib${LIBNAME}.so  -o lib${LIBNAME}.so *.o"
-        $CC $FLAGS $OPTFLAGS -shared -install_name ${ROOT_FOLDER}/lib${LIBNAME}.so -o lib${LIBNAME}.so *.o
-        ;;
-    *)
-        echo "The detected operating system is not between the known ones (Linux and Darwin)"
-        ;;
-esac
-
-mv lib${LIBNAME}.so ../
-cd ..
-
-
-echo
-echo "Library ready!"
-echo
-echo "Help, how can I use it?"
-case ${OS_NAME} in
-    "Linux")
-        echo "1)   $CC $FLAGS -I$(pwd)/src/ -c example.cpp"
-        echo "     $CC $FLAGS -L$(pwd) example.o -l${LIBNAME}"
-        echo "2)   $CC $FLAGS -I$(pwd)/src/ -L$(pwd) example.cpp -l${LIBNAME}"
-        ;;
-    "Darwin")
-        echo "1)   $CC $FLAGS -I$(pwd)/src/ -c example.cpp"
-        echo "     $CC $FLAGS -I$(pwd)/src/ -L$(pwd) example.o -l${LIBNAME}"
-        echo "2)   $CC $FLAGS -I$(pwd)/src/ -L$(pwd) example.cpp -l${LIBNAME}"
-        ;;
-esac
+#!/bin/sh
+. ./config.sh
+mkdir -p build
+cd build
+cmake -DCMAKE_CXX_COMPILER="${CXX_COMPILER}" -DUSER_CXX_FLAGS="${CXX_FLAGS}" ..
+make

build_debug_library.sh

@@ -1,19 +1,8 @@
 #!/bin/bash
 
-# Library name
-LIBNAME="mci"
+#C++ compiler
+CXX_COMPILER="g++"
 
-# C++ compiler
-CC="g++"
+# C++ flags
+CXX_FLAGS="-O3 -flto -Wall -Wno-unused-function"
 
-# MPI compiler wrapper
-MPICC="mpic++"
-
-# C++ flags (std=c++11 is necessary)
-FLAGS="-std=c++11 -Wall -Werror"
-
-# Optimization flags
-OPTFLAGS="-O3 -flto"
-
-# Debuggin flags
-DEBUGFLAGS="-g -O0"

config_template.sh

@@ -0,0 +1,6 @@
+link_libraries(mci)
+add_executable(ex1.exe ex1/main.cpp)
+if (MPI_FOUND)
+  add_executable(ex2.exe ex2/main.cpp)
+  target_link_libraries(ex2.exe ${MPI_CXX_LIBRARIES})
+endif()