Skip to content

Commit

Permalink
tests: Add and touch up READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
shoshijak authored and oschuett committed Oct 30, 2019
1 parent 9f0cb0d commit 590ef8e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 8 deletions.
4 changes: 0 additions & 4 deletions tests/Fist/EAM_LIB/README

This file was deleted.

5 changes: 5 additions & 0 deletions tests/Fist/EAM_LIB/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Fist EAM Regression Tests

The potentials for Ag, Pt and Au listed here are converted from the [LAMMPS distribution](http://lammps.sandia.gov).
The mixed file is generated by multiplication of Za(R)*Zb(R)/R as prescribed in Foiles et al., PRB 33 (1986) 7983.
Note that the grid is quite loose, so `EMAX_SPLINE` is set to a high value (D. Passerone).
36 changes: 32 additions & 4 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,35 @@
# CP2K tests
# CP2K Tests

## Regular tests
This directory contains input files for CP2K's tests and regression tests.

## Regression tests
For documentation on CP2K's input files, please refer to the [Input Reference Manual](https://manual.cp2k.org/).

How to run ...
**Note:** the test names make common use of acronyms. For explanations, please refer to the [Glossary of Acronyms and Abbreviations](https://www.cp2k.org/acronyms).

## Regression Tests

There is a very large number of regtests. For this reason, each individual regtest should be fast (e.g. shorter than a minute on a regular laptop with an sdbg version of the code). Since these tests do not need to return meaningful results (just consistent results), one can use e.g. small basis sets, low cutoffs, small EPS_DEFAULT, ...

### Test Directories Structure

The test-suite is fully controlled by the following files:

- [`TEST_DIRS`](TEST_DIRS) is a list of directories that contain tests.
- [`TEST_TYPES`](TEST_TYPES) defines test types. I.e. specifies which words should be grepped and what field should be used in the numerical comparison.

Additionally, each test-subdirectory contains:

- `TEST_FILES`: the list of input files that need to be executed for the regression test. These files will be run in order.
- `TEST_FILES_RESET`: the list of files for which the reference output became invalid (e.g bug fix).

Some regression testing directories contain:

- `untested_inputs`: list of input files, which have a more meaningfull setup compared to the regtests, but that are not checked at every single commit.

### How to Run Regression Tests

For information on how to run regression testing, please refer to the [regression testing documentation](https://www.cp2k.org/dev:regtesting).

### How to Add a Regression Test

To add a regression test, commit the `.inp` file and add a corresponding entry to [`TEST_DIRS`](TEST_DIRS) and `TEST_FILES`.

0 comments on commit 590ef8e

Please sign in to comment.