openPMD/openPMD-api

XML Backend

Open

#453 opened on Jan 27, 2019

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
backend: XMLgood first issue

Repository metrics

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

Description

We could add an XML backend, which allows for easy verification with schema's from web development.

Somewhat similar to our JSON backend (which is more compact), XML has a more natural and verbose handling of "attributes" and "data".

This is a good way to get started when learning openPMD-api.

Potentially Interesting Dependency for Backend

Or, converting rapidxml & yaml-cpp objects to our (existing) nlohmann:json objects:

Contributor guide

Research direction
Start by exploring the existing JSON backend in the openPMD api codebase to understand how backends are structured and integrated. Review the openPMD api documentation on backend development. Then evaluate candidate XML libraries (pugixml, tinyxml2, rapidxml) for compatibility and ease of use. Also consider how to map XML attributes and data to the existing internal data model.
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.
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.
70