openPMD/openPMD-api

Warn on unsupported openPMDextensions

Open

#283 opened on Jun 22, 2018

View on GitHubContributor guide
 (5 comments) (0 reactions) (1 assignee)C++ (57 forks)auto 404
discussiongood first issuehelp wantedinternalwarning

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Investigate how the Series class reads openPMD extensions and where a warning about unsupported extensions should be emitted. Look for existing logging or warning mechanisms in the codebase, such as standard library or custom logging. Check tests for Series creation to see how to add a test for the warning.
Tech stack
cpp
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75