yt-project/yt

Quickstart notebook improvements

Open

#1,134 opened on Oct 20, 2015

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

Repository metrics

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

Description

Originally reported by: Nathan Goldbaum (Bitbucket: ngoldbaum, GitHub: ngoldbaum)

I'm using this issue to track improvements that would be good to make to the quickstart notebooks.

  • Add N-body, SPH, unstructured mesh, and Oct AMR versions of the data inspection notebooks.
  • Add ProfilePlot and PhasePlot examples to the simple viz notebook
  • Halo finding operation in the data objects and time series notebook takes too long to run

Please feel free to add to this if you also have improvements you'd like to see.

Contributor guide

Research direction
Review the existing quickstart notebooks in the repository (e.g., doc/source/quickstart/). Identify sections where examples for N body, SPH, unstructured mesh, Oct AMR, ProfilePlot, PhasePlot, or faster halo finding can be added. Follow the notebook structure and test the notebooks locally before submitting a pull request.
Tech stack
python
Domain
documentationcontent
Issue type
Documentation
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.
1-3 hours
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
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70