Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-27630: Use CI dataset in ap_verify examples #120

Merged
merged 4 commits into from Feb 16, 2021
Merged

Conversation

kfindeisen
Copy link
Member

This PR updates the ap_verify documentation to use the CI-CosmosPDR2 dataset (which wasn't even listed as a known dataset), as a more user-friendly alternative to HiTS2015.

Copy link
Contributor

@mrawls mrawls left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good improvement to docs, especially since this example dataset works in both Gen2 and Gen3. Thanks!

doc/lsst.ap.verify/running.rst Outdated Show resolved Hide resolved
doc/lsst.ap.verify/running.rst Outdated Show resolved Hide resolved
The Cosmos dataset is better for new users because it is CI-sized, making
for an easy download, and can be run in both Gen 2 and Gen 3.
The instructions for running ap_verify in Gen 3 assumed knowledge of
running it in Gen 2. As more users start to use Gen 3 directly, this is
no longer a good presentation. Reword the instructions so that they
remain valid if the Gen 2 documentation is removed.
@kfindeisen kfindeisen merged commit 2057c73 into master Feb 16, 2021
@kfindeisen kfindeisen deleted the tickets/DM-27630 branch February 16, 2021 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants