README
author Dmitriy Morozov <morozov@cs.duke.edu>
Tue, 14 Aug 2007 17:15:08 -0400 (2007-08-14)
changeset 20 7bf6aa6b0ab6
parent 19 efa14432761a
child 23 cb700b407c0d
permissions -rw-r--r--
Broke include/ into separate topology/ and utilities/ subdirectories
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
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     2
  CGAL-3.2 -    for alpha-shapes and kinetic data structures
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
     3
  DSR-PDB -     for reading in PDB files
15
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
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
15
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
     7
  libcwd -      for debugging only (is not needed by default)
19
efa14432761a Initial geometry commit
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 15
diff changeset
     8
  synaps -      for solving polynomial (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
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    12
  is just 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,
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    23
  -Dcounters:bool=on to turn on counters, -Doptimize:int=3 would set
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    24
  optimization to -O3. All of this can be set using a text user interface by
ef3bf83302ca Switched to CMake
Dmitriy Morozov <morozov@cs.duke.edu>
parents: 7
diff changeset
    25
  running 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
    26
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    27
Author
ee9052408c40 Switched to a new architecture (Vineyard is a visitor for Filtration),
Dmitriy Morozov <morozov@cs.duke.edu>
parents:
diff changeset
    28
  Dmitriy Morozov <morozov@cs.duke.edu>