Wiki source code of Technical details

Version 78.3 by lzehl on 2021/07/05 09:38
Show last authors
1 (% class="box infomessage" %)
2 (((
3 (% style="text-align: justify;" %)
4 openMINDS is designed as modular as possible, in order to facilitate extensions and maintenance of existing, as well as development and integration of new metadata models and schemas. The layout and technical requirements for this modularity are described below.
5
6 (% style="text-align: justify;" %)
7 In parallel, openMINDS tries to consider the various programming skills present in the neuroscience research community. For this reason, openMINDS established an integration pipeline which gradually increases the level of technical detail: starting from a user-friendly, lightweight schema template and ending with established, highly technical metadata schema formats (e.g., JSON-Schema).
8
9 (% style="text-align: justify;" %)
10 Please find below a documentation of the layout and requirements needed to keep the openMINDS modularity, the syntax of the openMINDS schema template, as well as the openMINDS integration pipeline.
11 )))
12
13 === The openMINDS umbrella ===
14
15 (% style="text-align: justify;" %)
16 openMINDS is the overall umbrella for a set of integrated metadata models for describing neuroscience research products in graph databases. The correct integration of these metadata models as well as the provision of a central access point is handled by an integration pipeline. All metadata models are developed on separate GitHub repositories, in order to facilitate extensions and maintenance of existing, as well as development and integration of new openMINDS metadata models and schemas. The integration pipeline ensures that the central openMINDS GitHub repository ingests all these GitHub repositories as [[git-submodules>>https://git-scm.com/docs/git-submodule||rel="noopener noreferrer" target="_blank"]], integrates the respective metadata models and builds the openMINDS GitHub pages, as well as ZIP files containing the respective openMINDS schemas in the supported formats, such as the openMINDS syntax (cf. below), JSON-Schema, or HTML. In the following we will summarize the contents and requirements for the central openMINDS GitHub repository as well as all metadata model git-submodules. The openMINDS integration pipeline will be handled in a separate chapter (cf. below).
17
18 (% style="text-align: justify;" %)
19 Let us start with the [[central openMINDS GitHub repository>>https://github.com/HumanBrainProject/openMINDS||rel=" noopener noreferrer" target="_blank"]] which has a **main branch**, a **documentation branch**, and **version branches** (naming convention: vX; e.g., v1). Official releases (naming convention: vX.Y; e.g., v1.0) are tagged and provided as release packages.
20
21 (% style="text-align: justify;" %)
22 The **main branch** hosts the general README, the LICENSE document, the CONTRIBUTING document, and the general openMINDS logo. In addition, it maintains the openMINDS vocabulary (vocab; cf. below) which provides general definitions and references for schema types and properties used across all openMINDS metadata models and their versions, as well as the bash script that builds the content of the documentation and version branches.
23
24 (% style="text-align: justify;" %)
25 The **documentation** branch hosts the HTML files that build the [[openMINDS GitHub pages>>https://humanbrainproject.github.io/openMINDS/||rel=" noopener noreferrer" target="_blank"]], as well as a ZIP file for each version branch and official release containing the respective openMINDS schemas in the currently supported formats, such as the openMINDS syntax (`.schema.tpl.json`; cf. below), JSON-Schema (`.schema.json`), or HTML (`.html`).
26
27 (% style="text-align: justify;" %)
28 Furthermore it stores the openMINDS vocabulary (**##vocab##**), providing general definitions and references for **types** and **properties** used in schemas across all openMINDS repositories (cf. below). And last but not least, it holds the schema representations for all supported metadata formats created by the openMINDS integration pipeline (cf. below).
29
30 (% style="text-align: justify;" %)
31 For this to work smoothly for the existing, but also for all new openMINDS metadata models, the corresponding openMINDS submodules (GitHub repositories) have to meet the following requirements:
32
33 (% style="text-align: justify;" %)
34 **(1)** The openMINDS metadata model has to be located on a **public GitHub repository** and published under an **MIT license**.
35
36 (% style="text-align: justify;" %)
37 **(2)** The GitHub repository should have at least one **version branch** (e.g., "v1").
38
39 (% style="text-align: justify;" %)
40 **(3)** The version branch should have the following **main directory folders**: **##schemas##** (required), **##tests##** (recommended),  **##examples##** (recommended), and **##img##** (optional).
41
42 (% style="text-align: justify;" %)
43 **(4)** The **##schemas##** folder should contain the schemas of that metadata model implemented in the **openMINDS schema template syntax** (cf. below). The directory of the schemas can be further structured or flat.
44
45 (% style="text-align: justify;" %)
46 **(5)** The **##tests##** folder should contain test-instances (JSON-LDs) for the schemas in a flat directory. The file names for these test-instances should follow the convention of
47
48 (% style="text-align: center;" %)
49 **##<<XXX>>-<<YYY>>.jsonld##**
50
51 (% style="text-align: justify;" %)
52 for files that should pass the tests, and
53
54 (% style="text-align: center;" %)
55 **##<<XXX>>-<<YYY>>-nok.jsonld##**
56
57 (% style="text-align: justify;" %)
58 for files that should fail the test. In both cases, **##<<XXX>>##** should be replaced with the label of the schema that is tested, and **##<<YYY>>##** with a user defined label for what aspect is tested (e.g., **##person-withoutCI.jsonld##**).
59
60 (% style="text-align: justify;" %)
61 **(6)** The **##examples##** folder should contain examples for valid instance collections for that metadata model. Each example should receive its own directory (folder) with a **##README.md##** describing the example, and an **##metadataCollection##** subfolder containing the openMINDS instances (JSON-LDs). This subfolder can be further structured or flat.
62
63 (% style="text-align: justify;" %)
64 **(7)** The **##img##** folder should contain image files used on that GitHub repository (e.g., the logo of the new openMINDS metadata model). The directory of the images can be further structured or flat.
65
66 === The openMINDS vocabulary ===
67
68 (% style="text-align: justify;" %)
69 Located under the folder **##vocab##** in the main openMINDS GitHub directory, the openMINDS vocabulary is semi-automatically gathered and stored in dedicated JSON files ([[**##types.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/types.json||rel="noopener noreferrer" target="_blank"]] and [[**##properties.json##**>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS/v2/vocab/properties.json||rel="noopener noreferrer" target="_blank"]]). The openMINDS integration pipeline makes sure that both files are updated with each commit to any of the GitHub repositories for the openMINDS metadata models. With that, the openMINDS vocab reflects always an up-to-date status of the general attributes of existing **schemas** and **properties** across all openMINDS metadata models, while providing the opportunity to centrally review and maintain their consistency. In addition, this design allows us to centrally define and maintain multiple references to related schemas and matching schema properties of other metadata initiatives. How this works in detail is explained in the following.
70
71 (% style="text-align: justify;" %)
72 The **##types.json##** file is an associative array listing all existing openMINDS schemas (via their type). For each openMINDS schema, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
73
74 {{code language="json"}}
75 {
76 "OPENMINDS_SCHEMA_TYPE": {
77 "description": "GENERAL_DESCRIPTION",
78 "name": "DISPLAY_LABEL",
79 "translatableTo": [
80 "REFERENCE_TO_RELATED_SCHEMA_OF_OTHER_INITIATIVE"
81 ]
82 }
83 }
84 {{/code}}
85
86 (% style="text-align: justify;" %)
87 With each new schema committed to one of the openMINDS metadata models, a new entry is appended to the **##types.json##** file, with the display label automatically derived from the respective schema type and the remaining attributes predefined with a null value. Once an entry for a schema is made in the **##types.json##** file, the values of all attributes (**##"name"##**, **##"description"##**, and **##"translatableTo"##**) can be manually edited. All manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a schema is deleted from the openMINDS metadata models, the corresponding entry in the **##types.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##types.json##** file, if the entry is manually deleted.
88
89 (% style="text-align: justify;" %)
90 Similar to the **##types.json##** file, the **##properties.json##** file is an associative array listing all properties across all existing openMINDS schemas (via the property name). For each openMINDS property, a small list of general attributes are provided in a nested associative array. Currently, the following attributes are captured:
91
92 {{code language="json"}}
93 {
94 "PROPERTY_NAME": {
95 "description": "GENERAL_DESCRIPTION",
96 "name": "DISPLAY_LABEL",
97 "nameForReverseLink": "DISPLAY_LABEL_OF_REVERSED_LINK",
98 "sameAs": [
99 "REFERENCE_TO_MATCHING_SCHEMA-PROPERTY_OF_OTHER_INITIATIVE"
100 ],
101 "schemas": [
102 "RELATIVE_PATH_TO_OPENMINDS-SCHEMA_USING_THIS_PROPERTY"
103 ]
104 }
105 }
106 {{/code}}
107
108 (% style="text-align: justify;" %)
109 With each new property committed to a schema of one of the openMINDS metadata models, a new entry is appended to the **##properties.json##** file, with the display label and list of schemas in which this property occurs automatically derived. The remaining attributes are initially provided with a null value. Once an entry for a property is made in the **##properties.json##** file, the values of all attributes (**##"name"##**, **##"description"##**, **##"nameForReversedLink"##**, and **##"sameAs"##**) can be manually edited, except for **##"schemas"##** which will be always automatically updated. All those manual editions will be preserved and not overwritten when the file is updated again with a new commit. In case a property is not used anymore in any of the schemas from the openMINDS metadata models, the corresponding entry in the **##properties.json##** file is marked as being deprecated (additional attribute-value pair; **##"deprecated": true##**). It only can be permanently removed from the **##properties.json##** file, if the entry is manually deleted.
110
111 === The openMINDS syntax ===
112
113 (% style="text-align: justify;" %)
114 All openMINDS metadata models are defined using a light-weighted schema syntax. Although this schema syntax is inspired by JSON-Schema, it outsources most schema technicalities to be handled by the openMINDS integration pipeline, making the openMINDS schemas more human-readable, especially for untrained eyes.
115
116 (% style="text-align: justify;" %)
117 The few remaining customized technical properties which need additional interpretation or translation to a formal schema languages (e.g. JSON-Schema) have an underscore as prefix (e.g., **##"_type"##**). Within the openMINDS integration pipeline (cf. below), the schema template syntax is interpreted, extended and flexibly translated to various formal schema languages. All further specifications of the openMINDS schema template syntax are described below.
118
119 (% style="text-align: justify;" %)
120 ==== Basic openMINDS schema structure ====
121
122 (% style="text-align: justify;" %)
123 All openMINDS schemas need to have the extension **##.schema.tpl.json##** and each schema is defined as a nested associative array (dictionary) with the following conceptual structure:
124
125 {{code language="json"}}
126 {
127 "_type": "https://openminds.ebrains.eu/LABEL_OF_METADATA_MODEL/SCHEMA_NAME",
128 "properties": {
129 "PROPERTY_NAME": {
130 "type": "DATA_TYPE",
131 "_instruction": "METADATA_ENTRY_INSTRUCTION"
132 },
133 "required": [
134 "PROPERTY_NAME"
135 ]
136 }
137 {{/code}}
138
139 (% style="text-align: justify;" %)
140 **##"_type"##** defines the schema type (or namespace) with the depicted naming convention, where the label of the respective openMINDS metadata model (e.g., **##"core"##**) and the schema name (format: UpperCamelCase; e.g. **##"ContactInformation"##**) have to be specified. Obviously, the schema name should be meaningful and provide some insides into what metadata content the schema covers.
141
142 (% style="text-align: justify;" %)
143 Under **##"properties"##** a nested associative array is defined, where each key defines the property name (format: lowerCamelCase; e.g. **##"givenName"##**). The corresponding value is again a nested associative array defining the expected data **##"type"##** (cf. below) and the **##"_instructions"##** for entering the correct metadata for the respective property.
144
145 (% style="text-align: justify;" %)
146 Under **##"required"##** a list of property names can be provided that are obligatory to be present in a correctly instantiated metadata instance of the respective schema. If none of the properties are required, this key-value pair does not have to be specified.
147
148 (% style="text-align: justify;" %)
149 ==== Schemas extending a context-schema ====
150
151 (% style="text-align: justify;" %)
152 In the case that several schemas are highly related and contain a common set of properties, it is possible to define a non-type context-schema with these common properties that can be extended and modified by the group of related schemas.
153
154 (% style="text-align: justify;" %)
155 All properties and constraints (e.g. required properties, expected data types) defined in the context-schema are passed on to the schemas extending this context-schema. Each of these schemas can define additional properties, or (if necessary) can overwrite the constraints of the context-schema (incl. **##"_instructions"##**). In order to state that a schema is extending a context-schema, the following additional key-value pair has to be added to the schema template above:
156
157 (% style="text-align: center;" %)
158 **##"_extends": "RELATIVE_PATH_TO_OPENMINDS-CONTEXT-SCHEMA"##**
159
160 (% style="text-align: justify;" %)
161 This design not only makes it easier to identify highly related schemas, but also facilitates the maintenance of the commonly used properties. A good hands-on example, is the context-schema [[ResearchProduct>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS_core/v3/schemas/products/researchProduct.schema.tpl.json||rel="noopener noreferrer" target="_blank"]] which is extended by the following schema set: [[Dataset>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS_core/v3/schemas/products/dataset.schema.tpl.json||rel="noopener noreferrer" target="_blank"]], [[MetaDataModel>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS_core/v3/schemas/products/metaDataModel.schema.tpl.json]], [[Model>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS_core/v3/schemas/products/model.schema.tpl.json||rel="noopener noreferrer" target="_blank"]], and [[Software>>https://raw.githubusercontent.com/HumanBrainProject/openMINDS_core/v3/schemas/products/software.schema.tpl.json||rel="noopener noreferrer" target="_blank"]].
162
163 (% style="text-align: justify;" %)
164 ==== Data type depending constraints ====
165
166 (% style="text-align: justify;" %)
167 Depending on the expected data **##"type"##** additional constraints can be made for the metadata entry of a respective property. Currently, the openMINDS schema template syntax supports the following data types: **##"string"##**, ##**"integer"**##, **##"float"##**, **##"boolean"##**, **##"array"##** and **##"object"##**.
168
169 (% style="text-align: justify;" %)
170 If the expected data **##"type"##** is a **##"string"##** the expected number of characters, the format or a regular expression pattern of the string can be further defined.
171
172 === The openMINDS integration pipeline ===
173
174 (//**coming soon**//) If you'd like to learn more about the openMINDS integration pipeline, especially if you'd like to contribute to it, please get in touch with us (the openMINDS development team) via the issues on the openMINDS or openMINDS_generator GitHub or the support email: openminds@ebrains.eu
175
176 {{putFootnotes/}}
Public

openMINDS