openPMD/openPMD-api

Particle Species: loadPositions

Open

#666 opened on Jan 24, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
api: newfeature requestfrontend: C++17frontend: Python3good first issuehelp wanted

Repository metrics

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

Description

The openPMD base standard describes the handling of position and positionOffset compositions for particle species.

https://github.com/openPMD/openPMD-standard/blob/1.1.0/STANDARD.md#records-for-each-particle-species

For reading, we should implement this as a convenient member function, to avoid performing this well-defined behavior via multiple loadChunk() calls and additions on the user side.

Contributor guide

Research direction
Review the openPMD standard section on particle positions, then examine existing particle loading code to implement a loadPositions member function that handles position and positionOffset composition.
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.
1-3 hours
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