Skip to content

Latest commit

 

History

History
76 lines (55 loc) · 2.79 KB

README.md

File metadata and controls

76 lines (55 loc) · 2.79 KB
Raw

causal-sets-explorer

Linux Clang Linux GCC macOS Windows CodeQL codecov

Causal sets explorer will eventually perform graph-theoretic calculations on Causal sets.

It's also a test-bed for CDT-plusplus.

Initial Set Up

This project uses vcpkg. To get started, first install vcpkg.

git clone https://github.com/Microsoft/vcpkg.git
cd vcpkg
./bootstrap-vcpkg.sh
./vcpkg integrate install

vcpkg is then invoked by CMake in vcpkg manifest mode to install project dependencies listed in vcpkg.json into the local vcpkg_installed directory.

Next, clone this repo:

git clone https://github.com/acgetchell/causal-sets-explorer.git
cd causal-sets-explorer

Now we'll install dependencies:

vcpkg install

Finally, you can build with CMake:

cmake -S . -B build
cmake --build build

The executable will be in the build directory.

If you want to run tests, you can do:

cd build
ctest --output-on-failure -j2

This is mostly automated in scripts/build.sh.

Contributing

Please ensure you do the following:

  • Whitespace formatting using git diff --check HEAD^
  • clang-format with project settings using git-clang-format
  • Address Sanitzer with asan.sh
  • clang-tidy with clang-tidy.sh
  • cppcheck with cppcheck.sh