Skip to content

Commit

Permalink
Merge pull request #171 from ax3l/topic-onlyMeshOrPart
Browse files Browse the repository at this point in the history
meshesPath & particlesPath: optional
  • Loading branch information
ax3l authored Jan 25, 2018
2 parents 91371c4 + 9839c8f commit ff8686a
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions STANDARD.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,16 +113,26 @@ Each file's *root* group (path `/`) must at least contain the attributes:
of the form given by `basePath` (e.g. `/extra_data`). In this
way, the openPMD parsing tools will not parse this additional data.

The following attributes are *optional* in each each file's *root* group
(path `/`) and indicate if a file contains mesh and/or particle records. It is
*required* to set them if one wants to store mesh and/or particle records.

- `meshesPath`
- type: *(string)*
- description: path *relative* from the `basePath` to the mesh records
- example: `meshes/`
- note: if this attribute is missing, the file is interpreted as if it
contains *no mesh records*! If the attribute is set, the group behind
it *must* exist!

- `particlesPath`
- type: *(string)*
- description: path *relative* from the `basePath` to the groups for each
particle species and the records they include
- example: `particles/`
- note: if this attribute is missing, the file is interpreted as if it
contains *no particle records*! If the attribute is set, the group behind
it *must* exist!

It is *recommended* that each file's *root* group (path `/`) further
contains the attributes:
Expand Down

0 comments on commit ff8686a

Please sign in to comment.