openPMD/openPMD-api

Pandas: Show all Iteration/Shot/Snapshot attributes as DataFrame

Open

#1,252 opened on Apr 21, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
frontend: Python3good first issue

Repository metrics

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

Description

Add a read function that returns the meta-data per shot as a dataframe.

x-ref: https://github.com/openPMD/openPMD-CCD/issues/1

Contributor guide

Research direction
Explore the openPMD api Python package to understand how iteration/shot data is accessed. Look for existing helper functions that return data or metadata. Check the referenced issue for details on required attributes. Implement a new function that collects per shot attributes into a pandas DataFrame, ensuring it handles empty or missing attributes. Add tests to verify the output.
Tech stack
python
Domain
dataapi
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.
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.
Needs investigation
Prerequisites
GitPythonPandas
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65