This is the main source repository of the Vampire project, an advanced tool for automated reasoning.
The following is for end-users of Vampire: new developers should read HACKING.md as well.
Please see LICENCE for usage restrictions. Note that Vampire's source includes a vendored copy of Minisat and optionally links to Z3. Such code is provided under their own licence.
Please use GitHub's integrated issue tracker to file bug reports and make suggestions for future Vampire features. Please provide as much information and detail as possible in either case.
A statically-linked build suitable for running on StarExec is provided with each release; this may well run on your system also. If not, you will need to build Vampire from source, but this is not too onerous.
See the website's usage section.
Vampire is built with the help of CMake. CMake does not run any build commands directly: instead, it can generate a number of different output formats, such as UNIX Makefiles. If you are completely new to CMake, there is a tutorial for end-users.
A typical build on a UNIX-like system might look like this:
# make a clean directory to build Vampire into
$ mkdir /tmp/build && cd /tmp/build
# Configure the build and generate files with CMake
$ cmake /path/to/vampire
-- The C compiler identification is GNU 9.3.0
-- The CXX compiler identification is GNU 9.3.0
-- Check for working C compiler: /usr/bin/cc
-- Check for working C compiler: /usr/bin/cc -- works
-- Detecting C compiler ABI info
-- Detecting C compiler ABI info - done
-- Detecting C compile features
-- Detecting C compile features - done
-- Check for working CXX compiler: /usr/bin/c++
-- Check for working CXX compiler: /usr/bin/c++ -- works
-- Detecting CXX compiler ABI info
-- Detecting CXX compiler ABI info - done
-- Detecting CXX compile features
-- Detecting CXX compile features - done
-- Setting build type to 'Release' as none was specified.
-- Found Z3 4.8.9.0
-- Setting binary name to 'vampire_z3_rel_master_4933'
-- Configuring done
-- Generating done
-- Build files have been written to: /tmp/build
# Build Vampire, in this case with make(1)
$ make
<snip>
# You now have a Vampire binary
$ ls bin/
vampire_z3_rel_master_4933
$Vampire can optionally link to a fixed version of the external Z3 library.
If you wish to do this, initialise the z3 submodule in the Vampire source directory.
Then follow the Z3 CMake instructions to build the Z3 libraries into Vampire's tree at z3/build/.
This is where Vampire's build system will look for Z3: if it finds it, it will automatically link to Z3.
A reasonable Z3 build might look like this:
# Build Z3 into vampire/z3/build
$ mkdir -p /path/to/vampire/z3/build && cd /path/to/vampire/z3/build
# Configure single-threaded build, no debug symbols
$ cmake .. -DZ3_SINGLE_THREADED=1 -DCMAKE_BUILD_TYPE=Release
<snip>
# Build Z3, in this case with make(1)
$ make
<snip>- Vampire can be statically linked, with e.g.
cmake /path/to/vampire -DBUILD_SHARED_LIBS=0 - To compile Vampire in debug mode, add
-DCMAKE_BUILD_TYPE=Debugto the cmake call. - You may find setting a CMake installation directory (e.g. with
cmake /path/to/vampire -DCMAKE_INSTALL_PREFIX=/opt/vampire) helpful.