Getting started

Prepare your system

In order to compile and run girdap, it is recommended to prepare your system first and install necessary compilers and build tools for Windows, Ubuntu and Mac OS. Details can be found here.

Download or clone girdap

First download or clone girdap from the Github repo.

Build girdap

Extract the package into a directory. The girdap’s base folder is named as girdap as default. It comes with the following directory structure;

- girdap
  + src      // *.cpp files are here; also basic main.cpp is placed here; 
  + include  // *.hpp files are here; 
  + bin      // executables are placed here after build
  + library  // a library w/o main.cpp is placed here after build
  + example  // various examples of main.cpp can be found here; 

example direction contain main.cpp files which can utilize girdap’s functionality. Some of the tutorials will be placed inside this directory. Develop your own or modify one of them as your girdap code and place it in the root of src directory and follow the procedure below to build your code:

1
2
3
4
5
6
7
cd dir_of_your_choice
tar -xzvf girdap.tar.gz
cd girdap
# Make changes to the main_xxx.cpp
# modify CMakeLists.txt to point it to main_xxx.cpp
cmake .
make

Now, you can run your code with the executable girdap which is placed in the girdap/bin directory.

1
bin/girdap

Examples/tutorials can be built with the make command:

1
make div          # div is the name of the example 

On a successful build, the executable will be placed in girdap/bin directory with the example’s name. For the example above, executable file will be named as div.