openPMD/openPMD-api

More Transform/Compression Examples

Open

#782 opened on Sep 19, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (3 assignees)C++ (57 forks)auto 404
documentationfrontend: C++17help wanted

Repository metrics

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

Description

We need a bit more transform/compression examples in both the manual and example codes.

I also realized that we can set Dataset::setCustomTransform which is only handled in ADIOS1 right now. And the Dataset::setCompression options handled in ADIOS2 are a bit too simple (name + level) for the complex blosc and zfp parameters.

For defaults, the ADIOS2 implementation for compression/operators is still incomplete: https://openpmd-api.readthedocs.io/en/0.12.0-alpha/details/backendconfig.html#configuration-structure-per-backend

See also open to do points in: #569

Contributor guide

Research direction
Investigate the existing transform/compression examples and documentation, understand the current implementation of Dataset::setCustomTransform and Dataset::setCompression in ADIOS1 and ADIOS2, and identify gaps where more examples are needed. Refer to the linked issue #569 for additional context.
Tech stack
cpppython
Domain
data
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.
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.
Clear
Prerequisites
GitC++Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60