Get, Build, Install

The most up to date code is available from my Mercurial repository. If you have Mercurial, the easiest way to obtain the code is by cloning it:

hg clone http://hg.mrzv.org/Dionysus/
cd Dionysus

If you don’t have time or desire to deal with Mercurial, you can download the tarball of the entire repository. The advantage of using Mercurial is that it makes it very easy to keep up with the updates that are periodically committed to the repository:

hg pull -u

Dependencies

Dionysus requires the following software:

CMake:for building (version \geq 2.6)
Boost:C++ utilities (version \geq 1.36; including Boost.Python used to create Python bindings)

Optional dependencies:

CGAL:for alpha shapes (version \geq 3.4)
CVXOPT:for circle-valued parametrization using LSQR
PyQt4:for viewer module
PyOpenGL, NumPy:
 for 3D visualization in viewer module
PyX:tools/draw-diagram/draw.py uses PyX to produce a PDF of the diagram
rlog:used for logging only (not needed by default)

Building

To build the examples as well as the Python bindings, create a directory build. Inside that directory run cmake and make:

mkdir build
cd build
cmake ..
make

Tip

To use GCC 4.2 on a Mac one can try CXX=g++-4.2 cmake .. instead of cmake ...

Instead of cmake, one can run ccmake for a curses interface. The following configuration options are available. One can set them either through the curses interface or by passing a flag of the form -Doptimize:bool=on to cmake.

debug:Turns on debugging compilation
optimize:Turns on compiler optimizations (on by default)
logging:Turns on logging facilities
counters:Turns on various built-in counters

Depending on the combination of debugging and optimization, a particular CMAKE_CXX_FLAGS* is chosen.

Tip

The default settings work fine unless you want to dive into the library’s internals with logging or study the performance of various algorithms with counters.

Todo

Write sections on logging and counters.

Some parts of Dionysus understand the DEBUG_CONTAINERS definition which can be appended to CMAKE_CXX_FLAGS. If set, the library will use GCC STL’s debugging containers (from the std::__debug namespace defined in debug/* header files). These containers return safe iterators (the kind that check whether they are singular when compared, or additionally whether they are out of bounds when dereferenced).

Todo

ZIGZAG_CONSISTENCY definition

Install

At the moment there are no installation procedures. To run the Python code you need to have .../build/bindings/python somewhere in your PYTHONPATH. I.e. add:

export PYTHONPATH=.../build/bindings/python

to your ~/.bashrc (assuming you are using Bash). Alternatively, run the python examples from within .../build/bindings/python:

python .../Dionysus/examples/triangle/triangle.py

The C++ examples can be run from anywhere. The C++ library consists only of header files (no library actually needs to be built), so to compile against it, it suffices to add -I .../Dionysus/include to your g++ flags:

g++ your-code.cpp -o your-code -I .../Dionysus/include

Proper installation procedures (with make install) will be added in the future.