openPMD/openPMD-api

Ext: Species Type

Open

#85 opened on Feb 20, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
good first issuehelp wanted

Repository metrics

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

Description

Add support to define a particle species to each record. This includes particle and mesh records: https://github.com/openPMD/openPMD-standard/pull/180

Contributor guide

Research direction
Start by reading the linked PR in the openPMD standard repository to understand how 'particle species' is defined in the standard. Then, explore the openPMD api codebase to locate the classes and methods that handle particle and mesh records. Review existing tests and documentation to learn how records are currently implemented, and identify where changes need to be made to support the new species field.
Tech stack
cpppython
Domain
backenddata
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.
3-5 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.
Mostly clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40