openPMD/openPMD-api

Update to examples

Offen

#1.112 geöffnet am 21.09.2021

Auf GitHub ansehenContributor Guide
 (1 Kommentar) (2 Reaktionen) (0 zugewiesene Personen)C++ (57 Forks)auto 404
feature requesthelp wanted

Repository-Metriken

Stars
 (160 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Our examples have not been updated in a while and often don't really demonstrate newer additions to our APIs. This issue is supposed to collect some of the things that we should look out for in such an update:

  • Lazy parsing
  • Use linear/streaming API where applicable
  • Use JSON-based backend configurations
  • Prefer Iteration::close() over Series::flush() where applicable

Contributor Guide

Research-Richtung
Überprüfen Sie die vorhandenen Beispiele und verstehen Sie die neuen API Funktionen: Lazy Parsing, lineare/Streaming E/A, JSON basierte Konfigurationen und die Bevorzugung von Iteration::close() gegenüber Series::flush(). Aktualisieren Sie anschließend die Beispiele, um diese Funktionen zu zeigen.
Tech Stack
cpppython
Domain
apidata
Issue Type
Refactoring
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitC++Python
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65