Add some plotting examples and improve examples documentation.

ytree-project / ytree

A yt-based merger-tree code.

Other

15 stars 10 forks source link

Add some plotting examples and improve examples documentation. #142

Closed brittonsmith closed 2 years ago

brittonsmith commented 2 years ago

PR Summary

Following @manodeep's comment in PR #138, this adds a couple plotting examples to the docs.

This has now grown to include a few more things:

directly show all example scripts in the docs (with links to the .py files) and test them (Issue #143)
reorganize the documentation table of context to put help and citation sections at the top and take the api reference and changelog out of a section and list them explicitly.

PR Checklist

[x] Code passes tests.
[x] New features are documented with docstrings and narrative docs.
[x] Tests added for fixed bugs or new features.

manodeep commented 2 years ago

May I request more mergertree identification/plots :)

How does one plot the mergertree(s) for halos that pass certain criteria at different redshifts? For example:

identify/plot the mergertree for a halo > Mthresh (say 10^15) at z=0 that had a major merger with another massive halo at any earlier time (i.e. finding cluster-cluster mergers for today's groups/clusters)
find halos that have host halo mass > Mthresh (say 10^13) at some "high"-z (say z=4) that assemble their stellar mass very early on but then become quiescent for all later times stellar mass (i.e., massive quiescent galaxies) [this selection would only be relevant for semi-analytic/hydro outputs, not cosmo N-body sims]
find halos in a mass-range (say 1-2x10^12 Msun) that have never had a major merger (i.e., finding MW analogs in sims)

brittonsmith commented 2 years ago

May I request more mergertree identification/plots :)

Yes, but perhaps in another PR. Vacation's just about over. Can you create a new issue with these? 1 and 3 are good, related, and people have asked me about this sort of thing. 2 is less well defined and we don't have any sample data to demonstrate with and test.

brittonsmith commented 2 years ago

Ok, the tests are passing and I'm happy with the initial examples. On top of the two plotting examples, I mainly wanted to get the framework in place for showing them in the docs and running them in the test suite. I'll merge this now, but I'm happy to add more examples later.