openPMD/openPMD-api

Log: Pseudo-Backend C/C++ Code

Open

#567 opened on Oct 4, 2019

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

Repository metrics

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

Description

Related to the logging functionality in #461 and #462, we could add a log-class in each backend. It's task would be to write a (per-rank) log-file that just includes the (pseudo) C/C++ code we call of the underlying I/O backend.

This could potentially be very helpful to debug and communicate with upstream projects.

Contributor guide

Research direction
Investigate the logging functionality from issues #461 and #462. Understand how each I/O backend is implemented in the openPMD api. Then design a log class per backend that writes a file containing the pseudocode of the calls made to that backend. Focus on the per rank aspect and ensure the output is helpful for debugging and communication with upstream projects.
Tech stack
cpp
Domain
backend
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.
Mostly clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70