Skip to content

GitLab

Code & Results quality · Changes

Page history
Update Code & Results quality authored by Gabriel Wlazłowski's avatar Gabriel Wlazłowski
Show whitespace changes
Inline Side-by-side
Code-&-Results-quality.md
View page @ 8e766505
...@@ -8,13 +8,22 @@ The highest priority is computation correctness, which is the fundamental issue ...@@ -8,13 +8,22 @@ The highest priority is computation correctness, which is the fundamental issue
# W-SLDA Toolkit quality # W-SLDA Toolkit quality
Within W-SLDA Toolkit we apply the following strategies to ensure high level of confidence of the computation correctness: Within W-SLDA Toolkit we apply the following strategies to ensure a high level of confidence of the computation correctness:
## Level 1: Inspection of the results
It is the most standard method (and in many groups the only one). Namely,<br>
&nbsp;&nbsp;&nbsp;_results are correct if they look to be correct_.<br>
While it may look to be rather a weak method of testing of computation correctness, in practice, it works very well. Typically, we know what to expect as the results (more or less), at least at the level of qualitative behavior. Physics is equipped with various methods, experiments, etc, and making extensive comparisons with them automatically leads to the inspection of sources of discrepancies (if present). From point of view of the implementation, the W-SLDA Toolkit delivers extensive support for results analysis.
Actions taken within W-SLDA Toolkit to support the level 1 quality checks:
* [W-data format](https://gitlab.fizyka.pw.edu.pl/wtools/wdata): conceptually easy data format that allows a variety of tools/languages to be used for data analysis.
* [Integration with VisIt](https://gitlab.fizyka.pw.edu.pl/wtools/wdata/-/wikis/Visit-integration): advanced platform for data visualisation & analysis.
* [Auxiliary tools & Extensions](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/wikis/home#extensions): we provide various examples of tested codes for data analysis.
## Level 2: Internal tests
## Level 3: Open-source & Transparency
| Level | Description | Actions within W-SLDA |
| --- | --- | --- |
| 1: Inspection of the results | TODO | TODO |
| 2: Internal tests | TODO | TODO |
| 3: Open-source & Transparency | TODO | TODO |
# Links to interesting articles related to code & results quality # Links to interesting articles related to code & results quality
......