Building Compadre

Installing the Compadre Toolkit

Compadre Toolkit Installation Instructions

1.) Copy one of the examples bash script files from ./scripts to the folder where you would like to build the project. Ideally, this should not be at the root of the repository as it is never suggested to build in-source.

example:

  >> mkdir build
  >> cp ./scripts/script_you_choose.sh build

2.) Edit the script file that you copied to your soon-to-be build folder. Make changes to these files to suit your needs (KokkosCore_PREFIX, etc...) Then, run the modified bash script file.

(assumes you moved the script to ./build as in #1 )

  >> cd ./build
  >> vi script_you_choose.sh

(make any changes and save, Python Interface and Matlab examples)

  >> ./script_you_choose.sh

3.) Build the project.

  >> make -j4                      # if you want to build using 4 processors
  >> make install

4.) Test the built project by exercising the suite of tests.

  >> ctest

5.) Build doxygen documentation for the project by first entering the directory [REPO-ROOT]/doc and then running

  >> ./build_docs
  >> [your favorite internet browser executable] ./html/index.html

If some tests fail, be sure to check the error as it is possible that you have not configured CMake as to where it should locate libraries like Kokkos, Python, etc... If a library is missing but not turned on in the CMake options, then the test will simply fail.