Commit 107e20f9 authored by Mohamed, Fawzi Roberto (fawzi)'s avatar Mohamed, Fawzi Roberto (fawzi)
Browse files

first version (very preliminary) of the metadata

parents
This diff is collapsed.
{
"type": "nomad_meta_info_1_0",
"description": "meta info used by the fhi parser",
"dependencies": [
{
"relativePath": "common.nomadmetainfo.json"
}
],
"metaInfos": []
}
{
"type": "nomad_meta_info_1_0",
"description": "common entry point loading all meta infos",
"dependencies": [
{
"relativePath": "meta_types.nomadmetainfo.json"
}, {
"relativePath": "common.nomadmetainfo.json"
}, {
"relativePath": "fhi_calculation.nomadmetainfo.json"
}
]
}
{
"type": "nomad_meta_info_1_0",
"description": "common entry point loading all meta infos",
"dependencies": [],
"metaInfos": [ {
"description": "kind of InfoKinds describing a type of information that has not been defined, and is unknown",
"kindStr": "MetaType",
"name": "UnknownType",
"superNames": []
}, {
"description": "kind of InfoKinds describing a meta type that has not been defined, and is unknown",
"kindStr": "MetaType",
"name": "UnknownMetaType",
"superNames": []
}, {
"description": "kind of InfoKinds describing the type of documents (Infos)",
"kindStr": "MetaType",
"name": "DocumentType",
"superNames": []
}, {
"description": "Kind of something contained in a document",
"kindStr": "MetaType",
"name": "DocumentContentType",
"superNames": []
}, {
"description": "kind of InfoKinds describing the type of information contained in documents (Infos)",
"kindStr": "MetaType",
"name": "ConnectionType",
"superNames": []
}, {
"description": "A property used only to classify other concrete properties, and thus without an associated value",
"kindStr": "MetaType",
"name": "AbstractDocumentContentType",
"superNames": []
}, {
"description": "A property used to group other properties. A meta info X of kind SectionType implicitly defines a meta info X_identifier of type string and a meta info X_index of type integer inheriting from it.",
"kindStr": "MetaType",
"name": "SectionType",
"superNames": []
}]
}
{
"type": "nomad_meta_info_1_0",
"description": "meta info used internally by the nomad base infrastructure",
"metaInfos": [ {
"description": "A document containing files and directories",
"kindStr": "DocumentType",
"name": "Archive",
"superNames": []
}, {
"description": "A document containing files and directories stored in the zip format",
"kindStr": "DocumentType",
"name": "ZipArchive",
"superNames": [
"Archive"
]
}, {
"description": "A compressed document",
"kindStr": "DocumentType",
"name": "Compressed",
"superNames": []
}, {
"description": "A compressed document using the xz format",
"kindStr": "DocumentType",
"name": "XzCompressed",
"superNames": [
"Compressed"
]
}, {
"description": "A text document",
"kindStr": "DocumentType",
"name": "TextDocument",
"superNames": []
}, {
"description": "An xml document",
"kindStr": "DocumentType",
"name": "XmlDocument",
"superNames": [
"TextDocument"
]
}, {
"description": "A document containing a video",
"kindStr": "DocumentType",
"name": "Video",
"superNames": []
}, {
"description": "A selection of documents or pieces of documents",
"kindStr": "DocumentType",
"name": "Selection",
"superNames": []
}, {
"description": "A list pieces of documents stored as nomad uris",
"kindStr": "DocumentType",
"name": "UriSelection",
"superNames": [
"Selection"
]
}, {
"description": "An unknown document type",
"kindStr": "DocumentType",
"name": "UnknownDocumentType",
"superNames": []
}, {
"description": "An output of a calculation (often partial)",
"kindStr": "DocumentType",
"name": "CalculationOutput",
"superNames": []
}, {
"description": "An information document with properties, data and connections",
"kindStr": "DocumentType",
"name": "InfoType",
"superNames": []
}, {
"description": "A trajectory, result of a simulation, can have a single or multiple configurations",
"kindStr": "DocumentType",
"name": "Trajectory",
"superNames": [
"InfoType",
"CalculationOutput"
]
}, {
"description": "A document containing block of timestamps",
"kindStr": "DocumentType",
"name": "TimestampBlock",
"superNames": []
}, {
"description": "A document containing files and directories stored in the tar format",
"kindStr": "DocumentType",
"name": "TarArchive",
"superNames": [
"Archive"
]
}, {
"description": "Connections used by the storage system",
"kindStr": "ConnectionType",
"name": "SystemConnections",
"superNames": []
}, {
"description": "Connection from a document to its replacement",
"kindStr": "ConnectionType",
"name": "Replaces",
"superNames": [
"SystemConnections"
]
}, {
"description": "An output of a calculation as written by the calculation program (often partial)",
"kindStr": "DocumentType",
"name": "RawCalculationOutput",
"superNames": [
"CalculationOutput"
]
}, {
"description": "A document in hdf5 format",
"kindStr": "DocumentType",
"name": "Hdf5Document",
"superNames": []
}, {
"description": "An information document in hdf5 format, with properties, data and connections",
"kindStr": "DocumentType",
"name": "Hdf5NomadInfo",
"superNames": [
"InfoType",
"Hdf5Document"
]
}, {
"description": "An information document in hdf5 format, with properties, data and connections using the version 1.0 format",
"kindStr": "DocumentType",
"name": "Hdf5NomadInfoV1_0",
"superNames": [
"Hdf5NomadInfo"
]
}, {
"description": "A trajectory in hdf5 format",
"kindStr": "DocumentType",
"name": "Hdf5Trajectory",
"superNames": [
"Hdf5NomadInfo",
"Trajectory"
]
}, {
"description": "A trajectory in hdf5 format",
"kindStr": "DocumentType",
"name": "Hdf5TrajectoryV1_0",
"superNames": [
"Hdf5Trajectory",
"Hdf5NomadInfoV1_0"
]
}, {
"description": "A normalized information about a simulation run using the version 1.0 format",
"kindStr": "DocumentType",
"name": "NormalizedRunInfoV1_0",
"superNames": [
"Hdf5TrajectoryV1_0"
]
}, {
"description": "A document in json format",
"kindStr": "DocumentType",
"name": "JsonDocument",
"superNames": [
"TextDocument"
]
}, {
"description": "An information document in json format, with properties, data and connections",
"kindStr": "DocumentType",
"name": "JsonInfo",
"superNames": [
"JsonDocument",
"InfoType"
]
}, {
"description": "A trajectory in hdf5 format",
"kindStr": "DocumentType",
"name": "JsonTrajectory",
"superNames": [
"JsonInfo",
"Trajectory"
]
}, {
"description": "A document containing InfoKinds in json format",
"kindStr": "DocumentType",
"name": "JsonInfoKinds",
"superNames": [
"JsonDocument"
]
}, {
"description": "The data part of an information document in json format.\n Together with an optional used_keys.json or all_keys.json that contains\n all possible keys, and a meta_keys.json (also optional) a self contained\n info can be built.",
"kindStr": "DocumentType",
"name": "JsonInfoData",
"superNames": [
"JsonDocument"
]
}, {
"description": "A document containing an image",
"kindStr": "DocumentType",
"name": "Image",
"superNames": []
}, {
"description": "An html document",
"kindStr": "DocumentType",
"name": "HtmlDocument",
"superNames": [
"TextDocument"
]
}, {
"description": "A compressed document using the gnu zip (gzip) format",
"kindStr": "DocumentType",
"name": "GzipCompressed",
"superNames": [
"Compressed"
]
}, {
"description": "A normalized information about an Fhi Aims simulation.",
"kindStr": "DocumentType",
"name": "FhiAimsNormalizedRunInfoV1_0",
"superNames": [
"NormalizedRunInfoV1_0"
]
}, {
"description": "A selection of documents",
"kindStr": "DocumentType",
"name": "DocumentSelection",
"superNames": [
"Selection"
]
}, {
"description": "A selection of documents that is explicitly stored in the db as Containing connetions",
"kindStr": "DocumentType",
"name": "ExplicitDocumentSelection",
"superNames": [
"DocumentSelection"
]
}, {
"description": "A document containing directory meta info in json format",
"kindStr": "DocumentType",
"name": "DirectoryMetaInfo",
"superNames": [
"JsonDocument"
]
}, {
"description": "Connection from a document to a document partially derived from it",
"kindStr": "ConnectionType",
"name": "Derived",
"superNames": [
"SystemConnections"
]
}, {
"description": "Connection from a document to its contents",
"kindStr": "ConnectionType",
"name": "Containing",
"superNames": [
"SystemConnections"
]
}, {
"description": "A selection of documents that is stored as list of egids",
"kindStr": "DocumentType",
"name": "CompactDocumentSelection",
"superNames": [
"DocumentSelection"
]
}, {
"description": "A compressed document using the bzip2 format",
"kindStr": "DocumentType",
"name": "Bzip2Compressed",
"superNames": [
"Compressed"
]
}]
}
# Overrides #
This directory contains a collection of override files.
These files describe the new version of a NomadMetaInfo, by listing old gid and new gid, and can thus introduce versioning for NomadMetaInfo.
The name or other keys can be given, but are only informative and can be omitted.
## File Naming convention ##
Normally overrides are given between two tagged versions or between the last checked in version,
and the current state. so override files are by default given as
<oldVersion>_<newVersion>_YYYY-MM-DD.nomadmetainfo_overrides.json
where *oldVersion* can be the first 10 characters of the git sha, a tag name, or even empty;
just like *newVersion*. *YYYY-MM-DD* is the current date, and if required an "\_n" with a suitable
number *n* that does not clash with existing files can be used.
The extension .nomadmetainfo_overrides.json is mandatory.
## Automatic Generation ##
Normally you can generate these files automatically with scripts/nomadscripts/calculate_meta_info_overrides.py
The script works if the name of the NomadMetaInfo is the same but have differen gid.
## Complex Cases ##
In cases in which you have renamed a NomadMetaInfo or there is a NomadMetaInfo outside the
standard that you want to replace with the standard one you have to create (or complete)
the override file by hand.
In these cases the output with --verbose can be useful.
It is also possible to use scripts/nomadscripts/normalize_local_kinds.py --add-gid to update
each NomadMetaInfo with its gid, which then you can use to create manual override files.
Please do not check in the repository the generated .nomadmetainfo.json files with gid.
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