diff --git a/README.md b/README.md index b7b53189133576b965fa7d63908c1d4b7c70f7a9..4a75338cf7b8a12dfc2e9eb86869a56e96d422d8 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,39 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. # 1. Install Required Dependencies * [CGAL](https://www.cgal.org/), with component Qt5 + Tested with master version 2b547ec58a9e34458792cb3f09ead399bb6dd075 + (cgal master, May 17th 2022) * [Boost](https://www.boost.org/), with components system and filesystem * [Qt5](https://www.qt.io/) * [TetGen](https://wias-berlin.de/software/index.jsp?id=TetGen&lang=1) + +# 2. List of commands for Ubuntu 22.04 + +If you want to use docker: + + * docker pull ubuntu:22.04 + * docker run -it ubuntu:22.04 + * (docker commit to save the state of a container) -# 2. Compile the Two Programs ```hexa-subdivision``` and ```tetra-to-hexa``` +Installation commands: + + * apt-get update + * apt-get install g++ cmake git + * apt-get install libqt5opengl5-dev libqt5svg5-dev qtbase5-dev + * apt-get install libboost-dev libboost-program-options-dev libboost-system-dev libboost-thread-dev + * apt-get install libgmp-dev libmpfr-dev zlib1g-dev + * apt-get install libtet1.5 qtscript5-dev + * to solve a missing link (bug in docker image?) + ln -s /usr/lib/x86_64-linux-gnu/libtet.so.1.5 /usr/lib/x86_64-linux-gnu/libtet.so + * git clone https://github.com/CGAL/cgal.git + * cd cgal + * git checkout 2b547ec58a9e34458792cb3f09ead399bb6dd075 + (cgal master, May 17th 2022) + * cd .. + * git clone https://gitlab.liris.cnrs.fr/gdamiand/3d-query-replace.git + * cd 3d-query-replace/ + +# 3. Compile the Two Programs ```hexa-subdivision``` and ```tetra-to-hexa``` *// We suppose the current directory is SRC_DIR* ``` @@ -21,13 +49,14 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. cd builds mkdir release cd release - cmake -DCMAKE_BUILD_TYPE=Release -DCGAL_DIR=/cgal/directory/ ../../src + cmake -DCMAKE_BUILD_TYPE=Release ../../src -DCGAL_DIR=../../../cgal/ make ``` Replace ```/cgal/directory``` by the full path to the directory containing CGAL. -# 3. Run the Programs + +# 4. Run the Programs One example of run: @@ -42,13 +71,13 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. Run ```./hexa-subdivision -h``` (or ```./tetra-to-hexa -h```) for an help showing all options. Press the ```h``` key to view the help of the interactive viewer. -# 4. Reproduce the Experiments of the Paper +# 5. Reproduce the Experiments of the Paper *// We suppose the current directory is SRC_DIR/builds/release* The experiments given in the paper are obtained by the following runs (for each run, use -draw option to view the final mesh): - # 4.1 Hexahedral subdivision + # 5.1 Hexahedral subdivision ``` ./hexa-subdivision ../../data/mesh1.off -lmax 7 @@ -56,7 +85,7 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. ./hexa-subdivision ../../data/mesh3.off -lmax 7 ``` - # 4.2 Marching-cube + # 5.2 Marching-cube ``` ./hexa-subdivision ../../data/mesh1.off -lmax 7 -marching-cubes @@ -64,7 +93,7 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. ./hexa-subdivision ../../data/mesh3.off -lmax 7 -marching-cubes ``` - # 4.3 Conformal Mesh + # 5.3 Conformal Mesh ``` ./hexa-subdivision ../../data/mesh1.off -lmax 7 -create-transitions @@ -80,7 +109,7 @@ Let us denote by SRC_DIR the root directory of the gitlab repository. ./hexa-subdivision ../../data/mesh3.off -lmax 7 -create-transitions -no-signature ``` - # 4.4 Mesh Transformation + # 5.4 Mesh Transformation Require [TetGen](https://wias-berlin.de/software/index.jsp?id=TetGen&lang=1)