Introduction

The main part of the W-SLDA Toolkit is an engine for solving BdG-type equations. However, the solution to these equations does not fully address the problem, which typically requires further exploration of the results. For this, you can use VisIt; however, in many cases it is insufficient. For this reason, extensions were introduced.

Extensions are small C programs that can be used to support computation and data analysis. The toolkit includes various templates and examples for such codes.

API

To have access to already implemented functions and functionalities by the W-SLDA Toolkit, you need to add to your code the following header:

// Optionally: if you want to use W-DATA format
// W-DATA Format
// Must be before wslda_toolkit.h!
#include "wdata.h"

// W-SLDA Toolkit API
// Note: it loads predefines.h!
#include "wslda_toolkit.h"

When using the W-SLDA Toolkit API, you are forced to use C99 standard. To compile code with such a header, use the command of structure:

gcc -std=gnu99 -I$WSLDA/hpc-engine -I$WSLDA/lib/wdata/c -L$WSLDA/lib/wdata -lwdatac -I$YOUR_PROJECT_FOLDER ...

where YOUR_PROJECT_FOLDER points to the folder where your predefines.h is located. It is recommended to copy and compile extension codes in the project folder, then YOUR_PROJECT_FOLDER=..

The simplest way of learning how to use the W-SLDA Toolkit API is just to explore the provided templates and codes in extensions.