| ... | ... | @@ -4,11 +4,11 @@ |
|
|
|
|
|
|
|
# Folders structure
|
|
|
|
* [extensions](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/extensions)
|
|
|
|
Here we store small C code templates that can be used as supporting tools for computational processes or results analysis. To use the code, copy it into your project folder first. Compilation instructions are usually provided in the code header.
|
|
|
|
Here we store small C code templates that can be used as supporting tools for computational processes or results analysis. Some of them need to be copied into your project folder before they can be used. Description and compilation instructions are usually provided in the code header.
|
|
|
|
* [gpe-project-template](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/gpe-project-template)
|
|
|
|
Main template folder for `GPE` type project. When you start a new project (calculations), please make a copy of this folder:
|
|
|
|
Main template folder for `GPE` type project. When starting a new project (calculations), users need to make a copy of this folder:
|
|
|
|
`cp -r $WSLDA/gpe-project-template gpe-my-project-name`
|
|
|
|
and then introduce modifications to the new folder.
|
|
|
|
and then introduce modifications to the files in it.
|
|
|
|
* [hpc-engine](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/hpc-engine)
|
|
|
|
Here we store all C and CUDA files related to the HPC engine. Only developers familiar with HPC techniques should modify this folder.
|
|
|
|
* [lib](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/lib)
|
| ... | ... | @@ -17,26 +17,25 @@ Here we store external libs used by W-SLDA. These are clones of external reposit |
|
|
|
./install-libs.sh
|
|
|
|
```
|
|
|
|
* [st-project-template](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/st-project-template)
|
|
|
|
Main template folder for `static` type project. When you start a new project (calculations), please make a copy of this folder:
|
|
|
|
Main template folder for `static` type project. When starting a new project (calculations), users need to make a copy of this folder:
|
|
|
|
`cp -r $WSLDA/st-project-template st-my-project-name`
|
|
|
|
and then introduce modifications to the new folder.
|
|
|
|
and then introduce modifications to the files in it.
|
|
|
|
* [st-testcase-uniform](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/st-testcase-uniform)
|
|
|
|
the testing case for a uniform problem. When you start calculations on a new machine or with new settings it is recommended to check the correctness of calculations using this testing case. The test solves DFT equations for the uniform problem. The testings case can be also used for benchmarking the computation process, estimating the cost of the computation, etc.
|
|
|
|
The testing case for a uniform problem. When starting calculations on a new machine or with new settings, it is recommended to verify the calculations using this test case. The test solves DFT equations for the uniform problem. The test case can also be used for benchmarking the computation process, estimating the computation cost, etc.
|
|
|
|
* [td-project-template](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/td-project-template)
|
|
|
|
template for `time dependent` type project. When you start new project (calculations), please make copy of this folder:
|
|
|
|
template for `time-dependent` type project. When starting a new project (calculations), users need to make a copy of this folder:
|
|
|
|
`cp -r td-project-template td-my-project-name`
|
|
|
|
and then introduce modifications to the new folder.
|
|
|
|
*Note*: `td` projects require CUDA.
|
|
|
|
and then introduce modifications to the files in it.
|
|
|
|
* [td-testcase-uniform](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/td-testcase-uniform)
|
|
|
|
the testing case for a uniform problem. When you start calculations on a new machine or with new settings it is recommended to check the correctness of calculations using this testing case. The test is constructed in an analogs way as to the static case. The test case evolves stationary uniform state and `td-wslda-?d` codes should evolve it without any noticeable changes. (All printed physical quantities on the screen should be time-independent).
|
|
|
|
The testing case for a uniform problem. When starting calculations on a new machine or with new settings, it is recommended to verify the calculations using this test case. The test is constructed in a manner analogous to the static case. The test case evolves a stationary uniform state, and `td-wslda-?d` codes should evolve it without any noticeable changes. (All printed physical quantities on the screen should be time-independent).
|
|
|
|
* [templates](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/templates)
|
|
|
|
storage for templates that are machine-dependent like `machine.h` files, Makefiles, or examples of job submission scripts. The distribution provides examples of such files for various machines listed in [templates/README.md](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/templates/README.md). In the main folder we provide a simple script for copying templates to appropriate folders:
|
|
|
|
Storage for templates that are machine-dependent, like `machine.h` files, Makefiles, or examples of job submission scripts. The distribution provides examples of such files for various machines listed in [templates/README.md](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/templates/README.md). In the main folder, we provide a simple script for copying templates to appropriate folders:
|
|
|
|
```bash
|
|
|
|
./install-templates.py system
|
|
|
|
```
|
|
|
|
* [testsuite](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/testsuite)
|
|
|
|
the testing system of W-SLDA Toolkit and accompanying tests, see [here](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/wikis/Testsuite) for more info.
|
|
|
|
The testing system for the W-SLDA Toolkit and accompanying tests; see [here](Testsuite) for more info.
|
|
|
|
* [tools](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/tools)
|
|
|
|
collection of useful tools, mainly for data processing. After executing `make` the tools will be compiled to `tools/bin`.
|
|
|
|
A collection of standalone tools, mainly for supporting the W-SLDA infrastructure. After executing `make`, the tools will be compiled to `tools/bin`.
|
|
|
|
* [tex](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/tex)
|
|
|
|
here we store various files with documentation in tex or pdf format. |
|
|
\ No newline at end of file |
|
|
|
Here we store various files with documentation in Tex or PDF format. |
|
|
\ No newline at end of file |
