openPMD/openPMD-api

Update to examples

Open

#1,112 opened on Sep 21, 2021

View on GitHubContributor guide
 (1 comment) (2 reactions) (0 assignees)C++ (57 forks)auto 404
feature requesthelp wanted

Repository metrics

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

Description

Our examples have not been updated in a while and often don't really demonstrate newer additions to our APIs. This issue is supposed to collect some of the things that we should look out for in such an update:

  • Lazy parsing
  • Use linear/streaming API where applicable
  • Use JSON-based backend configurations
  • Prefer Iteration::close() over Series::flush() where applicable

Contributor guide

Research direction
Review the existing examples and understand the new API features: lazy parsing, linear/streaming I/O, JSON based configurations, and the preference for Iteration::close() over Series::flush(). Then update the examples to showcase these features.
Tech stack
cpppython
Domain
apidata
Issue type
Refactor
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65