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-20921: Clarify that ap_verify needs to be set up before running ap_verify.py #7

Merged
merged 1 commit into from
Sep 19, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,11 @@ Our [Developer Guide](http://developer.lsst.io/en/latest/tools/git_lfs.html) exp
Usage
-----

<!-- TODO: replace with link to Sphinx label `ap-verify-datasets-install` once it's published -->
`ap_verify_testdata` is not included in `lsst_distrib` and is not available through `newinstall.sh`.
However, it can be installed explicitly with the [LSST Software Build Tool](https://developer.lsst.io/stack/lsstsw.html) or by cloning directly:

This dataset must be cloned (with Git LFS) and set up with [EUPS](https://developer.lsst.io/stack/eups-tutorial.html) before it can be processed with `ap_verify`:

git clone https://github.com/lsst-dm/ap_verify_testdata/
git clone https://github.com/lsst/ap_verify_testdata/
setup -r ap_verify_testdata

Unlike other datasets, `ap_verify_testdata` is not recognized by `ap_verify`'s normal command-line scripts.
It can be run through testing by calling `pytest` from the `ap_verify` installation directory.
It can be run through testing by calling `pytest` from the `ap_verify` installation directory, after `ap_verify` has been set up as normal.