|
|
|
The W-SLDA Toolkit provides various tools to support the computation and data analysis processes. There are the following types of tools:
|
|
|
|
|type | Purpose | More informations |
|
|
|
|
|-----| ------- | ------------------|
|
|
|
|
|extensions| These are small codes or scripts that support the analysis process.<br>They are located in `$WSLDA/extensions`.| For a complete list of extensions, see [here](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/extensions/README.md)|
|
|
|
|
|wdata related| These tools manage w-data sets, such as copying them to a new set, truncating datasets, merging datasets, generating subsections, etc.<br>They are located in `$WSLDA/lib/wdata/tools/`.| For a complete list of tools, see [here](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/lib/wdata/tools/README.md)|
|
|
|
|
| W-SLDA supporting | These are tools that support W-SLDA infrastructure, like estimating memory needed for computation, conversion tools from old formats to new ones (to maintain legacy), etc. <br>They are located in `$WSLDA/tools/`.| For a complete list of tools, see [here](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/tools/README.md) |
|
|
|
|
|
|
|
|
# Old version of the page (Deprecated, it will be removed in the future)
|
|
|
|
In order to create them, enter [tools](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/tree/public/tools) folder and edit (if necessary) the header of [Makefile](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/blob/public/tools/Makefile). Next execute
|
|
|
|
```bash
|
|
|
|
make
|
|
|
|
```
|
|
|
|
Executables will be written to `wslda/tools/bin` folder.
|
|
|
|
|
|
|
|
# W-DATA format related tools
|
|
|
|
|
|
|
|
## wdata-cut
|
|
|
|
*Purpose*: extracts subset from existing wdata set.
|
|
|
|
|
|
|
|
In many cases, for testing purposes, it is sufficient to have only a sample of data (for example to download it locally and test a code). You can use `wdata-cut` tool to extract a data sample. The syntax is following:
|
|
|
|
```bash
|
|
|
|
WDATA SUBSET EXTRACTOR
|
|
|
|
Usage: ./wdata-cut file.wtxt outprefix start stop
|
|
|
|
or
|
|
|
|
Usage: ./wdata-cut file.wtxt outprefix start stop stride
|
|
|
|
file.wtxt - metadata file
|
|
|
|
outprefix - for new files, metadata file will be written to outprefix.wtxt
|
|
|
|
[start,stop) - range for subtructing cycles
|
|
|
|
stride - every `stride` frame will be taken only from given range, default stride=1
|
|
|
|
```
|
|
|
|
For example to extract the first cycle only:
|
|
|
|
```bash
|
|
|
|
[wtools@dell tools]$ ./wdata-cut ../lib-wdata/test.wtxt ./sample 0 1
|
|
|
|
WDATA SUBSET EXTRACTOR
|
|
|
|
WORKING DIR: `../lib-wdata` --> `.`
|
|
|
|
SUBTRUCTION RANGE: [0,1)
|
|
|
|
READING FILE: `../lib-wdata/test.wtxt`
|
|
|
|
WRITING NEW METADAFILE: `./sample.wtxt`
|
|
|
|
DONE.
|
|
|
|
```
|
|
|
|
## wdata-sample
|
|
|
|
|
|
|
|
*Purpose*: creates new data set, where only every `stride` measurement is present.
|
|
|
|
|
|
|
|
This tool is very similar to `wdata-cut` tool with change that it strides the data set. The syntax is following:
|
|
|
|
```bash
|
|
|
|
Usage: wdata-sample file.wtxt outprefix stride
|
|
|
|
file.wtxt - metadata file
|
|
|
|
outprefix - for new files, metadata file will be written to outprefix.wtxt
|
|
|
|
stride - take only every stride measurment
|
|
|
|
```
|
|
|
|
## dpca2wdata
|
|
|
|
*Purpose*: creates wtxt metadata file for existing dpca files.
|
|
|
|
|
|
|
|
Syntax:
|
|
|
|
```bash
|
|
|
|
[wtools@dell tools]$ ./dpca2wdata
|
|
|
|
Usage: ./dpca2wdata prefix
|
|
|
|
prefix - prefix of dpca files
|
|
|
|
```
|
|
|
|
Example of usage:
|
|
|
|
```bash
|
|
|
|
[wtools@node2066 CALC-UFG]$ ls ufg1V0.6*.dpca
|
|
|
|
ufg1V0.6_current_a.dpca ufg1V0.6_current_b.dpca ufg1V0.6_delta.dpca ufg1V0.6_density_a.dpca ufg1V0.6_density_b.dpca
|
|
|
|
[wtools@node2066 CALC-UFG]$ dpca2wdata ufg1V0.6
|
|
|
|
DPCA -> WDATA CONVERTER
|
|
|
|
WORKING DIR: `.`
|
|
|
|
READING HEADER OF `ufg1V0.6_density_a.dpca`
|
|
|
|
--------------------------------
|
|
|
|
NX 768 # lattice
|
|
|
|
NY 96 # lattice
|
|
|
|
NZ 1 # lattice
|
|
|
|
DX 1 # spacing
|
|
|
|
DY 1 # spacing
|
|
|
|
DZ 1 # spacing
|
|
|
|
datadim 3 # dimension of block size: 1=NX, 2=NX*NY, 3=NX*NY*NZ
|
|
|
|
prefix ufg1V0.6 # prefix for files belonging to this data set, binary files have names prefix_variable.format
|
|
|
|
cycles 1001 # number of cycles (measurements)
|
|
|
|
t0 0 # time value for the first cycle
|
|
|
|
dt 1.3881 # time interval between cycles
|
|
|
|
|
|
|
|
# variables
|
|
|
|
# tag name type unit format
|
|
|
|
var density_a real none dpca
|
|
|
|
var density_b real none dpca
|
|
|
|
var delta complex none dpca
|
|
|
|
var current_a vector none dpca
|
|
|
|
var current_b vector none dpca
|
|
|
|
|
|
|
|
# links
|
|
|
|
# tag name link-to
|
|
|
|
|
|
|
|
# consts
|
|
|
|
# tag name value
|
|
|
|
const eF 0.72
|
|
|
|
|
|
|
|
--------------------------------
|
|
|
|
GENERATED `ufg1V0.6.wtxt`
|
|
|
|
```
|
|
|
|
|
|
|
|
## dpca2wdata-hard
|
|
|
|
*Purpose*: converts dpca file into wdata set.
|
|
|
|
```
|
|
|
|
DPCA -> WDATA HARD CONVERTER
|
|
|
|
Usage: ./dpca2wdata-hard prefix
|
|
|
|
prefix - prefix of dpca files
|
|
|
|
```
|
|
|
|
|
|
|
|
# st-wslda related tools
|
|
|
|
## wdata2checkpoint
|
|
|
|
*Purpose*: Converts W-DATA results into a checkpoint file that can be used as starting point for the self-consistent process.
|
|
|
|
```bash
|
|
|
|
Usage: ./wdata2checkpoint file.wtxt outprefix
|
|
|
|
or
|
|
|
|
Usage: ./wdata2checkpoint file.wtxt outprefix cycleid
|
|
|
|
or
|
|
|
|
Usage: ./wdata2checkpoint file.wtxt outprefix cycleid ec
|
|
|
|
or
|
|
|
|
Usage: ./wdata2checkpoint file.wtxt outprefix cycleid ec temperature
|
|
|
|
file.wtxt - metadata file
|
|
|
|
outprefix - checkpoint will be written to outprefix
|
|
|
|
cycleid - use given cycleid to create checkpoint file, default: cycleid=last cycle
|
|
|
|
ec - absolute value, default: ec=pi^2/(2*dx^2)
|
|
|
|
temperature - in eF units, default: temperature=0
|
|
|
|
``` |
|
|
\ No newline at end of file |
