|
|
# Glossary of the metadata properties #
|
|
|
|
|
|
* Type can have one of the following values:
|
|
|
* *Section*. This metadata describes a section that groups related quantities. The most important sections are:
|
|
|
* *section\_run*: represents a single "run" of the program,
|
|
|
* *section\_method*: contains the information defining the theory level, and convergence parameters,
|
|
|
* *section\_system\_description*: the content of each of this section corresponds to a different and specific system configuration,
|
|
|
* *section\_single\_configuration\_calculation*: contains the results for a system as defined in a single *section\_method* and a single *section\_system\_description*.
|
|
|
* *section\_scf\_iteration*: each entry is a single self-consistency iteration.
|
|
|
The descendants of these 5 sections can be filtered with the "Select Parent Section" combo box.
|
|
|
* *Concrete Value*. This metadata has a value (a mathematical object like a number or an array, or a string) associated. It cannot be further inherited.
|
|
|
* *Abstract Type*. This metadata is of a type that is used only to classify other types. These metadata are useful for queries and indeed they can be filtered by using the "Select Abstract Type" combo box.
|
|
|
* *Dimension*. represents a dimension of an array. it is effectively like an integer variable containing the dimension. Its use makes the connection between arrays explicit (for example atom\_label and atom\_position).
|
|
|
These types can be filtered by using the combo box Select type.
|
|
|
* Description. A short text in natural language that summarizes the expected content of the metadata
|
|
|
* Data Type can have one of the following values:
|
|
|
- *f*: a floating point number,
|
|
|
- *i*: an integer number,
|
|
|
- *C*: a Unicode string,
|
|
|
- *b*: boolean value,
|
|
|
- *D*: a JSON object, (i.e. a dictionary containing string, numbers, lists, and other dictionaries)
|
|
|
- *r*: reference to the section named in referencedSection. The value is the integer index of the referenced section
|
|
|
* Shape. This property defines the dimension and size of the metadata. It can be:
|
|
|
- *\[\]* for a scalar (or a string for Data Type 'C'),
|
|
|
- *\[ x \]* for an array,
|
|
|
- *\[ x, y \]* for a matrix,
|
|
|
- *\[ x, y, z \]* for a order-3 tensor, and so on.
|
|
|
x, y, z can be numbers or names of metadata of Type 'Dimension'
|
|
|
* Units. Units used for expressing the value of the metadata, if it is of type *Concrete Value*. We used the International System of Units (SI), i.e., the unit for lengths is meter, for energies joule, for pressures pascal, for forces newton, and so on. |