openPMD/openPMD-api

Update to examples

Ouverte

#1 112 ouverte le 21 sept. 2021

Voir sur GitHubGuide contributeur
 (1 commentaire) (2 réactions) (0 personne assignée)C++ (57 forks)auto 404
feature requesthelp wanted

Métriques du dépôt

Stars
 (160 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Examinez les exemples existants et comprenez les nouvelles fonctionnalités de l'API : analyse paresseuse, E/S linéaire/streaming, configurations basées sur JSON et la préférence pour Iteration::close() par rapport à Series::flush(). Mettez ensuite à jour les exemples pour mettre en évidence ces fonctionnalités.
Stack technique
cpppython
Domaine
apidata
Type d'issue
Refactorisation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitC++Python
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65