Skip to content

Latest commit

 

History

History
99 lines (69 loc) · 2.99 KB

README.md

File metadata and controls

99 lines (69 loc) · 2.99 KB
Raw

CI Coverity Scan Build Status Gitter chat

LibPoly

LibPoly is a C library for manipulating polynomials. The target applications are symbolic reasoning engines, such as SMT solvers, that need to reason about polynomial constraints. It is research software under development, so the features and the API might change rapidly.

Prerequisites

To compile on an Ubuntu machine you can install the prerequisites with

sudo apt-get install gcc cmake make libgmp-dev python2.7-dev python-sympy

To compile on a Mac you can install the prerequisites with

brew install gmp cmake python
sudo easy_install pip
pip install sympy

Python (and sympy) is not necessary and is used for testing the library through the Python bindings (these are also useful for playing with the library).

Compiling

To compile and install perform

cd build
cmake .. -DCMAKE_BUILD_TYPE=$type -DCMAKE_INSTALL_PREFIX=$prefix
make
make install

The $type above is should be either "Debug" or "Release", and $prefix is the target directory where the library will be installed. The prefix can be omitted, in which case the library will be installed in the default system location (such as /usr/local).

If the tests are enabled, you can do a sanity check of the library by doing a make check.

The most up-to-date build instructions can be seen by looking at our CI build script .github/workflows/ci.yml.

Python bindings

CMake will pick up the default python available in your shell. If you'd like to force a different version you can use the Python_ADDITIONAL_VERSIONS variable. For example, to use Python3 you can configure the project with

cmake .. -DPython_ADDITIONAL_VERSIONS=3

Python Version Skew

On some platforms (i.e. Mac) cmake picks different python installations for the headers and library. If this happens, you might try:

cmake  .. -DCMAKE_BUILD_TYPE=$type  -DPYTHON_LIBRARY=$pythonlibrary  -DPYTHON_INCLUDE_DIR=$pythonheaderfiledir

For example:

cmake  .. -DCMAKE_BUILD_TYPE=Release  -DPYTHON_LIBRARY=/opt/homebrew/Cellar/[email protected]/3.9.4/Frameworks/Python.framework/Versions/3.9/lib/libpython3.9.dylib  -DPYTHON_INCLUDE_DIR=/opt/homebrew/Cellar/[email protected]/3.9.4/Frameworks/Python.framework/Versions/3.9/include/python3.9/

Installing Prebuilt Binaries

Currently you can install the libpoly library (without python support) either using Homebrew or Aptitude.

Homebrew

Installing on Darwin using homebrew can be achieved via:

brew install SRI-CSL/sri-csl/libpoly

Aptitude

To install libpoly on Ubuntu or Debian, do the following:

sudo add-apt-repository ppa:sri-csl/formal-methods
sudo apt-get update
sudo apt-get install libpoly-dev