yt-project/yt

Dataset summary

Open

#2,737 opened on Jul 10, 2020

View on GitHub
 (11 comments) (0 reactions) (0 assignees)Python (315 forks)auto 404
enhancementhelp wantednew contributor friendly

Repository metrics

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

Description

When yt only did AMR data, it had print_stats(). We don't have this kind of functionality that much anymore.

It would be nice if we could have a base class Dataset implementation of something like summary that gives some good info, and then dispatch to the subclasses to supplement. For instance, for an AMR dataset this might be the "level stats" we used to do. For particle, it might be the particle counts, maybe something about the EWAH index filling fraction, etc.

Contributor guide

Research direction
Examine the existing Dataset class and its subclasses to design a `summary` method that provides useful information from the base class, then implement dispatching to subclass specific summaries.
Tech stack
python
Domain
backenddata
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
PythonGityt basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65