Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

meshesPath & particlesPath: optional #171

Merged
merged 2 commits into from
Jan 25, 2018
Merged

meshesPath & particlesPath: optional #171

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ff20e9
meshesPath & particlesPath: Optional
ax3l Jan 23, 2018
9839c8f
Fix typo: directory -> group
ax3l Jan 25, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions STANDARD.md
View file
Open in desktop
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