Getting Started

Getting Started#

Download the code#

To download DACTI to your machine, make sure you have Git installed. We recommend cloning the repository via SSH. If you haven’t generated ssh key pairs yet, do

  1. Generate a new SSH key pair and save them to the directory $HOME/.ssh

    ssh-keygen -t ed25519 -f $HOME/.ssh/id_ed25519_github

    You can skip giving a passphrase by pressing Enter.

  2. Add the .pub key to your Github account

    Note

    The private key id_ed25519_github should be kept secret.

  3. Clone the repository

    git clone git@github.com:DACTI-lib/DACTI.git

Building the code#

We use CMake to build the executable. The configuration can be found in DACTI/CMakeLists.txt. First make sure you have installed CMake and a C++ compiler, such as GCC or Clang. You would also need to install VTK for data output.

To build the code

  1. Create a build directory

    cd /path/to/DACTI
mkdir build; cd build

  2. Configure CMake

    cmake ..

  3. Build executable

    cmake --build . -j4 --target $EXAMPLE #-j4 for parallel build

    All available examples can be found in DACTI/src/examples.

  4. Run

    cd path/to/DACTI
.build/$EXAMPLE cases/$CONFIG.toml

    .toml are configuration files for the examples, where you can define your own test case.

DACTI on ETH Euler Cluster#

This section is for users who have access to the Euler cluster at ETH Zurich. If you have never used Euler before, check out Getting started with cluster.

To build and run DACTI on Euler

  1. Load the necessary modules

    module load stack/2024-05 gcc/13.2.0 mesa/23.0.3 cmake

  2. Download and install VTK

    # create a directory to install VTK
mkdir $HOME/.vtk

# download from the internet
wget https://github.com/Kitware/VTK/releases/tag/v9.3.0/VTK-9.3.0.zip
unzip VTK-9.3.0.zip; cd VTK-9.3.0/

# build and install
mkdir build; cd build
cmake -DCMAKE_INSTALL_PREFIX=~/.vtk -DVTK_BUILD_TESTING=OFF -DVTK_BUILD_EXAMPLES=OFF -DVTK_OPENGL_HAS_OSMESA=ON -DVTK_USE_X=OFF -DVTK_USE_SDL2=OFF ..
sbatch -n1 --cpus-per-task=16 --wrap="cmake --build . -j16" # compile on compute node
cmake --install .

    Here, VTK version 9.3.0 is recommended.

  3. Clone the repository

    cd $HOME
git clone git@github.com:DACTI-lib/DACTI.git

  4. Build the code

    cd DACTI
mkdir build; cd build
cmake -DVTK_DIR=$HOME/.vtk/lib/cmake/vtk-9.3/ -DGLFW_USE_OSMESA=ON ..
cmake --build . -j4 --target $EXAMPLE

    You might encounter the compilation error

    Error

    error: template-id not allowed for destructor

    To solve this, go to DACTI/build/_deps/libigl-src/include/igl/WindingNumberTree.h and replace line 217

    inline igl::WindingNumberTree<Point,DerivedV,DerivedF>::~WindingNumberTree<Point,DerivedV,DerivedF>()

    with

    igl::WindingNumberTree<Point,DerivedV,DerivedF>::~WindingNumberTree()

  5. Run

    Submit a job using the Slurm system. More information can be found here.

Contents