Integrated Development Environment (IDE)¶

This document briefly details how user/developers can use C/C++ integrated development environments (C/C++ IDEs) that provide a comprehensive set of tools for DEST development, in the C and/or C++ programming languages

How to build and run on Visual Studio¶

Currently the only IDE that can generate all three executables (DEST_analyser, DEST_optimiser and DEST_conveyor) for Windows.

Installing Visual Studio¶

First, you should download and install your favorite desktop IDE packages (links to the various Visual Studio versions on the Visual Studio website: https://visualstudio.microsoft.com/free-developer-offers/)

Once you have downloaded the installer, you can run the installer.

Note

For more detailed approach visit https://visualstudio.microsoft.com/free-developer-offers/

start Visual Studio and click on Switch between solutions and available views

Note

Assuming you have followed the steps in https://dest-doc.readthedocs.io/en/latest/DESTconfigurationandbuild.html#how-to-build-and-run-on-windows

you will see then the following figure, select analyser.sln and then OK

then right click on solution explorer and select Rebuild solution

After everything done you will see the following

next right click on solution explorer and select properties

then enter the arguments for DEST (e.g. -filename /home/kevinb/Videos/DEST-master/src/TESTS/B_013/B_013.dat) [apply and close]

now you can run the solver

How to build and run on Visual Studio Code¶

Installing Visual Studio Code¶

First, you should download and install your favorite desktop IDE packages (links to the various Visual Studio Code versions on the Visual Studio Code website: https://code.visualstudio.com/)

Once you have downloaded the installer, you can run the installer.

Note

For more detailed approach visit https://code.visualstudio.com/docs [Visual Studio Code Docs Documentation for Visual Studio Code, including Getting Started videos Visual Studio Code Introductory Videos]

Next, enter the work directory (your working directory) and clone the DEST code into a folder, e.g. DEST-master

cd yourwork
git clone https://gitlab.DEST_master

After the code is cloned, start Visual Studio Code, and select open folder, and choose the root directory DEST

click on yes, I trust authors (of the code)

now you will be able to see DEST project inside Visual Studio Code-IDE. Next you need to install the following extensions in visual studio code

then click on build button as shown in figure

select [unspecified] let CMake guess what compiler and environment to use

configuring and generating and build will be done (the executable file in ../DEST-master/src/BIN), as shown in figure

next you need to create a launch json file (this will create a folder with the name .vscode and a file within with the name launch.json)

then you need to modify the json file as follows

{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
 "configurations": [

{
"name": "(gdb) Launch",
"type": "cppdbg",
"request": "launch",
"program": "${workspaceFolder}/BIN/DEST_analyser_Debug",
"args": ["-filename","yours/DEST-master/src/TESTS/B_013/B_013.dat"],  <-- need to be modified!
"stopAtEntry": false,
"cwd": "${fileDirname}",
"environment": [],
"externalConsole": false,
"MIMode": "gdb",
"setupCommands": [
{
    "description": "Enable pretty-printing for gdb",
    "text": "-enable-pretty-printing",
    "ignoreFailures": true
},
{
    "description":  "Set Disassembly Flavor to Intel",
    "text": "-gdb-set disassembly-flavor intel",
    "ignoreFailures": true
    }
   ]
  },
 ]
}

next go run –> debugging or press F5 and you will see that the solver will start running as shown in figure

you are now able to run and debug the code using Visual Studio Code-IDE.

How to build and run on Eclipse¶

Installing Eclipse¶

First, you should download and install your favorite desktop IDE packages (links to the various Eclipse versions on the Eclipse website: https://www.eclipse.org/downloads/)

Once you have downloaded the installer, you can run Eclipse installer.

Note

For more detailed approach visit https://www.eclipse.org/downloads/packages/installer

then select Eclipse IDE for Scientific Computing and install it:

Package Description:

Tools for C, C++, Fortran, and UPC, including MPI, OpenMP, OpenACC, a parallel debugger, and remotely building, running and monitoring applications.

This package includes:
    C/C++ Development Tools
    Git integration for Eclipse
    Mylyn Task List
    Parallel Tools Platform
    Eclipse XML Editors and Tools

Next, enter the work directory (your working directory) and clone the DEST code into a folder, e.g. DEST-master

cd yourwork
git clone https://gitlab.DEST_master

After the code is cloned, enter your work folder, make a build directory outside DEST folder and enter it

From within the build directory, run the configure command (with updated path!). Note the use of CC and CXX to select the special compilers.

cmake -G "Eclipse CDT4 - Ninja"   -DCMAKE_BUILD_TYPE:STRING="Debug" -DCMAKE_INSTALL_PREFIX:PATH="/home/kevinb/Videos/DEST-master/src/Install"  -DCMAKE_C_COMPILER="/usr/bin/cc"  -DCMAKE_CXX_COMPILER="/usr/bin/c++"  /home/kevinb/Videos/DEST-master/src/CMakeLists.txt

If configuring and generating using CMake were successful you will see something similar to the following:

At this point you can run cmake .. to e.g. disable unnecessary solvers, then run cmake as usual to build the code (with updated path!)

cmake --build /home/kevinb/Videos/Build  --clean-first  --config Debug -- "-v"

Finally, if building using CMake was successful you will see something similar to the following:

Then check the executable file in ../DEST-master/src/BIN

file DEST_analyser_Debug

For testing the executable file you can run the following:

./DEST_analyser_Debug   -filename ../TESTS/B_013/B_013.dat

Now you can start Eclipse and select/create a directory as eclipse-workspace:

then click on import a project with working Makefile

fill the project name, existing code location, etc. click on finish button as shown in figure

now you will be able to see DEST project inside Eclipse-IDE. To view or edit the project’s properties, right-click the project and select Properties and then select C/C++ build and fill it as follows (note that ninja should be already installed on system) [apply and close]

right-click the project again and select debug configurations and change it as the follows [apply and close]

on the same window click Arguments and enter the arguments for DEST (e.g. -filename /home/kevinb/Videos/DEST-master/src/TESTS/B_013/B_013.dat) [apply and close]

to configure run, right-click the project again and select run configurations and change it as the follows [apply and close]

finally, click on run button and you will see that the solver will start running

you are now able to run and debug the code using Eclipse-IDE.

How to build and run on CLion¶

Installing CLion¶

First, you should download and install your favorite desktop IDE packages (links to the various CLion versions on the CLion website: https://www.jetbrains.com/clion/)

Once you have downloaded the installer, you can run the installer.

Note

For more detailed approach visit https://www.jetbrains.com/clion/

Next, enter the work directory (your working directory) and clone the DEST code into a folder, e.g. DEST-master

cd yourwork
git clone https://gitlab.DEST_master

After the code is cloned, start CLion and select open (folder), and choose the root directory DEST

click on next

click on finish

as shown in the following figure select Edit Configuration

enter the arguments for DEST as shown in the following figure:

-filename  path to/TESTS/B_013/B_013.dat

you are now able to run and debug the code using CLion-IDE.