Installation guide

1. Install nlohmann::json

git clone https://github.com/nlohmann/json.git ./external/json

2. Install PETSc

This is the short summary of PETSc installation process. To take an in-depth look on the configuring process, check the documentation or run ./configure --help. First, clone and update PETSc repository.

git clone -b release https://gitlab.com/petsc/petsc.git ./external/petsc

Change the directory to ./external/petsc/ and configure the library. The following code creates two configurations of the library with use of preinstalled MPI compilers and downloads just BLAS/LAPACK to the output directories PETSC_ARCH.

./configure PETSC_ARCH=linux-mpi-debug  \
  --with-fc=0                           \
  --with-cc=/usr/bin/mpicc              \
  --with-cxx=/usr/bin/mpicxx            \
  --with-mpiexec=/usr/bin/mpiexec       \
  --with-threadsafety=1                 \
  --with-openmp=1                       \
  --download-f2cblaslapack
make PETSC_ARCH=linux-mpi-debug all
make PETSC_ARCH=linux-mpi-debug check

./configure PETSC_ARCH=linux-mpi-opt             \
  --with-fc=0                                    \
  --with-cc=/usr/bin/mpicc                       \
  --with-cxx=/usr/bin/mpicxx                     \
  --with-mpiexec=/usr/bin/mpiexec                \
  --with-threadsafety=1                          \
  --with-openmp=1                                \
  --download-f2cblaslapack                       \
  --with-debugging=0                             \
  COPTFLAGS='-O3 -march=native -mtune=native'    \
  CXXOPTFLAGS='-O3 -march=native -mtune=native'
make PETSC_ARCH=linux-mpi-opt all
make PETSC_ARCH=linux-mpi-opt check

If configure cannot automatically download the package, you can use a pre-downloaded one. Once the tarfile is downloaded, the path to this file can be specified to configure and it will proceed to install this package and then configure PETSc with this package.

3. Compiling and running xpic

Now, the executable can be built successfully. To do so, run the following command from the home directory:

./build.sh

The binary will be created in the ./build folder. Execution of the code should be performed from the home directory too:

./run.sh <config.json> [options]

Examining clang-tidy errors

To run clang-tidy over the project we use the approach with compile_commands.json. To produce this file, we explicitly set the CMAKE_EXPORT_COMPILE_COMMANDS in our cmake. After the build step, we can use thin run-clang-tidy wrapper to produce the output.

./run-clang-tidy.sh [options]