openPMD / openPMD/openPMD-api

Warn on unsupported openPMDextensions

Open
#283 5 comments 0 reactions 1 assignee Claimed by @anokfireball View on GitHub
discussion good first issue help wanted internal warning
Dominant language
C++
Stars
161
Forks
59
Avg merge
2d 22h
Merged PRs (30d)
7

Description

```Series::openPMDextension() != 0``` may literally break the standard with everyhing we assume in this API w.r.t. metadata, structure and datasets.

Reading/writing any ```Series``` with ```Series::openPMDextension() != 0``` may succeed, depending on the used extensions (e.g. if they only _add_ information to the base standard). It is thus not advisable to stop execution when that condition is encountered.
Likewise, reading/writing may fail (e.g. if the extensiton _modifies_ or _removes_ information in the base standard). This will cause a failure at runtime.

We should thus at least notify the user (e.g. with a warning) that the current implementation does not support one or more of the requested/present extensions.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.