Git Product home page Git Product logo

mpicxx's Introduction

mpicxx - A header only C++ wrapper library for MPI

Test with GCC Test with clang

Codacy Badge Generic badge

License: MIT

This library provides a small C++ wrapper for MPI libraries (like OpenMPI or MPICH).

Getting Started

Prerequisites

Installing

This library supports the normal CMake toolchain.

git clone [email protected]:arkantos493/MPICXX.git
cd MPICXX
mkdir build && cd build
cmake [options] ..
make -j

Supported CMake options (incomplete for options without MPICXX prefix)

option default value description
CMAKE_BUILD_TYPE Release specifies the build type on single-configuration generators
CMAKE_INSTALL_PREFIX /usr/local/include install directory used by make install
MPICXX_ENABLE_TESTS Off use the googletest framework (automatically installed if this option is set to On) to enable the make test target
MPICXX_ENABLE_DEATH_TESTS Off enables gtest's death tests (currently not supported for MPI during its internal usage of fork()); only used if MPICXX_ENABLE_TESTS is set to On
MPICXX_GENERATE_DOCUMENTATION Off enables the documentation target make doc; requires doxygen
MPICXX_GENERATE_TEST_DOCUMENTATION Off additionally document test cases; only used if MPICXX_GENERATE_DOCUMENTATION is set to On
MPICXX_ASSERTION_LEVEL 0 sets the assertion level; emits a warning if used in Release mode;
  • 0 = no assertions
  • 1 = only precondition assertions
  • 2 = precondition and sanity assertions
MPICXX_ENABLE_STACK_TRACE On enable stack traces for the source location implementation
DMPICXX_MAX_NUMBER_OF_ATFINALIZE_CALLBACKS 32 sets the maximum number of atfinalize callback functions

Running the tests

This library supports ctest together with CMake:

cmake -DMPICXX_ENABLE_TESTS=On ..
make -j
ctest

Generate the documentation

This library integrates doxygen within CMake:

cmake -DMPICXX_GENERATE_DOCUMENTATION=On ..
make doc

To additionally generate documentation for the test cases:

cmake -DMPICXX_GENERATE_DOCUMENTATION=On -DMPICXX_GENERATE_TEST_DOCUMENTATION=On ..
make doc

Deployment

This library supports the make install target:

cmake -DCMAKE_BUILD_TYPE=Release ..
make install

For a debug build one should enable assertions:

cmake -DCMAKE_BUILD_TYPE=Debug -DMPICXX_ASSERTION_LEVEL=2 ..
make install

To then use this library simple add the following lines to your CMakeLists.txt file:

# find the library
find_package(mpicxx CONFIG REQUIRED)
find_package(fmt REQUIRED)

# link it against your target
target_link_libraries(target PUBLIC mpicxx::mpicxx)

Examples

For usage examples see the doxygen documentation or the wiki.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

mpicxx's People

Contributors

breyerml avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.