Installation

Foreword

This program is tested on python 2.7 on a GNU/Linux operating system. It uses Python bindings to the SAT solver CryptoMiniSat, which comes with the Cadbiom library.

We do not plan to port Cadbiom on Python 3. The first reason is that the GUI of Cadbiom is based on GTK2 (formerly GIMP Toolkit) that works exclusively with Python 2.7, and sadly, can not be easily ported without heavy design changes to GTK3 that is specific to Python 3.

For a comfortable use on Microsoft Windows systems we recommend the use of virtual machines like Virtual Box. In a general way, if you need to perform computationally intensive uses, you will probably want to move to a cluster-like infrastructure running a GNU/Linux operating system.

However, it should be possible to install the software suite under Microsoft Windows via Cygwin which is a large collection of GNU and Open Source tools which provide functionality similar to a GNU/Linux distribution on Microsoft Windows.

The porting to a native Python 2.7 application for Microsoft Windows is impossible, because of the age of this version of Python now deprecated, and the design of the C and C++ libraries of this platform (more information here).

System requirements

Please check the system requirements on the main website or on the Gitlab repository.

Virtual environment

As always, the use of a Python virtual environment (via virtualenvwrapper) is strongly advised.

This is not a mandatory step but it is a good practice to separate projects from each other.

  • Install virtualenvwrapper:
pip install virtualenvwrapper
  • Edit your .bashrc or .zshrc file to source the virtualenvwrapper.sh script with these lines:
export WORKON_HOME=~/.virtualenvs
mkdir -p $WORKON_HOME
# The location of this script may vary depending on your Linux distro.
source /usr/bin/virtualenvwrapper.sh
  • Restart your terminal or run:
source /usr/bin/virtualenvwrapper.sh
  • Create your virtualenv:
mkvirtualenv cadbiom -p /usr/bin/python2.7
  • Later if you want to reactivate the virtualenv:
workon cadbiom

Installation

Cadbiom package is available on PyPI (Python Package Index), the official third-party software repository for Python language.

You can install these packages with the following command on all systems that run Python interpreter:

pip install cadbiom-cmd cadbiom-gui

Note

The package of the library itself (cadbiom) is automatically installed as a dependency when the gui or the command line is installed via pip.

For developers

Install from sources

If you want to install from the sources, the library with its GUI and command line, just do:

git clone https://gitlab.inria.fr/pvignet/cadbiom

and then:

make install

If you want to make changes in the code without having to reinstall the packages, it is strongly advised to use the following command:

make dev_install

Uninstall

Depending on the installation method you have chosen in the previous chapter:

make uninstall
# or
make dev_uninstall