... | @@ -22,16 +22,20 @@ Actions taken within W-SLDA Toolkit to support the level 1 quality checks: |
... | @@ -22,16 +22,20 @@ Actions taken within W-SLDA Toolkit to support the level 1 quality checks: |
|
|
|
|
|
## Level 2: Internal tests
|
|
## Level 2: Internal tests
|
|
|
|
|
|
While Level 1 actions are sufficient to detect most of errors that lead to results that are incorrect at the qualitative level, they are not sufficient to assure the correctness of the code computation at the quantitative level. The next level of teestign is<br>
|
|
While Level 1 actions are sufficient to detect most of errors that lead to results that are incorrect at the qualitative level, they are not sufficient to assure the correctness of the code computation at the quantitative level. The next level of testing is<br>
|
|
_checking correctness of the computation for cases where solutions are know_.<br>
|
|
_checking correctness of the computation for cases where solutions are know_.<br>
|
|
Developers of W-SLDA Toolkit constantly seek for cases which can be used as test cases.
|
|
Developers of W-SLDA Toolkit constantly seek for cases which can be used as test cases.
|
|
|
|
|
|
Actions taken within W-SLDA Toolkit to support the level 2 quality checks:
|
|
Actions taken within W-SLDA Toolkit to support the level 2 quality checks:
|
|
* [Testsuite](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/wikis/Testsuite): an automated system of executing test cases, that check correctenss of computation at the quantitative level. The automatic tests are executed routinely after each new commit to the main engine of the code.
|
|
* [Testsuite](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/wikis/Testsuite): an automated system of executing test cases that checks correctness of computation at the quantitative level. The automatic tests are executed routinely after each new commit to the main engine of the code.
|
|
|
|
|
|
## Level 3: Open-source & Transparency
|
|
## Level 3: Open-source & Transparency
|
|
|
|
The review process by external researchers is a crucial aspect in science. It is standard practice in the case of scientific publication. In the context of scientific codes, it less popular since it requires to make your code available to other. However, here we also observe that open-source/access movement get stronger with time in computational physics. It is next level method that supports the implementation of high-quality code. It steams from Linus's law:<br>
|
|
|
|
_given enough eyeballs, all bugs are shallow_.
|
|
|
|
|
|
|
|
Actions taken within W-SLDA Toolkit to support the level 3 quality checks:
|
|
|
|
* The [W-SLDA Toolkit](https://wslda.fizyka.pw.edu.pl/) is open-source code.
|
|
|
|
* [Results reproducibility](https://gitlab.fizyka.pw.edu.pl/wtools/wslda/-/wikis/Results%20reproducibility): Together with publications, we deliver reproducibility packs. Using them independent research may inspect the computation process from beginning to the end. As example see [ arXiv:2201.07626](https://arxiv.org/abs/2201.07626).
|
|
|
|
|
|
# Links to interesting articles related to code & results quality
|
|
# Links to interesting articles related to code & results quality
|
|
* [Does your code stand up to scrutiny?](https://www.nature.com/articles/d41586-018-02741-4)
|
|
* [Does your code stand up to scrutiny?](https://www.nature.com/articles/d41586-018-02741-4)
|
... | | ... | |