README
author Dmitriy Morozov <morozov@cs.duke.edu>
Fri, 04 Apr 2008 21:14:44 -0400 (2008-04-05)
branchdev
changeset 87 2c2e2f3b5d15
parent 50 264e05b89875
child 96 f283106e8124
permissions -rw-r--r--
Merge in AR branch
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
5
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     1
Dependencies
23
cb700b407c0d Fixed to compile with CGAL 3.3
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 19
diff changeset
     2
  CGAL-3.3 -    for alpha-shapes and kinetic data structures
50
264e05b89875 Added ability to disable the use of DSR-PDB (disabled by default)
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 33
diff changeset
     3
  DSR-PDB -     for reading in PDB files (if use_dsrpdb is turned on in cmake)
33
3318eb317618 Updated README to reflect changes to the logging
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 24
diff changeset
     4
  CMake -       for controlling the build process
5
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     5
  boost -       great set of C++ libraries
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     6
  Doxygen -     for building documentation
33
3318eb317618 Updated README to reflect changes to the logging
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 24
diff changeset
     7
  rlog -        for logging only (is not needed by default)
3318eb317618 Updated README to reflect changes to the logging
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 24
diff changeset
     8
  SYNAPS -      for solving polynomials (for kinetic kernel), which in turn requires GMP
5
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     9
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    10
Configuration
15
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    11
  The path to CGAL's Makefile is expected to be set in $CGAL_MAKEFILE, the rest
24
99e03a2c741d Fixed typos in README
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 23
diff changeset
    12
  is just the usual CMake configuration
5
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    13
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    14
Building
15
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    15
  To build examples, create a directory build (to keep everything in one place),
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    16
  go to that directory and run cmake and make:
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    17
  mkdir build
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    18
  cd build
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    19
  cmake ..   (or "ccmake .." if you want a curses interface)
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    20
  make
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    21
  
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    22
  In the cmake line you can provide -Ddebug:bool=on to turn on debugging,
33
3318eb317618 Updated README to reflect changes to the logging
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 24
diff changeset
    23
  -Dcounters:bool=on to turn on counters, -Doptimize:bool=on to turn on
50
264e05b89875 Added ability to disable the use of DSR-PDB (disabled by default)
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 33
diff changeset
    24
  optimization, -Duse_dsrpdb:bool=on to turn on reading PDB files.  Depending on
264e05b89875 Added ability to disable the use of DSR-PDB (disabled by default)
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 33
diff changeset
    25
  the combination of debugging and optimization, a particular CMAKE_CXX_FLAGS*
264e05b89875 Added ability to disable the use of DSR-PDB (disabled by default)
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 33
diff changeset
    26
  is chosen.  All of this can be set using a text user interface by running
264e05b89875 Added ability to disable the use of DSR-PDB (disabled by default)
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 33
diff changeset
    27
  ccmake instead of cmake.
5
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    28
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    29
Author
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    30
  Dmitriy Morozov <morozov@cs.duke.edu>