Commit 3bac5129 authored by Mohamed, Fawzi Roberto (fawzi)'s avatar Mohamed, Fawzi Roberto (fawzi)
Browse files

exploded version of meta metainfo

parent 4dc234b5
{
"metadict_name":"meta",
"metadict_description":"dictionary describing the meta info itself",
"metadict_version":"2.0.0",
"metadict_require":[]
}
{
"meta_name":"meta_abstract_types",
"meta_type":"type-value",
"meta_description":[
"A list of all Meta Info of type *type-abstract* of this ",
"value"],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string",
"meta_repeats":true
}
{
"meta_name":"meta_chosen_key",
"meta_type":"type-value",
"meta_description":[
"The meta_name of a *type-value* (that should be with meta_data_type = *string*) ",
"that can be used as main unique key for the sections contained in a ",
"meta_parent_section."],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string"
}
{
"meta_name":"meta_constraint",
"meta_type":"type-section",
"meta_description":[
"A constraint on the values corresponding to the section that defines ",
"it."],
"meta_parent_section":"meta_info_entry",
"meta_repeats":true,
"meta_context_identifier":[]
}
{
"meta_name":"meta_constraint_description",
"meta_type":"type-value",
"meta_description":"Description of the constraint.",
"meta_parent_section":"meta_constraint",
"meta_data_type":"string"
}
{
"meta_name":"meta_constraint_expected_meta_info",
"meta_type":"type-value",
"meta_description":[
"Either a meta_name or a '!' and a meta_name.If the meta_info_entry ",
"corresponding to it has meta_type type-value or type-section then the ",
"corrsponding value must be either present or absent. type-abstract are ",
"evaluated all together at the end. The type-value and type-section ",
"meta_info_entry that are not already given explicitly in other ",
"meta_constraint_expected_meta_info that have all the type-abstract in ",
"meta_abstract_types or in their parents (through meta_abstract_types) must be ",
"present, whereas those that have all the '!' type-abstract must be ",
"absent."],
"meta_parent_section":"meta_constraint",
"meta_data_type":"string",
"meta_repeats":true
}
{
"meta_name":"meta_constraint_name",
"meta_type":"type-value",
"meta_description":[
"A name for the constraint (should be unique within ",
"meta_parent_section)."],
"meta_parent_section":"meta_constraint",
"meta_data_type":"string"
}
{
"meta_name":"meta_constraint_required_query",
"meta_type":"type-value",
"meta_description":[
"This query if given must be true for all selected ",
"values"],
"meta_parent_section":"meta_constraint",
"meta_data_type":"string"
}
{
"meta_name":"meta_constraint_select_query",
"meta_type":"type-value",
"meta_description":[
"Query that must be true for the values that have to satisfy this constraint. ",
"Typically this is for example a field having a given ",
"value."],
"meta_parent_section":"meta_constraint",
"meta_data_type":"string"
}
{
"meta_name":"meta_context_identifier",
"meta_type":"type-value",
"meta_description":[
"The value should be the meta_name of a value (meta_info_entry with meta_type = ",
"*type-value*) contained in this meta_info_entry. I.e. its meta_parent_section ",
"should be equal to the meta_name of the current meta_info_entry (which should ",
"be of *type-section*).That value should uniquely and globally identifies every ",
"section value, even if one does not know the type of the current section. In ",
"NOMAD we always used the a gid for this purpose."],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string",
"meta_repeats":true
}
{
"meta_name":"meta_data_type",
"meta_type":"type-value",
"meta_description":[
"The basic type of the data corresponding to this meta_info_entry.\n",
"Formally also *binary* and *json* could be used, but they were avoided until ",
"now because opaque, and more difficult to ",
"document."],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string",
"meta_enum":[{
"meta_enum_value":"int",
"meta_enum_description":"A 32 bit signed integer (equivalent to int32)"
},{
"meta_enum_value":"int32",
"meta_enum_description":"A 32 bit signed integer"
},{
"meta_enum_value":"int64",
"meta_enum_description":"A 64 bit signed integer"
},{
"meta_enum_value":"reference",
"meta_enum_description":[
"An internal reference. This contains the index of the referenced ",
"meta_referenced_sections. For references to other documents a string with a ",
"nomad uri should be used."]
},{
"meta_enum_value":"float32",
"meta_enum_description":[
"A single precision (32 bit) floating point ",
"value"]
},{
"meta_enum_value":"float",
"meta_enum_description":[
"A double precision (64 bit) floating point value (equivalent to ",
"float64)"]
},{
"meta_enum_value":"float64",
"meta_enum_description":[
"A double precision (64 bit) floating point ",
"value"]
},{
"meta_enum_value":"boolean",
"meta_enum_description":"A boolean value (true or false)"
},{
"meta_enum_value":"json",
"meta_enum_description":[
"A json value. Its use is discouraged, as it does lead to inferior documentation ",
"compared to using the meta info directly."]
},{
"meta_enum_value":"string",
"meta_enum_description":"A string of unicode characters"
}]
}
{
"meta_name":"meta_description",
"meta_type":"type-value",
"meta_description":[
"Contains a text meant for the users of the meta info, using [mark down ",
"format](https://daringfireball.net/markdown) with the following extensions:\n",
" * \\$ is used to introduce mathematical notation using the latex format,\n",
" * names containing an ``\\_'' are assumed to refer to other meta ",
"info."],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string"
}
{
"meta_name":"meta_dictionary",
"meta_type":"type-section",
"meta_description":[
"A dictionary collection some meta_info_entry entries, their dependencies.\n",
"The dictionary is versioned using semantic ",
"versioning."],
"meta_repeats":true,
"meta_context_identifier":[]
}
{
"meta_name":"meta_dimension",
"meta_type":"type-section",
"meta_description":[
"The shape of the multidimensional array used to store the data corrsponding to ",
"this meta info, either meta_dimension_fixed or meta_dimension_symbolic.\n",
"Example: [{ ``meta_dimension_symbolic'': ``number_of_atoms''}, ",
"{``meta_dimension_fixed'': 3 }].\n",
"If no meta_dimension are given the data is a ",
"scalar."],
"meta_parent_section":"meta_info_entry",
"meta_repeats":true,
"meta_context_identifier":[]
}
{
"meta_name":"meta_dimension_fixed",
"meta_type":"type-value",
"meta_description":"A fixed dimension of exactly the given size.",
"meta_parent_section":"meta_dimension",
"meta_data_type":"int64"
}
{
"meta_name":"meta_dimension_symbolic",
"meta_type":"type-value",
"meta_description":[
"A symbolic (variable) dimension, contains the name of a meta_info_entry with ",
"meta_type *type-dimension* that represents this ",
"dimension."],
"meta_parent_section":"meta_dimension",
"meta_data_type":"string"
}
{
"meta_name":"meta_enum",
"meta_type":"type-section",
"meta_description":[
"Describes each of the possible values of an enumeration ",
"meta_info_entry"],
"meta_parent_section":"meta_info_entry",
"meta_repeats":true,
"meta_context_identifier":[]
}
{
"meta_name":"meta_enum_description",
"meta_type":"type-value",
"meta_description":"The description of the meaning of the meta_enum_value.",
"meta_parent_section":"meta_enum",
"meta_data_type":"string"
}
{
"meta_name":"meta_enum_from",
"meta_type":"type-value",
"meta_description":[
"The meta_name of a meta_info_entry from which to take the meta_enum to easily ",
"share enumeration values across several meta_info_entry"],
"meta_parent_section":"meta_info_entry",
"meta_data_type":"string"
}
{
"meta_name":"meta_enum_value",
"meta_type":"type-value",
"meta_description":"One of the possible values of an enumeration.",
"meta_parent_section":"meta_enum",
"meta_data_type":"string"
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment