Skip to content

Commit cee7330

Browse files
committed
Snapshot naming, Remove Specs Mapping
1 parent c81864a commit cee7330

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

FORMAT_ADIOS.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,7 @@ Thus, implementations should cast the data to and from `unsigned char` instead.
3535

3636
## `stepBased` Encoding of Iterations
3737

38-
In order to correlate openPMD iterations with ADIOS steps, the *root* group (path `/`) in ADIOS must contain a variable:
39-
40-
- `__step__`
41-
- type: 1-dimensional array containing N *(int)* elements, where N is the number of ADIOS steps
42-
- description: for each ADIOS step, this variable needs to be updated with the corresponding openPMD iteration.
43-
- note: ADIOS steps are absolute and not every ADIOS step or openPMD iteration contains an update for each declared openPMD record.
44-
- advice to implementers: [decide on this] an openPMD iteration for different openPMD records might be spread over multiple ADIOS steps.
45-
An iteration of an openPMD record must correspond to exactly one ADIOS step.
38+
The `iterationEncoding` mode `stepBased` must be implemented via ADIOS steps.
4639

4740
## Datasets
4841

STANDARD.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Each file's *root* group (path `/`) must further define the attributes:
216216
- allowed values:
217217
- `fileBased` (multiple files)
218218
- `groupBased` (one file)
219-
- `stepBased` (one file with internally encoding, if supported by the data format)
219+
- `stepBased` (one file with internal encoding for iterations, if supported by the data format)
220220

221221
- `iterationFormat`
222222
- type: *(string)*
@@ -227,13 +227,26 @@ Each file's *root* group (path `/`) must further define the attributes:
227227
for `fileBased` formats the iteration must be included
228228
in the file name;
229229
the format depends on the selected `iterationEncoding` method
230+
- note: it is not required that every openPMD iteration contains an update for each declared openPMD record (see below)
230231
- examples:
231232
- for `fileBased`:
232233
- `filename_%T.h5` (without file system directories)
233234
- for `groupBased`: (fixed value)
234235
- `/data/%T/` (must be equal to and encoded in the `basePath`)
235236
- for `stepBased`: (fixed value)
236-
- `slowest varying index`
237+
- data-format internal convention
238+
- *slowest varying index* of data
239+
240+
### `stepBased` Encoding of Iterations
241+
242+
In order to correlate openPMD iterations with an index of data-format internal updates/steps or an index in the slowest varying dimension of an array, the *root* group (path `/`) must contain an additional variable once `stepBased` is chosen for `iterationEncoding`:
243+
244+
- `snapshot`
245+
- type: 1-dimensional array containing N *(int)* elements, where N is the number of updates/steps in the data format
246+
- description: for each update/step in a data format, this variable needs to be updated with the corresponding openPMD iteration.
247+
- note: in some data formats, updates/steps are absolute and not every update/step contains an update for each declared openPMD record
248+
- advice to implementers: an openPMD iteration might be spread over multiple updates/steps, but not vice versa.
249+
In such a scenario, an individual openPMD record's update/step must appear exactly once per iteration.
237250

238251

239252
Required Attributes for the `basePath`

0 commit comments

Comments
 (0)