openPMD/openPMD-api

openpmd-pipe -v|--version

Open

#1,082 opened on Aug 6, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
feature requestgood first issuetools

Repository metrics

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

Description

The new openpmd-pipe tool needs a -v|--version argument control, so one can check which version will be used as a user.

Example:

$ openpmd-ls --version
openpmd-ls (openPMD-api) 0.14.1
Copyright 2017-2021 openPMD contributors
Authors: Axel Huebl et al.
License: LGPLv3+
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

$ openpmd-pipe --version
usage: openpmd-pipe [-h] [--infile INFILE] [--outfile OUTFILE] [--inconfig INCONFIG]
                    [--outconfig OUTCONFIG]
openpmd-pipe: error: unrecognized arguments: --version

Contributor guide

Research direction
Locate the source file for the openpmd pipe tool and inspect how the existing command line arguments are defined. Then look at how openpmd ls implements its version flag to replicate the same pattern for openpmd pipe. Ensure the output format matches the existing version output.
Tech stack
cpp
Domain
cli
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
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80