Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-20384

Clarify usage of make_ppdb.py script

    Details

    • Type: Improvement
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: ap_pipe
    • Labels:
      None
    • Story Points:
      2
    • Sprint:
      AP F19-3 (Skipped)
    • Team:
      Alert Production

      Description

      A third-party guide to using ap_pipe.py suggests using command-line arguments to make_ppdb.py but passing the database config to ap_pipe.py through a file. This is not recommended usage (if the two scripts are configured the same way it's harder to make a hard-to-debug mistake), but the current Sphinx docs don't actually say that the two scripts accept the same config.

      Clarify that make_ppdb.py is configured exactly the same way as ap_pipe.py, including taking config files written for ApPipeConfig. This might be worth putting on a separate topic page under "Using lsst.ap.pipe" – not a tutorial or walkthrough, but just a page explaining what make_ppdb is and why we need it.

        Attachments

          Issue Links

            Activity

            Hide
            danielsf Scott Daniel added a comment -

            This looks good to me.

            Show
            danielsf Scott Daniel added a comment - This looks good to me.
            Hide
            krzys Krzysztof Findeisen added a comment -

            Good point, here you go.

            Show
            krzys Krzysztof Findeisen added a comment - Good point, here you go.
            Hide
            danielsf Scott Daniel added a comment - - edited

            Sure.  Is there a way I can get the compiled docs off of the branch (rather than just looking at the commits and intuiting what they will like like compiled)?

            Show
            danielsf Scott Daniel added a comment - - edited Sure.  Is there a way I can get the compiled docs off of the branch (rather than just looking at the commits and intuiting what they will like like compiled)?
            Hide
            krzys Krzysztof Findeisen added a comment -

            Hi Scott Daniel, as an external user of ap_pipe, can you take a look at the new documentation on make_ppdb.py and see if it's useful?

            Show
            krzys Krzysztof Findeisen added a comment - Hi Scott Daniel , as an external user of ap_pipe , can you take a look at the new documentation on make_ppdb.py and see if it's useful?

              People

              • Assignee:
                krzys Krzysztof Findeisen
                Reporter:
                krzys Krzysztof Findeisen
                Reviewers:
                Scott Daniel
                Watchers:
                Krzysztof Findeisen, Meredith Rawls, Scott Daniel
              • Votes:
                0 Vote for this issue
                Watchers:
                3 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:

                  Summary Panel