Skip to content

Commit 4310bc2

Browse files
Fixed typo in h5md_expl.md, conjugant->conjugate_gradient
1 parent 1d12c2d commit 4310bc2

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

docs/parsers/h5md/h5md_expl.md

Lines changed: 8 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -122,17 +122,17 @@ depending on the dataset layout of `step`.
122122

123123
<element>
124124
\-- step: Integer[]
125-
+-- (offset: type[])
125+
+-- (offset: type[])
126126
\-- (time: type[])
127-
+-- (offset: type[])
127+
+-- (offset: type[])
128128
\-- value: <type>[variable][...]
129129

130130
`step`
131131
: A scalar dataset of `Integer` type that contains the increment of the
132132
time step between two successive rows of data in `value`.
133133

134134
`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
136136
value of `step`.
137137

138138
`time`
@@ -141,7 +141,7 @@ depending on the dataset layout of `step`.
141141
time, in physical units.
142142

143143
`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
145145
sampled value of `time`.
146146

147147
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:
219219

220220
The dimension denoted by `N` may be variable.
221221

222-
223-
224222
## The root level
225223

226224
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
252250
: An optional group that contains application-specific (meta)data such as
253251
control parameters or simulation scripts.
254252

255-
256-
257253
## The H5MD Group
258254

259255
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
324320
: An attribute, of fixed-length string datatype and of scalar
325321
dataspace, that yields the version of the program.
326322

327-
328323
#### Modules **(currently unused in H5MD-NOMAD)**
329324

330325
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:
361356
362357
[semver]: http://semver.org/spec/v2.0.0.html -->
363358

364-
365-
366-
367359
## The particles group
368360

369361
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. --
416408
: An element that holds the mass for each particle as a scalar of `Float`
417409
type.
418410

419-
- `image`
411+
* `image`
420412
: <a id="image_anchor"></a>**(currently unused in H5MD-NOMAD)**
421413

422414
# TODO can we make these admonitions indented somehow or more obviously connected with the members of this list?
415+
423416
??? details
424417

425418
An element that represents periodic images of the box as coordinate vectors
@@ -498,7 +491,6 @@ attribute `type` may be omitted. -->
498491

499492
**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)).
500493

501-
502494
### The simulation box subgroup
503495

504496
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`.
564556

565557
<!-- TODO - double check that both shapes are supported in the parser! -->
566558

567-
568-
569-
570559
## The observables group
571560

572561
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:
756745

757746
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).
758747

759-
760-
761-
762748
## The connectivity group
763749

764750
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
837823
* `custom_dataset`
838824
: arbitrary additional metadata for this particle group may be given.
839825

840-
841826
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).
842827

843828
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).
844829

845-
846-
847830
## The parameters group
848831

849832
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
874857

875858
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.
876859

877-
878860
### Force calculations
879861

880862
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:
943925
[Mol. Phys. **26**, 789 (1973)](https://doi.org/10.1080/00268977300102101)|
944926
''')
945927

946-
947928
* `coulomb_cutoff`
948929
:
949930

@@ -980,7 +961,6 @@ Section containing the parameters for neighbor searching/lists during a molecula
980961
The distance cutoff for determining the neighbor list.
981962
''')
982963

983-
984964
### The molecular dynamics workflow
985965

986966
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:
10451025
:
10461026
Quantity(
10471027
type=MEnum(
1048-
'brownian', 'conjugant_gradient', 'langevin_goga',
1028+
'brownian', 'conjugate_gradient', 'langevin_goga',
10491029
'langevin_schneider', 'leap_frog', 'rRESPA_multitimescale', 'velocity_verlet'
10501030
),
10511031
shape=[],
@@ -1314,8 +1294,6 @@ In the following, we provide the NOMAD definitions for each of these quantities:
13141294
the input/output files.
13151295
''')
13161296

1317-
1318-
13191297
## Units
13201298

13211299
In the original H5MD schema, units were given as string attributes of datasets, e.g., ``60 m s-2``.
@@ -1330,4 +1308,4 @@ Generic representation of unit storage in H5MD-NOMAD:
13301308
<group>
13311309
\-- <dataset>
13321310
+-- (unit: String[])
1333-
+-- (unit_factor: Float)
1311+
+-- (unit_factor: Float)

0 commit comments

Comments
 (0)