Skip to content

Latest commit

 

History

History
89 lines (62 loc) · 4.71 KB

README.md

File metadata and controls

89 lines (62 loc) · 4.71 KB
Raw

DGtal logo

Main website: http://dgtal.org

Description

DGtal is a generic open source library for Digital Geometry programming for which the main objective is to structure different developments from the digital geometry and topology community. The aims are numerous: make easier the appropriation of our tools for a neophyte (new PhD students, researchers from other topics,...), permit better comparisons from new methods with already existing approaches and to construct a federative project. Another objective of DGtal is to simplify the construction of demonstration tools to share new results and potential efficiency of the proposed work.

Quick Install

  • MacOS (using homebrew):

     brew tap DGtal-team/DGtal
 brew install dgtal

(brew options dgtal to enable optional features)

  • Linux and windows: no binary package, please compile the library.

Additional instructions are available in the documentation.

Quick Build Instructions

More details are given in the documentation pages. We just sketch the main instructions on linux/unix-based systems:

git clone https://github.com/DGtal-team/DGtal.git
cd DGtal ; mkdir build ; cd build
cmake ..
make install

Minimum system requirements: C++11 enabled compiler, cmake, boost (>= 1.50).

DGtal can be compiled on Microsoft Windows system using Visual Studio 2014 (or newer): Generate the Visual Studio project using windows cmake tool and compile the DGtal solution (you may also need to set the cmake variable BUILD_SHARED_LIBS to false).

Docker

A Docker file is included in the repository in order to allow the users to build a docker image with the DGtal library installed. Inside the docker container, the library is installed with many optional dependencies (gmp, eigen, cgal, itk, cairo, qglviewer, openmp, fftw3) so the user can start developing without the need to install DGtal on the system.

To build the Docker image, Docker should have been installed in the system (to install Docker) download the Dockerfile inside the DGtal repository, in the same directory where the Dockerfile is located execute

docker build -t dgtal:lastest .

To run an interactive terminal inside the docker container and see the examples

docker run -it --user=digital dgtal:lastest bash
cd /home/digital/git/DGtal/build/examples

To enable Viewer3D/QGLViewer features, please check this discussion.

More Information