README.md 1020 Bytes
Newer Older
Viacheslav's avatar
Viacheslav committed
1 2 3
[![build status](https://gitlab.com/mimic-cpmd/MimicCommLib/badges/master/build.svg)](https://gitlab.com/mimic-cpmd/MimicCommLib/commits/master)
[![coverage report](https://gitlab.com/mimic-cpmd/MimicCommLib/badges/master/coverage.svg)](https://gitlab.com/mimic-cpmd/MimicCommLib/commits/master)

Viacheslav's avatar
Viacheslav committed
4 5 6 7 8 9 10 11 12 13
This directory contains the first working version of the MiMiC
communication library, to be linked to both GROMACS and CPMD to
facilitate a QM/MM calculation. However, no released version of either
code yet supports such linking. The source code is found in
the src directory.

Building the library requires a C++11 compiler, MPI2.0 compliant MPI library
and cmake version 2.6 or higher. To build, run

mkdir build
Viacheslav's avatar
Viacheslav committed
14

Viacheslav's avatar
Viacheslav committed
15
cd build
Viacheslav's avatar
Viacheslav committed
16

Viacheslav's avatar
Viacheslav committed
17
cmake ..
Viacheslav's avatar
Viacheslav committed
18

Viacheslav's avatar
Viacheslav committed
19 20 21 22 23 24
make

To use the library one will need to link against the built library
including the MessageApi.h header

To build tests:
Viacheslav's avatar
Viacheslav committed
25

Viacheslav's avatar
Viacheslav committed
26
mkdir build
Viacheslav's avatar
Viacheslav committed
27

Viacheslav's avatar
Viacheslav committed
28
cd build
Viacheslav's avatar
Viacheslav committed
29 30 31

cmake -DCMAKE_BUILD_TYPE=Debug -DINCLUDE_TESTS=ON ..

Viacheslav's avatar
Viacheslav committed
32
make
Viacheslav's avatar
Viacheslav committed
33

Viacheslav's avatar
Viacheslav committed
34 35 36
ctest

GTest library will be downloaded and compiled in order to run unit tests