Skip to content

GitLab

W SLDA Toolkit API · Changes

Page history
Update W SLDA Toolkit API authored by Gabriel Wlazłowski's avatar Gabriel Wlazłowski
Hide whitespace changes
Inline Side-by-side
W-SLDA-Toolkit-API.md
View page @ 790829d4
# Introduction # Introduction
The main part of W-SLDA Toolkit is an engine for solving BdG-type equations. However, the solution of these equations does not solve a full problem, which typically requires further exploration of results. For this you can use VisIt, however, in many cases it is not sufficient. For this reason [extensions](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/extensions) were introduced. 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](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/extensions) were introduced.
Extensions are small C codes that can be used to support the computation process and data analysis process. The toolkit is equipped with various templates for such codes and examples. 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 # API
To have access to implemented already functions and functionalities by W-SLDA Toolkit you need to add to your code the following header: To have access to already implemented functions and functionalities by the W-SLDA Toolkit, you need to add to your code the following header:
```c ```c
// Optionally: if you want to use W-DATA format // Optionally: if you want to use W-DATA format
// W-DATA Format // W-DATA Format
...@@ -15,10 +15,10 @@ To have access to implemented already functions and functionalities by W-SLDA To ...@@ -15,10 +15,10 @@ To have access to implemented already functions and functionalities by W-SLDA To
// Note: it loads predefines.h! // Note: it loads predefines.h!
#include "wslda_toolkit.h" #include "wslda_toolkit.h"
``` ```
When using W-SLDA Toolkit API you are forced to use [C99](https://en.wikipedia.org/wiki/C99) standard. To compile code with such header use command of structure: When using the W-SLDA Toolkit API, you are forced to use [C99](https://en.wikipedia.org/wiki/C99) standard. To compile code with such a header, use the command of structure:
```bash ```bash
gcc -std=gnu99 -I$WSLDA/hpc-engine -I$WSLDA/lib/wdata/c -L$WSLDA/lib/wdata -lwdatac -I$YOUR_PROJECT_FOLDER ... 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=.`. 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 W-SLDA Toolkit API is just to explore provided templates and codes in [extensions](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/extensions). The simplest way of learning how to use the W-SLDA Toolkit API is just to explore the provided templates and codes in [extensions](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/extensions).
\ No newline at end of file \ No newline at end of file