| Property Definition (short name)
A common way to refer to the Property Definition. Note there may be multiple Property Definitions with the same short name, to fully distinguish between Property Definitions the full Tag URI must be used (the Property Definition ID).
| verification-check |
|---|---|
| Property Definition ID
The full Property Definition identifier using the Tag URI scheme.
| tag:tadmor@noreply.openkim.org,2017-02-01:property/verification-check |
| Title
A brief one-sentence description of this Property Definition.
| Universal verification check property |
| Description
A description about this Property Definition.
| Verification checks are designed to explore basic model characteristics and conformance to the KIM API standard. Results from verification checks are reported in the standardized form defined in this property definition. |
| Contributor
The user or organization who initially contributed this Property Definition.
| tadmor |
| Maintainer
The user or organization who currently maintains this Property Definition.
| tadmor |
| Creation date
The date the Property Definition was "minted", based on its Tag URI.
| 2017-02-01 |
| Content on GitHub
The following content may be available on GitHub: Property Definition (an EDN file containing the Property Definition Keys listed below); Physics Validator (a script provided by the user for validating that an instance of the Property is physically valid); Property Documentation Wiki (the contents of the Wiki displayed at the bottom of this page).
|
Property Definition Physics Validator Property Documentation Wiki |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | true |
| description | The verification check category. There are three possibilities: `informational', `consistency', and `mandatory'. Informational verification checks provide useful information about the model that have no implications regarding its internal consistency. Consistency verification checks test for violations of internal consistency (e.g. the forces are not the negative gradient of the energy). Mandatory verification checks test for failures of a model to satisfy critical KIM API requirements or declared capabilities (such as supporting a specified species). |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | true |
| description | A short explanation of the intent of the verification check and what it does. |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | true |
| description | The verification check grade as defined by vc-grade-basis. |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | true |
| description | Each verification check returns a grade indicating how well the test was passed. The type of grade returned is defined by the vc-grade-basis. There are two options: `graded' and `passfail'. A `graded' verification check returns a letter grade `A', `B', `C', `D' or `F' (where `A' is best, and `F' indicated failure). A `passfail' verification check returns `P' for pass, or `F' for fail. In situations where the verification check could not be performed, a value of `N/A' (for not available) must be returned. |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | true |
| description | A short name describing the verification check. |
| type | string |
|---|---|
| has-unit | false |
| extent | [] |
| required | false |
| description | Text generated by the verification check to accompany the grade and explain its meaning. Additional information to explain or qualify the result can be included. |
| type | file |
|---|---|
| has-unit | false |
| extent | [":"] |
| required | false |
| description | A list of one or more files generated by the VC. For example, these can be data files of results or graphic figures. |