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.

Sign up for GitHub

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

Jump to bottom

DM-35564: ap_verify docs say datasets should be installed at run-time #164

Merged
merged 4 commits into from
Jul 13, 2022
Merged

DM-35564: ap_verify docs say datasets should be installed at run-time #164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1e24d03
Fix trailing whitespace in docs.
kfindeisen Jul 13, 2022
89d19a5
Remove off-topic mention of installation from running.rst.
kfindeisen Jul 13, 2022
e510899
Fix mixed-up text and examples in running.rst.
kfindeisen Jul 13, 2022
42268a8
Clarify relationship between dataset setup and installation.
kfindeisen Jul 13, 2022
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
11 changes: 8 additions & 3 deletions doc/lsst.ap.verify/datasets-install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,19 @@ For example, to install the `Cosmos PDR2 <https://github.com/lsst/ap_verify_ci_c

rebuild -u ap_verify_ci_cosmos_pdr2

Alternatively, the dataset can be cloned directly and setup:
Alternatively, the dataset can be cloned directly:

.. prompt:: bash

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

The dataset should be setup each time before use.
Once installed, the dataset must be setup each session before use:

.. prompt:: bash

setup ap_verify_ci_cosmos_pdr2 # Installed with rebuild
setup -r /my/path/ap_verify_ci_cosmos_pdr2 # Installed with git clone

Once this is done, ``ap_verify`` will be able to find the Cosmos data when requested through :option:`--dataset`.

Further reading
Expand Down
16 changes: 9 additions & 7 deletions doc/lsst.ap.verify/running.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,25 @@ Running ap_verify from the command line
This page describes the most common options used to run ``ap_verify``.
For more details, see the :doc:`command-line-reference` or run :option:`ap_verify.py -h`.

This guide assumes that the dataset(s) to be run are already installed on the machine.
If this is not the case, see :doc:`datasets-install`.

.. _ap-verify-run-output-gen3:

How to run ap_verify in a new workspace
=======================================

Using the `Cosmos PDR2`_ CI dataset as an example, one can run :command:`ap_verify.py` as follows.

.. _Cosmos PDR2: https://github.com/lsst/ap_verify_ci_cosmos_pdr2/
Using the `Cosmos PDR2`_ CI dataset as an example, first setup the dataset, if it isn't already.

First download and setup the dataset.
.. _Cosmos PDR2: https://github.com/lsst/ap_verify_ci_cosmos_pdr2/

.. prompt:: bash

git clone https://github.com/lsst/ap_verify_ci_cosmos_pdr2/
setup -r ap_verify_ci_cosmos_pdr2
setup [-r] ap_verify_ci_cosmos_pdr2

You will need to setup the dataset once each session.

You will need to setup the dataset each time you want to use it.
You can then run :command:`ap_verify.py` as follows.

.. prompt:: bash

Expand Down