You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/parsers/h5md/h5md_expl.md
+8-30Lines changed: 8 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -122,17 +122,17 @@ depending on the dataset layout of `step`.
122
122
123
123
<element>
124
124
\-- step: Integer[]
125
-
+-- (offset: type[])
125
+
+-- (offset: type[])
126
126
\-- (time: type[])
127
-
+-- (offset: type[])
127
+
+-- (offset: type[])
128
128
\-- value: <type>[variable][...]
129
129
130
130
`step`
131
131
: A scalar dataset of `Integer` type that contains the increment of the
132
132
time step between two successive rows of data in `value`.
133
133
134
134
`offset`
135
-
: A scalar attribute of type `Integer` corresponding to the first sampled
135
+
: A scalar attribute of type `Integer` corresponding to the first sampled
136
136
value of `step`.
137
137
138
138
`time`
@@ -141,7 +141,7 @@ depending on the dataset layout of `step`.
141
141
time, in physical units.
142
142
143
143
`offset`
144
-
: A scalar attribute of the same type as `time` corresponding to the first
144
+
: A scalar attribute of the same type as `time` corresponding to the first
145
145
sampled value of `time`.
146
146
147
147
For this storage mode, the explicit value $s(i)$ of the step corresponding to
@@ -219,8 +219,6 @@ As an example, a time-dependent list of pairs is stored as:
219
219
220
220
The dimension denoted by `N` may be variable.
221
221
222
-
223
-
224
222
## The root level
225
223
226
224
The root level of H5MD-NOMAD structure is organized as follows (identical to the original H5MD specification):
@@ -252,8 +250,6 @@ The root level of H5MD-NOMAD structure is organized as follows (identical to the
252
250
: An optional group that contains application-specific (meta)data such as
253
251
control parameters or simulation scripts.
254
252
255
-
256
-
257
253
## The H5MD Group
258
254
259
255
A set of global metadata describing the H5MD structure is stored in the `h5md`
@@ -324,7 +320,6 @@ As the *z* component has no impact on the content of an H5MD file, the
324
320
: An attribute, of fixed-length string datatype and of scalar
325
321
dataspace, that yields the version of the program.
326
322
327
-
328
323
#### Modules **(currently unused in H5MD-NOMAD)**
329
324
330
325
The original H5MD specification allowed the definition of modules under the h5md group.
@@ -361,9 +356,6 @@ attribute, further module-specific information may be stored:
361
356
362
357
[semver]: http://semver.org/spec/v2.0.0.html -->
363
358
364
-
365
-
366
-
367
359
## The particles group
368
360
369
361
Particle attributes, i.e., information about each particle in the system, are stored within the `particles` group.
@@ -416,10 +408,11 @@ absolute position in space of an *arbitrary* periodic image of that particle. --
416
408
: An element that holds the mass for each particle as a scalar of `Float`
417
409
type.
418
410
419
-
-`image`
411
+
*`image`
420
412
: <aid="image_anchor"></a>**(currently unused in H5MD-NOMAD)**
421
413
422
414
# TODO can we make these admonitions indented somehow or more obviously connected with the members of this list?
415
+
423
416
??? details
424
417
425
418
An element that represents periodic images of the box as coordinate vectors
@@ -498,7 +491,6 @@ attribute `type` may be omitted. -->
498
491
499
492
**All non-standard elements within the particles group are currently ignored by the NOMAD H5MD parser.** In principle, one can store additional custom attributes as configuration-specific observables (see [The observables group](#the-observables-group)).
500
493
501
-
502
494
### The simulation box subgroup
503
495
504
496
Information about the simulation box is stored in a subgroup named `box`, within the relevant particles group (`all` in our case).
@@ -564,9 +556,6 @@ where `dimension` is equal to `D`.
564
556
565
557
<!-- TODO - double check that both shapes are supported in the parser! -->
566
558
567
-
568
-
569
-
570
559
## The observables group
571
560
572
561
The initial H5MD proposed a simple and flexible schema for the general storage of observable info, defined roughly as "macroscopic observables" or "averages of a property over many particles", as H5MD elements:
@@ -756,9 +745,6 @@ The following observable types are supported:
756
745
757
746
A list of standardized observables can be found in [Reference - H5MD-NOMAD > Standardized observables in H5MD-NOMAD](h5md_ref.md#standardized-observables-in-h5md-nomad).
758
747
759
-
760
-
761
-
762
748
## The connectivity group
763
749
764
750
The initial H5MD proposed a simple and flexible schema for the storage of "connectivity" information, e.g., to be used in conjunction with a molecular mechanics force field.
@@ -837,13 +823,10 @@ The initial `particles_group` subgroup, directly under `connectivity`, is a cont
837
823
*`custom_dataset`
838
824
: arbitrary additional metadata for this particle group may be given.
839
825
840
-
841
826
Each subgroup may also contain a (nested) `particles_group` subgroup, in order to subdivide the group of particles into an organizational hierarchy. As with the overall `particles_group` container, the groups contained within `particles_group` must not *partition* the particles within this group (i.e., overlapping or non-complete groupings are allowed). However, particle groups *must* contain particles already contained within the parent `particles_group` (i.e., subgroups must be a subset of the grouping at the previous level of the hierarchy).
842
827
843
828
Note that typically the `particles_group` hierarchy ends at the level of individual particles (i.e., individual particles are not stored, since this information is already contained within the `particles` group).
844
829
845
-
846
-
847
830
## The parameters group
848
831
849
832
The initial H5MD proposed a simple and flexible schema for the storage of general "parameter" information within the `parameters` group, with the following structure:
@@ -874,7 +857,6 @@ The subgroups `force_calculations` and `workflow` are supported. The following d
874
857
875
858
2. The unit given in the MetaInfo definition does not have to be used within the H5MD-NOMAD file, however, the dimensionality of the unit should match.
876
859
877
-
878
860
### Force calculations
879
861
880
862
The `force_calculations` group contains the parameters for force calculations according to the force field during a molecular dynamics run.
@@ -943,7 +925,6 @@ In the following, we provide the NOMAD definitions for each of these quantities:
@@ -980,7 +961,6 @@ Section containing the parameters for neighbor searching/lists during a molecula
980
961
The distance cutoff for determining the neighbor list.
981
962
''')
982
963
983
-
984
964
### The molecular dynamics workflow
985
965
986
966
The `workflow` group contains the parameters for any type of workflow. Here we describe the specific case of the well-defined `molecular_dynamics` workflow. Custom workflows are described in detail in [Workflows in NOMAD](../overview.md).
@@ -1045,7 +1025,7 @@ In the following, we provide the NOMAD definitions for each of these quantities:
0 commit comments