openPMD/openPMD-api

Relaxed mode: warn and ignore invalid?

Open

#620 opened on Dec 2, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
feature requestgood first issuehelp wantedinternal

Repository metrics

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

Description

Regarding:

It might be easier to use the API if we try to skip and verbosely warn when invalid formatting of records are detected, instead of erroring out on the whole series.

Nevertheless, recovery from such situations needs extra logic and plumbing.

Contributor guide

Research direction
Investigate how invalid record formatting is currently handled in the API. Identify the validation logic and consider adding a relaxed mode that logs warnings and skips invalid records instead of raising errors.
Tech stack
cpppython
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
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.
40