@@ -77,22 +77,6 @@ Each file's *root* group (path `/`) must at least contain the attributes:
7777 minor and revision must not be neglected
7878 - example: ` 1.1.0 `
7979
80- - ` openPMDextension `
81- - type: * (uint32)*
82- - description: the bit-mask of unique IDs of applied extensions of the
83- openPMD standard
84- (see: * Domain-Specific Extensions* );
85- to test for a specific extension ` ID ` perform a bit-wise
86- ` AND ` operation on ` openPMDextension ` :
87- ` extension_1_used = (( openPMDextension AND ID ) == ID) `
88- - note: if only one extension is used at a time, the value for
89- ` openPMDextension ` is simply the ` ID ` of the extension
90- - examples:
91- - ` 0 ` : only the base standard is used
92- - ` 1 ` : the base standard and the extension with ID ` 1 ` apply for the file
93- - general case (discouraged in this version of the standard):
94- ` openPMDextension=0 OR <ID1> OR <ID2> OR <...> ` (bit-wise ` OR ` )
95-
9680 - ` basePath `
9781 - type: * (string)*
9882 - description: a common prefix for all data sets and sub-groups of a
@@ -113,6 +97,27 @@ Each file's *root* group (path `/`) must at least contain the attributes:
11397 of the form given by ` basePath ` (e.g. ` /extra_data ` ). In this
11498 way, the openPMD parsing tools will not parse this additional data.
11599
100+ The following attribute is * optional* in each each file's * root* group
101+ (path ` / ` ) and indicates if a file also follows an openPMD extension
102+ (see: * Domain-Specific Extensions* ) on top of the base standard. It is
103+ * required* to set them if one wants to declare an openPMD extension.
104+
105+ - ` openPMDextension `
106+ - type: * (string)*
107+ - description: the unique openPMD extension name of applied extensions on
108+ top of the openPMD base standard
109+ (see: * Domain-Specific Extensions* );
110+ multiple extensions can be activated at the same time and
111+ must appear as semicolon-separated list
112+ - note: do not create this attribute if no extension is used
113+ - note: if only one extension is used at a time, the value for
114+ ` openPMDextension ` is simply the name of the extension
115+ - examples:
116+ - ` ED-PIC ` : the base standard and the extension with name ` ED-PIC ` apply
117+ for the file
118+ - ` ED-PIC;SpeciesType ` : the base standard and the extensions ` ED-PIC ` and
119+ ` SpeciesType ` are used
120+
116121The following attributes are * optional* in each each file's * root* group
117122(path ` / ` ) and indicate if a file contains mesh and/or particle records. It is
118123* required* to set them if one wants to store mesh and/or particle records.
0 commit comments